https://github.com/doxygen/doxygen

Official doxygen git repository
https://github.com/doxygen/doxygen

doxygen doxygen-documentation

Last synced: 24 days ago
JSON representation

Official doxygen git repository

• Host: GitHub
• URL: https://github.com/doxygen/doxygen
• Owner: doxygen
• License: gpl-2.0
• Created: 2013-05-19T19:16:07.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2025-05-05T19:45:52.000Z (9 months ago)
• Last Synced: 2025-05-05T22:41:44.111Z (9 months ago)
• Topics: doxygen, doxygen-documentation
• Language: C++
• Homepage: https://www.doxygen.org
• Size: 74.7 MB
• Stars: 5,963
• Watchers: 152
• Forks: 1,304
• Open Issues: 1,969
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome - doxygen/doxygen - Official doxygen git repository (C++)
• fucking-awesome-cpp - doxygen - The de facto standard tool for generating documentation from annotated C++ sources. [GPL2] 🌎 [website](www.doxygen.org) (Documentation)
• awesome-robotic-tooling - Doxygen - Doxygen is the de facto standard tool for generating documentation from annotated C++ sources. (Documentation and Presentation)
• awesome-robotic-tooling - Doxygen - Doxygen is the de facto standard tool for generating documentation from annotated C++ sources (Documentation and Presentation)
• awesome-cpp - doxygen - The de facto standard tool for generating documentation from annotated C++ sources. [GPL2] [website](https://www.doxygen.org) (Documentation)
• awesome-rainmana - doxygen/doxygen - Official doxygen git repository (C++)
• awesome-documentation - Doxygen - The de facto standard tool for generating documentation from annotated C++ sources. (Documentation Types / Code Documentation)
• awesome-backend - Doxygen - used and the de facto standard documentation generation tool for C++ (supports other languages). (Uncategorized / Uncategorized)

README

          
Doxygen

===============

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=9HHLRBCC8B2B8)

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:

1. It can generate an online documentation browser (in HTML) and/or an

   offline 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.

2. 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.

3. You can also use doxygen for creating normal documentation (as I did for

   the doxygen user manual and doxygen website).

Download

---------

The latest binaries and Doxygen source code can be downloaded from:

* https://www.doxygen.nl/

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](https://github.com/doxygen/doxygen/issues) 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

    * https://sourceforge.net/projects/doxygen/

Source Code

----------------------------------

In May 2013, Doxygen moved from

subversion to git hosted at GitHub

* https://github.com/doxygen/doxygen

Enjoy,

Dimitri van Heesch (doxygen at gmail.com)