Doxygen
Encyclopedia : D : DO : DOX : Doxygen
Doxygen is a documentation generator for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors) and to some extent 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.
Usage
Doxygen takes as input the source code files and outputs a set of documentation pages. By default the output format is HTML but it can also be in CHM, RTF, PDF, LaTeX, PostScript or man pages.The documentation generation is based on the parsing of the program structure and on the additional information given by the code writer in specially formatted comments. The format of the comments is similar to Javadoc.
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/** * Get the current time. * \return A time object set to the current time. */ static Time now() };
Versions
|}See also
External links
- [Doxygen Homepage]
- [Graphviz] - Graph Visualization Software, needed by doxygen to create diagrams
From Wikipedia, the Free Encyclopedia. Original article here. Support Wikipedia by contributing or donating.
All text is available under the terms of the GNU Free Documentation License See Wikipedia Copyrights for details.