Doxygen Manual

Doxygen Manual This manual is divided into three parts, each of which is divided into several sections.

The first part forms a user manual:

• • Section Installation discusses how to download, compile and install doxygen for your platform.
  • Section Getting started tells you how to generate your first piece of documentation quickly.
  • Section Documenting the code demonstrates the various ways that code can be documented.
  • Section Lists show various ways to create lists.
  • Section Grouping shows how to group things together.
  • Section Including formulas shows how to insert formulas in the documentation.
  • Section Graphs and diagrams describes the diagrams and graphs that doxygen can generate.
  • Section Preprocessing explains how doxygen deals with macro definitions.
  • Section Automatic link generation shows how to put links to files, classes, and members in the documentation.
  • Section Output Formats shows how to generate the various output formats supported by doxygen.
  • Section Linking to external documentation explains how to let doxygen create links to externally generated documentation.
  • Section Frequently Asked Questions gives answers to frequently asked questions.
  • Section Troubleshooting tells you what to do when you have problems.

The second part forms a reference manual:

• • Section Features presents an overview of what doxygen can do.
  • Section Doxygen History shows what has changed during the development of doxygen and what still has to be done.
  • Section Doxygen usage shows how to use the doxygen program.
  • Section Doxytag usage shows how to use the doxytag program.
  • Section Doxywizard usage shows how to use the doxywizard program.
  • Section Installdox usage shows how to use the installdox script that is generated by doxygen if you use tag files.
  • Section Configuration shows how to fine-tune doxygen, so it generates the documentation you want.
  • Section Special Commands shows an overview of the special commands that can be used within the documentation.
  • Section HTML Commands shows an overview of the HTML commands that can be used within the documentation.
  • Section XML Commands shows an overview of the XML commands that can be used within the documentation.

The third part provides information for developers:

• • Section Doxygen's Internals gives a global overview of how doxygen is internally structured.
  • Section Perl Module output format documentation shows how to use the PerlMod output.
  • Section Internationalization explains how to add support for new output languages.

Copying from " http://www.stack.nl/~dimitri/doxygen/manual.html "