Doxygen

From Wikipedia, the free encyclopedia

Doxygen

Developer:	Dimitri van Heesch
Latest release:	1.5.1 / 29 October 2006
OS:	GNU/Linux, Windows, Mac OS, Solaris
Use:	Documentation generator
License:	GNU General Public License
Website:	Doxygen

Doxygen is a documentation generator for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors) and to some extent PHP, C#, D and ActionScript. It runs on most Unix systems as well as on Windows and Mac OS X. Most of the Doxygen code was written by Dimitri van Heesch.

KDE uses Doxygen for parts of its documentation and KDevelop has built-in support for it.

1 Usage
2 Example code
3 See also
4 External links

[edit] Usage

Like Javadoc, Doxygen extracts documentation from source file comments. In addition to the Javadoc syntax it supports the documentation tags used in the Qt toolkit and can generate output in HTML as well as in CHM, RTF, PDF, LaTeX, PostScript or man pages.

[edit] Example code

The following illustrates how a source file can be documented.

A screenshot of what the output would look like in HTML.

/**
 * The time class represents a moment of time.
 *
 * \author John Doe
 */
class Time {

  /**
   * Constructor that sets the time to a given value.
   * \param timemillis is a number of milliseconds passed since Jan 1. 1970
   */
  Time(int timemillis) {
    ...
  }

  /**
   * Get the current time.
   * \return A time object set to the current time.
   */
  static Time now() {
    ...
  }
};

[edit] See also

Free software Portal

Comparison of documentation generators
Eclox : Doxygen front-end free software plugin for Eclipse distributed under the term of the GNU General Public License.
Graphviz : Doxygen can use GraphViz to generate diagrams including class hierarchies and collaboration for C++, Java and Python.