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. Furthermore, executables for Windows 9x/NT and Mac OS X are available. 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īetween the various elements by means of include dependency graphs, inheritance diagrams, andĬollaboration diagrams, which are all generated automatically.ģ. 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Ģ. (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. There is also support for generating output in RTF (in LATEX) from a set of documented source files. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual
0 Comments
Leave a Reply. |