[asterisk-commits] snuffy: trunk r209958 - /trunk/doc/CODING-GUIDELINES
SVN commits to the Asterisk project
asterisk-commits at lists.digium.com
Sat Aug 1 18:25:20 CDT 2009
Author: snuffy
Date: Sat Aug 1 18:25:16 2009
New Revision: 209958
URL: http://svn.asterisk.org/svn-view/asterisk?view=rev&rev=209958
Log:
(closes issue #15515)
Modified:
trunk/doc/CODING-GUIDELINES
Modified: trunk/doc/CODING-GUIDELINES
URL: http://svn.asterisk.org/svn-view/asterisk/trunk/doc/CODING-GUIDELINES?view=diff&rev=209958&r1=209957&r2=209958
==============================================================================
--- trunk/doc/CODING-GUIDELINES (original)
+++ trunk/doc/CODING-GUIDELINES Sat Aug 1 18:25:16 2009
@@ -590,6 +590,11 @@
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.
/*!
More information about the asterisk-commits
mailing list