Dr. Dobb's is part of the Informa Tech Division of Informa PLC

This site is operated by a business or businesses owned by Informa PLC and all copyright resides with them. Informa PLC's registered office is 5 Howick Place, London SW1P 1WG. Registered in England and Wales. Number 8860726.


Channels ▼
RSS

C/C++

Examining Doxygen

By Al Williams, October 01, 2004

Doxygen is a tool for generating formatted documentation from comment blocks in the source code.
October, 2004: Examining Doxygen

Tag Description
a Displays the next word in a special font.
addtoindex Adds entry to index (LaTeX).
addtogroup Creates a group that will be merged with other groups sharing the same name.
author Identifies the author.
arg Introduces parameters (arguments) to method calls.
b Bolds next word.
brief Provides a brief description of an element.
bug Identifies a known bug.
c Uses typewriter font on next word.
callgraph Requests a call graph.
class Identifies documentation that applies to the class as a whole.
code Starts a block of code (used to insert code into comments); ends with endcode.
copydoc Copies documentation from one member to another location.
date Inserts a date.
def Identifies documentation that applies to a #define.
defgroup Defines a group (which must be unique).
deprecated Identifies members that are deprecated.
e Italicizes next word.
file Identifies documentation that applies to an entire file.
htmlonly Sends HTML text directly to HTML output (ends with endhtmlonly).
if Conditionally includes documentation.
image Inserts an image.
ingroup Adds element to a particular group.
interface Identifies documentation that applies to an interface.
latexonly Sends LaTeX commands directly to LaTeX output (ends with endlatexonly).
link Creates a link to another element.
mainpage Defines the documentation seen on the main page.
manonly Sends text directly to MAN output (ends with endmanonly).
n Forces new line.
page Generates a page of documentation not directly tied to an element.
param Introduces a parameter.
ref Creates a cross reference.
return Documents a function return.
retval Documents a return value for a specific function.
sa Creates "see also" text.
see Creates "see also" text.
since Marks the date or version where an element first appeared.
todo Identifies items not yet complete.
var Documents a variable.
verbatim Sends a block of text directly to both HTML and LaTeX output (ends with endverbatim).
version Identifies a version of the code.
xmlonly Sends a block of text directly to XML output (ends with endxmlonly).

Table 1: Common Doxygen tags.



Previous 1 2 3 4 5 6 

Related Reading

News

Commentary

Slideshow

Video

Most Popular

More Insights

White Papers

More >>

Reports

More >>

Webcasts

More >>
INFO-LINK




Currently we allow the following HTML tags in comments:

Single tags

These tags can be used alone and don't need an ending tag.

<br> Defines a single line break

<hr> Defines a horizontal line

Matching tags

These require an ending tag - e.g. <i>italic text</i>

<a> Defines an anchor

<b> Defines bold text

<big> Defines big text

<blockquote> Defines a long quotation

<caption> Defines a table caption

<cite> Defines a citation

<code> Defines computer code text

<em> Defines emphasized text

<fieldset> Defines a border around elements in a form

<h1> This is heading 1

<h2> This is heading 2

<h3> This is heading 3

<h4> This is heading 4

<h5> This is heading 5

<h6> This is heading 6

<i> Defines italic text

<p> Defines a paragraph

<pre> Defines preformatted text

<q> Defines a short quotation

<samp> Defines sample computer code text

<small> Defines small text

<span> Defines a section in a document

<s> Defines strikethrough text

<strike> Defines strikethrough text

<strong> Defines strong text

<sub> Defines subscripted text

<sup> Defines superscripted text

<u> Defines underlined text

Dr. Dobb's encourages readers to engage in spirited, healthy debate, including taking us to task. However, Dr. Dobb's moderates all comments posted to our site, and reserves the right to modify or remove any content that it determines to be derogatory, offensive, inflammatory, vulgar, irrelevant/off-topic, racist or obvious marketing or spam. Dr. Dobb's further reserves the right to disable the profile of any commenter participating in said activities.

 
Disqus Tips To upload an avatar photo, first complete your Disqus profile. | View the list of supported HTML tags you can use to style comments. | Please read our commenting policy.
 

C/C++ Recent Articles

Most Popular

Stories Blogs

Upcoming Events



Most Recent Premium Content

Digital Issues