|
From: Christian B. <cb...@us...> - 2005-06-27 19:37:39
|
Update of /cvsroot/gtk-gnutella/gtk-gnutella-current/doc/devguide In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv27018 Modified Files: STYLE Log Message: Minor corrections. Index: STYLE =================================================================== RCS file: /cvsroot/gtk-gnutella/gtk-gnutella-current/doc/devguide/STYLE,v retrieving revision 1.19 retrieving revision 1.20 diff -C2 -d -r1.19 -r1.20 *** STYLE 25 Jun 2005 03:39:07 -0000 1.19 --- STYLE 27 Jun 2005 19:37:24 -0000 1.20 *************** *** 83,87 **** */ ! The tag $Id is expanded by CVS when the file is committed. The bracketed sections "[...]" have to be replaced by the respective --- 83,87 ---- */ ! The tag $Id$ is expanded by CVS when the file is committed. The bracketed sections "[...]" have to be replaced by the respective *************** *** 96,103 **** "@ingroup" is used for grouping at the generated documents, it will be ! added to the group or groups identified by given groupname (core, lib, ! etc.). See also doc/api/gtkg-apidoc.main, a groupname is defined here. ! The following is a example from actuall source code: /** --- 96,104 ---- "@ingroup" is used for grouping at the generated documents, it will be ! added to the group or groups identified by the given group name (core, ! lib, etc.). See also doc/api/gtkg-apidoc.main, a group name is defined ! here. ! The following is a example from the actual source code: /** *************** *** 118,123 **** */ ! Note that don't forget to punctuate at a headline and a detailed ! description. 2.2 All functions must be consistently commented as: --- 119,123 ---- */ ! Don't forget to punctuate the headline and add a detailed description. 2.2 All functions must be consistently commented as: *************** *** 140,145 **** @returns are used to further enhance the documentation. These tags are documented in the manual of the Doxygen software package ! (see http://www.doxygen.org). The format is largely compatible to Javadoc. ! Do not try to use HTML. Since the function name does not appear in the leading comment, it --- 140,145 ---- @returns are used to further enhance the documentation. These tags are documented in the manual of the Doxygen software package ! (see http://www.doxygen.org). The format is largely compatible to ! Javadoc. HTML tags should not be used. Since the function name does not appear in the leading comment, it |