Section Including tables shows how to insert tables in the documentation. Section Grouping shows how to group things together. Section Markdown support show the Markdown formatting supported by doxygen. 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.

Furthermore, executables for Windows are available. As a result, it runs on most other Unix flavors as well. You can also use doxygen for creating normal documentation (as I did for the doxygen user manual and web-site).ĭoxygen is developed under Mac OS X and Linux, but is set-up to be highly portable. Doxygen 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 the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL and to some extent D.

Doxygen license tag