|
Packit |
1c1d7e |
Doxygen
|
|
Packit |
1c1d7e |
===============
|
|
Packit |
1c1d7e |
Doxygen is the de facto standard tool for generating documentation from
|
|
Packit |
1c1d7e |
annotated C++ sources, but it also supports other popular programming
|
|
Packit |
1c1d7e |
languages such as C, Objective-C, C#, PHP, Java, Python, IDL
|
|
Packit |
1c1d7e |
(Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl,
|
|
Packit |
1c1d7e |
and to some extent D.
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Doxygen can help you in three ways:
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
1. It can generate an on-line documentation browser (in HTML) and/or an
|
|
Packit |
1c1d7e |
off-line reference manual (in LaTeX) from a set of documented source files.
|
|
Packit |
1c1d7e |
There is also support for generating output in RTF (MS-Word), PostScript,
|
|
Packit |
1c1d7e |
hyperlinked PDF, compressed HTML, DocBook and Unix man pages.
|
|
Packit |
1c1d7e |
The documentation is extracted directly from the sources, which makes
|
|
Packit |
1c1d7e |
it much easier to keep the documentation consistent with the source code.
|
|
Packit |
1c1d7e |
2. You can configure doxygen to extract the code structure from undocumented
|
|
Packit |
1c1d7e |
source files. This is very useful to quickly find your way in large
|
|
Packit |
1c1d7e |
source distributions. Doxygen can also visualize the relations between
|
|
Packit |
1c1d7e |
the various elements by means of include dependency graphs, inheritance
|
|
Packit |
1c1d7e |
diagrams, and collaboration diagrams, which are all generated automatically.
|
|
Packit |
1c1d7e |
3. You can also use doxygen for creating normal documentation (as I did for
|
|
Packit |
1c1d7e |
the doxygen user manual and doxygen web-site).
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Download
|
|
Packit |
1c1d7e |
---------
|
|
Packit |
1c1d7e |
The latest binaries and source of Doxygen can be downloaded from:
|
|
Packit |
1c1d7e |
* http://www.doxygen.org/
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Developers
|
|
Packit |
1c1d7e |
---------
|
|
Packit |
1c1d7e |
* Build Status: ![]()
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
* Coverity Scan Build Status: ![Coverity Scan Build Status]()
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
* Doxygen's Doxygen Documentation: ![]()
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
* Install
|
|
Packit |
1c1d7e |
* Quick install see (./INSTALL)
|
|
Packit |
1c1d7e |
* else http://www.doxygen.org/manual/install.html
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
* Project stats: https://www.openhub.net/p/doxygen
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Issues, bugs, requests, ideas
|
|
Packit |
1c1d7e |
----------------------------------
|
|
Packit |
1c1d7e |
Use the bug tracker to report bugs:
|
|
Packit |
1c1d7e |
* current list:
|
|
Packit |
1c1d7e |
* [Bugzilla](https://bugzilla.gnome.org/buglist.cgi?product=doxygen&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED)
|
|
Packit |
1c1d7e |
* Submit a new bug or feature request
|
|
Packit |
1c1d7e |
* [Enter bug](https://bugzilla.gnome.org/enter_bug.cgi?product=doxygen)
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Comms
|
|
Packit |
1c1d7e |
----------------------------------
|
|
Packit |
1c1d7e |
### Mailing Lists ###
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
There are three mailing lists:
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
* doxygen-announce@lists.sourceforge.net - Announcement of new releases only
|
|
Packit |
1c1d7e |
* doxygen-users@lists.sourceforge.net - for doxygen users
|
|
Packit |
1c1d7e |
* doxygen-develop@lists.sourceforge.net - for doxygen developers
|
|
Packit |
1c1d7e |
* To subscribe follow the link to
|
|
Packit |
1c1d7e |
* http://sourceforge.net/projects/doxygen
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Source Code
|
|
Packit |
1c1d7e |
----------------------------------
|
|
Packit |
1c1d7e |
In May 2013, Doxygen moved from
|
|
Packit |
1c1d7e |
subversion to git hosted at GitHub
|
|
Packit |
1c1d7e |
* https://github.com/doxygen/doxygen
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Enjoy,
|
|
Packit |
1c1d7e |
|
|
Packit |
1c1d7e |
Dimitri van Heesch (dimitri at stack.nl)
|