HELP - HowToDocument
HelpExample CodeHowToDocument
Description Public Protected Private Related All Inheritance Collaboration
HowToDocument ( Class )
Version: 1.0  -  Author: N.F.S Grundtvig (The members of this class inherits the author by default.)
HowTo document your code.
 
Description
HowTo document your code.
This class serves as an example on how to write
documentation using DoxyS. For those familiar with DoxyS "ancestor" Doxygen by
Dimitri Van Heesch most of this will not be new.

The basic idea with this HowToDocument class is that different functions (and a couple)
of member variables demonstrate the most common ways of documenting code using DoxyS. The functions are given meaning full names like: Parameters. Most of the functions are found on the "Public"-tab for this class.

For the impatient
These are the functions/pages that cover the most basic ways of documenting:
Source is located here (click on the "Source"-tab)

Code documentation block
Code documentation blocks are designated by using special style comment blocks
like shown here:

  1. Normal multiline
    /** 
    Brief description.
    Main documentation / description. 
    */
    
  2. Original Doxygen multiline
    /*! 
    Brief description.
    Main documentation / description. 
    */
    
  3. C++ single line style
    /// Brief description.
    /// Main documentation / description. 
    

IMPORTANT - REMEMBER
Functions can just as easily be documented in the cpp-file, which is generally
recommended. This keeps the header file compact (which many people prefers) and allows
you to modify the documentation without having to recompile more than just a single cpp
file.

Possible to continue general description after \note, \todo etc. In fact you can interchange them as you like. Just remember (like done here) to make a blank line after the last \todo etc. section (in this case the last is \author).
Notes
  • This a note
  • See also
  • BriefAndDescription, ReturnValue.
  • Todo
  • We do have stuff to do! Sections like \todo, \note, \sa, \version \author etc. can expand more lines. The section ends at a blank line or if a new \todo, \note etc. section is encountered.
  • We do have more stuff to do!
  •  
    Source
    The documentation for this Class was generated from the following file:
  • HowtoDocument.h