kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-05 20:20:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

(closes issue #15515)

Browse Source 
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@209958 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
Bradley Latus
2009-08-01 23:25:16 +00:00
parent 027d978aa8
commit 0a47411334
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/CODING-GUIDELINES
View 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 use the \internal modifier to ensure that the resulting documentation
explicitly says 'for internal use only'. 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. Structures should be documented as follows.
/*! /*!