From 0a47411334bb83163ee9ef7f663947e33442f232 Mon Sep 17 00:00:00 2001 From: Bradley Latus <brad.latus@gmail.com> Date: Sat, 1 Aug 2009 23:25:16 +0000 Subject: [PATCH] (closes issue #15515) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@209958 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- doc/CODING-GUIDELINES | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/CODING-GUIDELINES b/doc/CODING-GUIDELINES index c4cb675e74..c81ca5c6b4 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. /*! -- GitLab