Doxygen
|
|
Doxygen is a Documentation generator for C++, C, Java, IDL (Corba and Microsoft flavors) and to some extent Objective-C, PHP, C# and D. Being highly portable 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.
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. Here (http://upload.wikimedia.org/wikipedia/en/1/1f/Doxygen_ouput.png) is 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() {
...
}
}
See also
External links
- Doxygen Homepage (http://www.stack.nl/~dimitri/doxygen/)