diff options
| author | snuffy <snuffy@f38db490-d61c-443f-a65b-d21fe96a405b> | 2009-08-01 23:25:16 +0000 |
|---|---|---|
| committer | snuffy <snuffy@f38db490-d61c-443f-a65b-d21fe96a405b> | 2009-08-01 23:25:16 +0000 |
| commit | f72d38b4331345290c60f04eb95aa17dd8fbe2e6 (patch) | |
| tree | 45b4149357c96e13dabce969ae44b9db51e5d56b /doc | |
| parent | f9d6e3803579d354aff6128e6c0e7851084c840f (diff) | |
(closes issue #15515)
git-svn-id: http://svn.digium.com/svn/asterisk/trunk@209958 f38db490-d61c-443f-a65b-d21fe96a405b
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/CODING-GUIDELINES | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/CODING-GUIDELINES b/doc/CODING-GUIDELINES index c4cb675e7..c81ca5c6b 100644 --- a/doc/CODING-GUIDELINES +++ b/doc/CODING-GUIDELINES @@ -590,6 +590,11 @@ When documenting a 'static' function or an internal structure in a module, use the \internal modifier to ensure that the resulting documentation explicitly says 'for internal use only'. +When adding new API you should also attach a \since note because this will +indicate to developers that this API did not exist before this version. It +also has the benefit of making the resulting HTML documentation to group +the changes for a single version. + Structures should be documented as follows. /*! |