Markdown Dialects/Flavours Doxygen Markdown

Example

Doxygen is a commonly used code documentation tool (for languages including C++, C# and Java) that also supports the use of Markdown. In addition to the standard Markdown syntax, there are a number of Doxygen-specific elements.

The primary features are the use of @ref tags for references, and the @page, @section/@subsection and @anchor elements that these can reference.

@ref <name> ["text"]

This element creates a link (ie. reference) to a named section, subsection, page or anchor that has been defined elsewhere in the documentation. (see Doxygen reference)

The first parameter (name) should match the name of the section, subsection, page or anchor that you wish to link to.

The second optional parameter ("text") should be encapsulated in double quotes, and will define what the reference link will appear as on the page. If not used, the link will appear as the title used in the reference.

@section <section-name> (section title)

This element defines a section name. It is visually equivalent to a # element in Markdown, however it will also define a reference that can be linked to from other sections of your documentation. (see Doxygen reference)

The first parameter section-name defines the reference name that can be used by the @ref element. This cannot contain any spaces.

The second parameter section title is a string of words (that can be separated by spaces) which defines what the section heading will appear as on your page.

Example

@section Intro Introduction

This is some text in my introduction.

@section Body Body Paragraph

This is some text in my body, where I refer to the @ref Intro.

Output

Introduction

This is some text in my introduction.

Body Paragraph

This is some text in my body, where I refer to the Introduction.

NB: The word Introduction above will appear as a link that will jump to the Introduction heading.