3 Doxygen is the de facto standard tool for generating documentation from
4 annotated C++ sources, but it also supports other popular programming
5 languages such as C, Objective-C, C#, PHP, Java, Python, IDL
6 (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl,
9 Doxygen can help you in three ways:
11 1. It can generate an on-line documentation browser (in HTML) and/or an
12 off-line reference manual (in LaTeX) from a set of documented source files.
13 There is also support for generating output in RTF (MS-Word), PostScript,
14 hyperlinked PDF, compressed HTML, DocBook and Unix man pages.
15 The documentation is extracted directly from the sources, which makes
16 it much easier to keep the documentation consistent with the source code.
17 2. You can configure doxygen to extract the code structure from undocumented
18 source files. This is very useful to quickly find your way in large
19 source distributions. Doxygen can also visualize the relations between
20 the various elements by means of include dependency graphs, inheritance
21 diagrams, and collaboration diagrams, which are all generated automatically.
22 3. You can also use doxygen for creating normal documentation (as I did for
23 the doxygen user manual and doxygen web-site).
27 The latest binaries and source of Doxygen can be downloaded from:
28 * http://www.doxygen.org/
32 * Linux & macOS Build Status: <a href="https://travis-ci.org/doxygen/doxygen"><img src="https://secure.travis-ci.org/doxygen/doxygen.png?branch=master"/></a>
33 * Windows Build Status: <a href="https://ci.appveyor.com/project/doxygen/doxygen"><img src="https://ci.appveyor.com/api/projects/status/github/doxygen/doxygen"/></a>
35 * Coverity Scan Build Status: <a href="https://scan.coverity.com/projects/2860"> <img alt="Coverity Scan Build Status" src="https://scan.coverity.com/projects/2860/badge.svg"/> </a>
37 * Doxygen's Doxygen Documentation: <a href="https://codedocs.xyz/doxygen/doxygen/"><img src="https://codedocs.xyz/doxygen/doxygen.svg"/></a>
39 * Install: Please read the installation section of the manual (http://www.doxygen.org/manual/install.html)
41 * Project stats: https://www.openhub.net/p/doxygen
43 Issues, bugs, requests, ideas
44 ----------------------------------
45 Use the [issue](https://github.com/doxygen/doxygen/issues) tracker to report bugs.
48 ----------------------------------
51 There are three mailing lists:
53 * doxygen-announce@lists.sourceforge.net - Announcement of new releases only
54 * doxygen-users@lists.sourceforge.net - for doxygen users
55 * doxygen-develop@lists.sourceforge.net - for doxygen developers
56 * To subscribe follow the link to
57 * http://sourceforge.net/projects/doxygen
60 ----------------------------------
61 In May 2013, Doxygen moved from
62 subversion to git hosted at GitHub
63 * https://github.com/doxygen/doxygen
67 Dimitri van Heesch (doxygen at gmail.com)