Doxygen

Doxygen is a Documentation generator for C plus plus, C programming language, Java programming language, Interface description language (Corba and Microsoft flavors) and to some extent Objective C programming language, PHP, C Sharp programming language and D programming language. Being highly portable, it runs on most Unix systems as well as on Microsoft Windows and Mac OS X. Most of the Doxygen code was written by Dimitri van Heesch.

Several projects such as KDE use Doxygen for generating documentation for the API. KDevelop has builtin support for Doxygen.

=Example code=

The following illustrates how a source file can be documented.

/** * 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.

eturn A time object set to the current time. */ static Time now() { ... } }

== Versions==

|valign= top | |valign= top | |valign= top | |valign= top | |valign= top | |}

=See also=

*List of documentation generators *Comparison of documentation generators

=External links=

*[http://www.stack.nl/~dimitri/doxygen/ Doxygen Homepage]