Doxygen documentation
ZHANGRUI@landwind.com.cn
Doxygen can generate documents for C , C, Java, IDL (CORBA and Microsoft Flavors) PHP and C #
There are three rough use:
You can generate an online HTML document or an offline Latex format document also supports RTF (MS-Word) PostScript, HyperLinked PDF, Compressed HTML, and Unix Man Pages in a variety of formats. Documents are generated directly from source code, which makes it easier to keep documentation and code consistency.
You can configure DoxYgen to extract the code structure from the documentable source code. This is convenient to quickly on the large source code. You can also use graphical relationships between these different elements, including dependent diagrams, inheritance, and collaborative graphs, which are automatically generated.
You can even use it to generate usual documents, such as manuals
Doxygen is developed under Linux, but it is highly portable and can run under various platforms.
This manual includes the following three parts, each part is divided into the following chapters
The first part is the user manual
Installation tells how to download, compile and install Doxygen
How to quickly get started
Documenting The code tells the various ways to generate documents using code
Lists tells how to generate a list
Grouping tells how to organize these elements
INCLUDING FORMULAS tells how to insert formula in the document
Graphs and diagrams tells the various charts that doxygen can generate.
Preprocessing explains how DoxyGen handles macro definition
Linking to External Documentation explains how to generate links with external documents
Frequency asked Questions FAQ
How to solve common problems in Troubleshooting
The second part is the reference manual
Features doxygen feature
Doxygen History Doxygen Development History and Development Task
Doxygen Usage how to use Doxygen
DoxyTag usage how to use DoxyTag programs
DoxyWizard Usage How to Use DoxyWizard Programs
InstallDox usage How to use the InstallDox script generated by Doxygen when using the Tag file
Output FormatS how to generate various output file formats supported by DOXYGEN
How to add a link to files, classes, and members in the document
How does Configuration adjust Doxygen to generate a document you want?
Special Commands can be used in documentation
HTML commands you can use in the HTML Commands document
The third part of the document is prepared for developers:
Doxygen's INTERNALS describes how Doxygen is designed
Perl Module Output Format Documentation describes how to use PerlMod output
INTERNATIONALIZATION EXPLAINS explains how to add support for new output languages
Chapter 1: Departure
The program Doxygen is the analysis source code and generated documentation. You can refer to DoxyTag usage for detailed usage. Just when there is no source code, it is necessary to generate a reference to the external document (such as the document generated by Doxygen), using DoxyTag.
The following figure shows how tool between tools and tools between tools.
