Creating SuperMix Documentation with Doxygen

• Use javadoc style comments. For example,
  

    /**
     * An example javadoc comment block.
     */
  

• The comments should be immediately above the thing they go with.

• The first sentence in the comment block should be a brief summary description of whatever the comment goes with.

• Some useful tags include:
  • @file
  • @class
  • @author
  • @date
  • @param
  • @return
  • @see
  • @bug
  • @todo

• To prevent a word from getting hyperlinked, put a % in front of it. The most common problem-words are circuit, port, and device. For example:

   /**
    * If a %circuit contains a 3 %port %device ......
    */
  

• Some useful text formatting:
  • @li for items in a list
  • Put <pre> </pre> around pre-formatted text, such as ASCII-art
  • Put <code> </code> around source code

• You can include latex formulas as follows:

  \f$ put latex math commands here \f$
  

• To prevent doxygen from using a comment, just use standard c or c++ style comments.