1 Doxygen is a documentation system for C++, Java, IDL (Corba, Microsoft and
2 KDE-DCOP flavors) and C.
4 It can help you in three ways:
6 1. It can generate an on-line documentation browser (in HTML) and/or an
7 off-line reference manual (in LaTeX) from a set of documented source
8 files. There is also support for generating output in RTF (MS-Word),
9 PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. The
10 documentation is extracted directly from the sources, which makes it
11 much easier to keep the documentation consistent with the source code.
13 2. Doxygen can be configured to extract the code structure from
14 undocumented source files. This can be very useful to quickly find your
15 way in large source distributions. The relations between the various
16 elements are be visualized by means of include dependency graphs,
17 inheritance diagrams, and collaboration diagrams, which are all
18 generated automatically.
20 3. You can even `abuse' doxygen for creating normal documentation