The following subsections provide a list of all commands that are recognized by doxygen. Here is an alphabetically sorted list of all commands with references to their documentation: If in addition to the above argument specifiers brackets are used the argument is optional, unless they are placed between quotes in that case they are a mandatory part of the command argument. The starting curly brace has to directly follow the command, so without whitespace. If braces are also used for command options, here the braces are mandatory and just 'normal' characters. If (round) braces are used the argument extends until the end of the line on which the command was found. If braces are used the argument is a single word. Some commands have one or more arguments. ^ "Doxygen Manual: Graphs and diagrams".All commands in the documentation start with a backslash ( \) or an at-sign ( If you prefer you can replace all commands starting with a backslash below by their counterparts that start with an at-sign."doxypypy: A Doxygen filter for Python" – via PyPI. ^ "Automatic Python API documentation generation tools".^ a b "Doxygen Manual: Getting started".^ "Doxygen::Filter::Perl - A perl code pre-filter for Doxygen - "."Get With the Program: DIY tips for adding coding to your analysis arsenal". ^ "Doxygen Manual: Frequently Asked Questions"., From: Dimitri van Heesch, Date: Sun,, Qt-interest Archive ^ ANNOUNCE: doxygen 0.1 Archived October 4, 2011, at the Wayback Machine, Announcing: the first release of Doxygen, a C documentation system.*/ class Time Īn alternative approach for documenting parameters is shown below. See the GNU * General Public License for more details at * * * DESCRIPTION * * The time class represents a moment of time. * * This program is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. ** * * John Doe * 1.0 * * LICENSE * * This program is free software you can redistribute it and/or * modify it under the terms of the GNU General Public License as * published by the Free Software Foundation either version 2 of * the License, or (at your option) any later version. The generic syntax of documentation comments is to start a comment with an extra asterisk after the leading comment delimiter '/*': For more advanced diagrams and graphs, Doxygen can use the "dot" tool from Graphviz. Later, the Doxygen code was rewritten by Dimitri van Heesch.ĭoxygen has built-in support to generate inheritance diagrams for C classes. The first version of Doxygen borrowed code from an early version of DOC , developed by Roland Wunderling and Malte Zöckler at Zuse Institute Berlin. Other languages can be supported with additional code.ĭoxygen runs on most Unix-like systems, macOS, and Windows. Programming languages supported by Doxygen include C, C , C#, D, Fortran, IDL, Java, Objective-C, Perl, PHP, Python, and VHDL. In addition to the Javadoc syntax, Doxygen supports the documentation tags used in the Qt toolkit and can generate output in HyperText Markup Language ( HTML) as well as in Microsoft Compiled HTML Help (CHM), Rich Text Format (RTF), Portable Document Format (PDF), LaTeX, PostScript or man pages. Like Javadoc, Doxygen extracts documentation from source file comments. Doxygen can cross reference documentation and code, so that the reader of a document can easily refer to the actual code.ĭoxygen is free software, released under the terms of the GNU General Public License version 2 (GPLv2). When used for analysis, Doxygen uses its parse tree to generate diagrams and charts of the code structure. When used as a documentation generator, Doxygen extracts information from specially-formatted comments within the code. Doxygen ( / ˈ d ɒ k s i dʒ ən/ DOK-see-jən) is a documentation generator and static analysis tool for software source trees.
0 Comments
Leave a Reply. |