Doxygen documentation how to#
Doxygen documentation mac os x#

Section Output Formats shows how to generate the various output formats supported by doxygen. Section Installdox usage shows how to use the installdox script that is generated by doxygen if you use tag files. Section Doxywizard usage shows how to use the doxywizard program. Section Doxytag usage shows how to use the doxytag program. Section Doxygen usage shows how to use the doxygen program. Section Doxygen History shows what has changed during the development of doxygen and what still has to be done. Section Features presents an overview of what doxygen can do. The second part forms a reference manual: Section Troubleshooting tells you what to do when you have problems. Section Frequently Asked Questions gives answers to frequently asked questions. Section Linking to external documentation explains how to let doxygen create links to externally generated documentation. Section Preprocessing explains how doxygen deals with macro definitions. Section Graphs and diagrams describes the diagrams and graphs that doxygen can generate. Section Including formulas shows how to insert formulas in the documentation. Section Grouping shows how to group things together. Section Lists show various ways to create lists. Section Documenting the code demonstrates the various ways that code can be documented. Section Getting started tells you how to generate your first piece of documentation quickly. Section Installation discusses how to download, compile and install doxygen for your platform. This manual is divided into three parts, each of which is divided into several sections.

Doxygen documentation mac os x#

Furthermore, executables for Windows 9x/NT and Mac OS X are available. As a result, it runs on most other Unix flavors as well. You can even `abuse' doxygen for creating normal documentation (as I did for this manual).ĭoxygen is developed under Linux, but is set-up to be highly portable. You can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically. This is very useful to quickly find your way in large source distributions. You can configure doxygen to extract the code structure from undocumented source files. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in ) from a set of documented source files. Doxygen is a documentation system for C++, C, Java, IDL (Corba and Microsoft flavors) and to some extent PHP and C#.