README.md

   1 Doxygen
   2 ===============
   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,
   7 and to some extent D.
   8
   9 Doxygen can help you in three ways:
  10
  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).
  24
  25 Download
  26 ---------
  27 The latest binaries and source of Doxygen can be downloaded from:
  28 * http://www.doxygen.org/
  29
  30 Developers
  31 ---------
  32 * Build Status: <a href="https://travis-ci.org/doxygen/doxygen"><img src="https://secure.travis-ci.org/doxygen/doxygen.png?branch=master"/></a>
  33
  34 * 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>
  35
  36 * Doxygen's Doxygen Documentation: <a href="https://codedocs.xyz/doxygen/doxygen/"><img src="https://codedocs.xyz/doxygen/doxygen.svg"/></a>
  37
  38 * Install
  39   * Quick install see (./INSTALL)
  40   * else http://www.doxygen.org/manual/install.html
  41
  42 * Project stats: https://www.openhub.net/p/doxygen
  43
  44 Issues, bugs, requests, ideas
  45 ----------------------------------
  46 Use the bug tracker to report bugs:
  47 * current list:
  48     * [Bugzilla](https://bugzilla.gnome.org/buglist.cgi?product=doxygen&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED)
  49 * Submit a new bug or feature request
  50     * [Enter bug](https://bugzilla.gnome.org/enter_bug.cgi?product=doxygen)
  51
  52 Comms
  53 ----------------------------------
  54 ### Mailing Lists ###
  55
  56 There are three mailing lists:
  57
  58 * doxygen-announce@lists.sourceforge.net     - Announcement of new releases only
  59 * doxygen-users@lists.sourceforge.net        - for doxygen users
  60 * doxygen-develop@lists.sourceforge.net      - for doxygen developers
  61 * To subscribe follow the link to
  62     * http://sourceforge.net/projects/doxygen
  63
  64 Source Code
  65 ----------------------------------
  66 In May 2013, Doxygen moved from
  67 subversion to git hosted at GitHub
  68 * https://github.com/doxygen/doxygen
  69
  70 Enjoy,
  71
  72 Dimitri van Heesch (dimitri at stack.nl)