CIBC:Seg3D2:Doxygen

Using Doxygen with Seg3D2

Brief Comment Before

Add an extra "/"

   /// This method does something
   void DoSomething();

Brief Comment After

Add an extra "*"

   /** This is a method that does so
     * much that I must write an epic 
     * novel just to describe how much
     * it truly does. */
   void DoNothing();

- the intermediate leading "*"s are optional.

Brief Comment After

Add an extra "/<"

   void DoSomething(); ///< This method does something

Detailed Comment After

Add an extra "*<"

   void DoNothing(); /**< This is a method that does so
     * much that I must write an epic 
     * novel just to describe how much
     * it truly does. */

- the intermediate leading "*"s are optional.