doxygen

Intro

Doxygen

Doxygen is a document generator for C++ programs, similar to Javadoc. Doxygen gernerates the documentation by parsing the clients C++ files. So documentation is done in the source files.

Doxygen forms paragraphs inside comments based on a blank line.

To get a subheading use the \para tag.

\par Points
<ul>
<li>crap constructor</li>
<li>do nothing class</li>
<li>Call Me playing in the backgound</li>
</ul>

Looks like you can also embed html.

Syntax

Class documentation with example

/*!
\brief Minimize fn on x0+di*t

\par Example
\verbatim
  double d1[] = {0.0,1.0,1.0};
  double x0[] = {0.0,0.0,0.0};
  parab2 fn;
  lineoptimizergold<parab2&,double*,double*,double>
    opt(3,fn,fn.xi,x0,d1,0.0,5.0);

  for (uint i=0; i<10; ++i)
  {
    ++opt;
    opt.print2();
  }
\endverbatim
*/

Comments can be both
/*! function comment */
and
/** function comment */

Documenting a functions signature.

/**
  Takes three inputs ...

  \param a A float
  \param b An int
  \param c A char parameter
  \return Returns an integer
*/
int Method1(float a, float b, char c)

See also tag - makes a hyperlink to a function or class. Heres an exampe from the Qwt library.

/*
  \brief Set the wheel's orientation.
  \param o Orientation. Allowed values are
           Qt::Horizontal and Qt::Vertical.
   Defaults to Qt::Horizontal.
  \sa QwtAbstractSlider::orientation()
*/
void QwtWheel::setOrientation(Qt::Orientation o)

Configuration Tags

Found the tag to put the detailed description at the top. BRIEF_MEMBER_DESC = NO not the default YES.

Creating a Configuration File

doxygen Doxyfile

Then edit Doxyfile's configuration tags.

Mac

I orinally worked on Fedora generating doxygen from the command line. On the mac I use the Doxygen GUI frontend (Doxygen version 1.5.8).

Run /Applications/Doxygen > Expert tab > File > Open > select ${projdirectory}/Doxyfile > Run tab > select show configuration to check the settings then select "Run doxygen"

References

• Writing Documentation
• Doxygen Quick Guide