(closes issue #15515)
authorBradley Latus <brad.latus@gmail.com>
Sat, 1 Aug 2009 23:25:16 +0000 (23:25 +0000)
committerBradley Latus <brad.latus@gmail.com>
Sat, 1 Aug 2009 23:25:16 +0000 (23:25 +0000)
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@209958 65c4cc65-6c06-0410-ace0-fbb531ad65f3

doc/CODING-GUIDELINES

index c4cb675..c81ca5c 100644 (file)
@@ -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.
 
 /*!