diff options
| author | Bradley Latus <brad.latus@gmail.com> | 2009-08-01 23:25:16 +0000 |
|---|---|---|
| committer | Bradley Latus <brad.latus@gmail.com> | 2009-08-01 23:25:16 +0000 |
| commit | 0a47411334bb83163ee9ef7f663947e33442f232 (patch) | |
| tree | 45b4149357c96e13dabce969ae44b9db51e5d56b /doc/CODING-GUIDELINES | |
| parent | 027d978aa8b07cf983ca44dc4fdbe11d3fbe34d3 (diff) | |
(closes issue #15515)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@209958 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'doc/CODING-GUIDELINES')
| -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. /*! |