Doxygen
Doxygen is developed by Dimitri van Heesch software documentation tool, it is available as free software under the GNU General Public License.
By special comments in the source code, software developers can define explanations of program elements that make Doxygen creates a clear documentation. It is also possible to generate a summary overview of the structure and the elements of an already existing program (files used, functions, variables and their jew role in the program flow ).
The aim of such Dokumentierungsmethode is the avoidance of redundancy. Since program structures must be described in the Code itself, additional documentation of the structures ( functions, classes, methods, etc.) is error-prone in a separate Entwicklerdokumentierung, as these often change over the course of development. In addition, the cost of a separate document creation the developer will be spared and secure and improve the completeness of the documentation.
As a graphical user interface called the doxywizard with which the settings can be performed very simply serves.
The most popular development environments (IDE ) support by Doxygen syntax highlighting.
Supported programming languages
Supported programming languages are C , C, Objective- C, Java, Python, Fortran and IDL. They are supported in their full language support. With restrictions also commenting on PHP, C #, D, and VHDL is possible. Since version 1.7.5 Tcl is supported. Through additional filter also source code in Perl or Object Pascal can be edited.
Supported output formats
The output format support Doxygen HTML, CHM, LaTeX, XML, RTF, PostScript, PDF, man pages, and Markdown. Also can be created for the Help system of Qt corresponding control data for creating help files.
Example
The documentation of a function can be embedded in the source code as follows (here in the C language):
/ ** * \ Brief Exemplary function * * This function returns the given parameters * To the console. * * \ Param parameters parameters to be output * \ Return Status Code * * / int function ( int parameter) { printf (" Parameters:% d", parameters ); return false; } Similar tools
- Javadoc, Natural Docs, phpDocumentor, ASDoc, robodoc, Sandcastle, car Duck, pydoc, HeaderDoc Plain Old Documentation, Sphinx