background preloader

Main Page - Algorithmist

Main Page - Algorithmist

Doxygen This chapter covers two topics: How to put comments in your code such that doxygen incorporates them in the documentation it generates. This is further detailed in the next section.Ways to structure the contents of a comment block such that the output looks good, as explained in section Anatomy of a comment block. A special comment block is a C or C++ style comment block with some additional markings, so doxygen knows it is a piece of structured text that needs to end up in the generated documentation. For Python, VHDL, Fortran, and Tcl code there are different commenting conventions, which can be found in sections Comment blocks in Python, Comment blocks in VHDL, Comment blocks in Fortran, and Comment blocks in Tcl respectively. Comment blocks for C-like languages (C/C++/C#/Objective-C/PHP/Java) Having more than one brief or detailed description is allowed (but not recommended, as the order in which the descriptions will appear is not specified). As you can see doxygen is quite flexible. !

Solved Programming Problems

Related: