KingChan
ffc1f898a2
|
||
|---|---|---|
| .github | ||
| addon | ||
| cmake | ||
| deps | ||
| doc | ||
| doc_internal | ||
| libversion | ||
| lua_scripts | ||
| src | ||
| templates | ||
| vhdlparser | ||
| .codedocs | ||
| .dockerignore | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| CMakeLists.txt | ||
| Dockerfile | ||
| INSTALL | ||
| LANGUAGE.HOWTO | ||
| README.md | ||
| VERSION | ||
| rename_doxygen.py | ||
README.md
Doxygen
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, and to some extent D. Doxygen also supports the hardware description language VHDL.
Doxygen can help you in three ways:
- It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in LaTeX) from a set of documented source files. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, DocBook and Unix man pages. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code.
- You can configure doxygen to extract the code structure from undocumented source files. This is very useful to quickly find your way in large source distributions. 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.
- You can also use doxygen for creating normal documentation (as I did for the doxygen user manual and doxygen web-site).
Download
The latest binaries and source of Doxygen can be downloaded from:
Developers
-
Linux & Windows and MacOS Build Status:
-
Coverity Scan Build Status:
-
Doxygen's internal source code documentation
-
Install: Please read the installation section of the manual (https://www.doxygen.nl/manual/install.html)
-
Project stats: https://www.openhub.net/p/doxygen
Issues, bugs, requests, ideas
Use the issue tracker to report bugs.
Comms
Mailing Lists
There are three mailing lists:
- doxygen-announce@lists.sourceforge.net - Announcement of new releases only
- doxygen-users@lists.sourceforge.net - for doxygen users
- doxygen-develop@lists.sourceforge.net - for doxygen developers
- To subscribe follow the link to
Source Code
In May 2013, Doxygen moved from subversion to git hosted at GitHub
Enjoy,
Dimitri van Heesch (doxygen at gmail.com)