[Crossfire-wiki] [Crossfire DokuWiki] page changed: coding_style_guide

[no-reply_wiki at metalforge.org]

A page in your DokuWiki was added or changed. Here are the details:

Date        : 2007/09/08 22:39
User        : kbulgrien
Edit Summary: Clarify need for path on @file doxygen comment.

@@ -38,12 +38,14 @@
   * Contact information
   */
  
  /**
-  * @file file.ext
+  * @file path/to/file.ext
   * A brief description.  Detailed information may follow.
   */</code>
      * The //rcsid_// variable is useful for creating error and debug messages.  For //component//, look at other files nearby. 
+     * The @file path is important when multiple files in the project may have the same name in different directories.
+     * Do not include //trunk// or //branches/1.x// in the @file comment header path. 
      * The @file comment block helps doxygen create meaningful output.
      * The license block requirement is obvious.
    - Functions are documented like this.<code>/**
   * A brief descriptive sentence summarizes the function.  An overview ends


IP-Address  : 66.137.82.229
Old Revision: http://wiki.metalforge.net/doku.php/coding_style_guide?rev=1188879809
New Revision: http://wiki.metalforge.net/doku.php/coding_style_guide

-- 
This mail was generated by DokuWiki at
http://wiki.metalforge.net/