7/5/2023 0 Comments Doxygen fortran example![]() It is provided "as is" without express or implied warranty.ĭocuments produced by doxygen are derivative works derived from the No representations are made about the suitability of this softwareįor any purpose. Permission to use, copy, modify, and distribute this software and itsĭocumentation under the terms of the GNU General Public License is hereby Furthermore, executables for Windows are available. As a result, it runs on most other Unix flavors as well. You can also use doxygen for creating normal documentation (as I did for the doxygen user manual and web-site).ĭoxygen is developed under Mac OS X and Linux, but is set-up to be highly portable. Doxygen can also visualize the relations between the various elements by means of include dependency graphs, inheritance diagrams, and collaboration diagrams, which are all generated automatically. This is very useful to quickly find your way in large source distributions. You can configure doxygen to extract the code structure from undocumented source files. The documentation is extracted directly from the sources, which makes it much easier to keep the documentation consistent with the source code. There is also support for generating output in RTF (MS-Word), PostScript, hyperlinked PDF, compressed HTML, and Unix man pages. It can generate an on-line documentation browser (in HTML) and/or an off-line reference manual (in ) from a set of documented source files. Doxygen also supports the hardware description language VHDL. *! More detailed enum description.Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, and to some extent D. You can use the JavaDoc style, which consist of a C-style comment block starting with two *'s, like this: There are several ways to mark a comment block as a detailed description: For the HTML output brief descriptions are also use to provide tooltips at places where an item is referenced. An "in body" description can also act as a detailed description or can describe a collection of implementation details. 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).Īs the name suggest, a brief description is a short one-liner, whereas the detailed description provides longer, more detailed documentation. For methods and functions there is also a third type of description, the so called "in body" description, which consists of the concatenation of all comment blocks found within the body of the method or function. For Python, VHDL, Fortran, and Tcl code there are different comment conventions, which can be found in sections Special documentation blocks in Python, Special documentation blocks in VHDL, Special documentation blocks in Fortran, and Documentation blocks in Tcl respectively.įor each code item there are two (or in some cases three) types of descriptions, which together form the documentation: a brief description and detailed description, both are optional. ![]() A special documentation block is a C or C++ style comment block with some additional markings, so doxygen knows it is a piece of documentation that needs to end up in the generated documentation.
0 Comments
Leave a Reply. |