summaryrefslogtreecommitdiffstats
path: root/doc/commands.doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/commands.doc')
-rw-r--r--doc/commands.doc71
1 files changed, 52 insertions, 19 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 4d8e5f7..6e9c2e8 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -181,9 +181,14 @@ documentation:
The following subsections provide a list of all commands that are recognized by
doxygen. Unrecognized commands are treated as normal text.
-<h2>\htmlonly <center> --- \endhtmlonly
- Structural indicators
- \htmlonly --- </center>\endhtmlonly</h2>
+
+\htmlonly <center> \endhtmlonly
+<h2>
+\htmlonly --- \endhtmlonly
+Structural indicators
+\htmlonly --- \endhtmlonly
+</h2>
+\htmlonly </center> \endhtmlonly
\section cmdaddtogroup \\addtogroup <name> [(title)]
\addindex \\addtogroup
@@ -383,6 +388,7 @@ doxygen. Unrecognized commands are treated as normal text.
(e.g. C).
The file \c manual.c in the example directory shows how to use this command.
+
\htmlonly
Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
@@ -484,6 +490,7 @@ doxygen. Unrecognized commands are treated as normal text.
(e.g. C).
The file \c manual.c in the example directory shows how to use this command.
+
\htmlonly
Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
@@ -581,6 +588,7 @@ doxygen. Unrecognized commands are treated as normal text.
\ref cmdprivate "\\private".
The file \c manual.c in the example directory shows how to use this command.
+
\htmlonly
Click <a href="$(DOXYGEN_DOCDIR)/examples/manual/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
@@ -856,9 +864,13 @@ doxygen. Unrecognized commands are treated as normal text.
<hr>
-<h2>\htmlonly <center> --- \endhtmlonly
- Section indicators
- \htmlonly --- </center>\endhtmlonly</h2>
+\htmlonly <center> \endhtmlonly
+<h2>
+\htmlonly --- \endhtmlonly
+Section indicators
+\htmlonly --- \endhtmlonly
+</h2>
+\htmlonly </center>\endhtmlonly
<hr>
\section cmdattention \\attention { attention text }
@@ -1125,7 +1137,9 @@ class Example
{
};
\endverbatim
- <p>Where the following aliases are defined in the configuration file:<p>
+
+ Where the following aliases are defined in the configuration file:
+
\verbatim
ALIASES = "english=\if english" \
"endenglish=\endif" \
@@ -1442,9 +1456,14 @@ void memcpy(void *dest, const void *src, size_t n);
\\xrefitem command.
<hr>
-<h2>\htmlonly <center> --- \endhtmlonly
- Commands to create links
- \htmlonly --- </center>\endhtmlonly</h2>
+
+\htmlonly <center> \endhtmlonly
+<h2>
+\htmlonly --- \endhtmlonly
+Commands to create links
+\htmlonly --- \endhtmlonly
+</h2>
+\htmlonly </center>\endhtmlonly
\section cmdaddindex \\addindex (text)
@@ -1617,9 +1636,13 @@ Make sure you have first read \ref intro "the introduction".
<hr>
-<h2>\htmlonly <center> --- \endhtmlonly
- Commands for displaying examples
- \htmlonly --- </center>\endhtmlonly</h2>
+\htmlonly <center> \endhtmlonly
+<h2>
+\htmlonly --- \endhtmlonly
+Commands for displaying examples
+\htmlonly --- \endhtmlonly
+</h2>
+\htmlonly </center>\endhtmlonly
\section cmddontinclude \\dontinclude <file-name>
@@ -1786,9 +1809,14 @@ Make sure you have first read \ref intro "the introduction".
\ref cfg_example_path "EXAMPLE_PATH" tag of doxygen's configuration file.
<hr>
-<h2>\htmlonly <center> --- \endhtmlonly
- Commands for visual enhancements
- \htmlonly --- </center>\endhtmlonly</h2>
+
+\htmlonly <center> \endhtmlonly
+<h2>
+\htmlonly --- \endhtmlonly
+Commands for visual enhancements
+\htmlonly --- \endhtmlonly
+</h2>
+\htmlonly </center>\endhtmlonly
\section cmda \\a <word>
@@ -2432,11 +2460,16 @@ class Receiver
character has to be escaped in some cases, because it is used to
prevent auto-linking to word that is also a documented class or struct.
-<h2>\htmlonly <center> --- \endhtmlonly
- Commands included for Qt compatibility
- \htmlonly --- </center>\endhtmlonly</h2>
<hr>
+\htmlonly <center> \endhtmlonly
+<h2>
+\htmlonly --- \endhtmlonly
+Commands included for Qt compatibility
+\htmlonly --- \endhtmlonly
+</h2>
+\htmlonly </center>\endhtmlonly
+
The following commands are supported to remain compatible to the Qt class
browser generator. Do \e not use these commands in your own documentation.
<ul>