summaryrefslogtreecommitdiffstats
path: root/doc/commands.doc
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2001-08-19 18:13:14 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2001-08-19 18:13:14 (GMT)
commit2f7902073680b977b74f3faeada95119ec767eb3 (patch)
tree3ff0575884709cdc92f9e462441672f3549ab054 /doc/commands.doc
parenteed6800521ab6f21c41f485820ec1ee2def42e94 (diff)
downloadDoxygen-2f7902073680b977b74f3faeada95119ec767eb3.zip
Doxygen-2f7902073680b977b74f3faeada95119ec767eb3.tar.gz
Doxygen-2f7902073680b977b74f3faeada95119ec767eb3.tar.bz2
Release-1.2.9-20010819
Diffstat (limited to 'doc/commands.doc')
-rw-r--r--doc/commands.doc47
1 files changed, 46 insertions, 1 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index d9cf37f..ee2eb3b 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -61,6 +61,7 @@ documentation:
<li> \refitem cmddefgroup \defgroup
<li> \refitem cmddeprecated \deprecated
<li> \refitem cmddontinclude \dontinclude
+<li> \refitem cmddotfile \dotfile
<li> \refitem cmde \e
<li> \refitem cmdelse \else
<li> \refitem cmdelseif \elseif
@@ -758,6 +759,32 @@ Public/Protected/Private/... section.
*/
\endverbatim
+ You can also use conditional commands inside aliases. To
+ document a class in two languages you could for instance use:
+
+\par Example 2:
+\verbatim
+/*! \english
+ * This is English.
+ * \endenglish
+ * \dutch
+ * Dit is Nederlands.
+ * \enddutch
+ */
+class Example
+{
+};
+\endverbatim
+ <p>Where the following aliases are defined in the configuration file:<p>
+\verbatim
+ALIASES = "english=\if english" \
+ "endenglish=\endif" \
+ "dutch=\if dutch" \
+ "enddutch=\endif"
+\endverbatim
+
+ and \c ENABLED_SECTIONS can be used to enable either \c english or \c dutch.
+
\sa sections \ref cmdendif "\\endif", \ref cmdifnot "\\ifnot",
\ref cmdelse "\\else", and \ref cmdelseif "\\elseif".
@@ -1332,6 +1359,24 @@ Public/Protected/Private/... section.
\sa section \ref cmdendcode "\\endcode", section \ref cmdverbatim "\\verbatim"
<hr>
+\subsection cmddotfile \dotfile <file> ["caption"]
+
+ \addindex \dotfile
+ Inserts an image generated by dot from \<file\> into the documentation.
+
+ The first argument specifies the file name of the image.
+ doxygen will look for files in the paths (or files) that you specified
+ after the \ref cfg_dotfile_dirs "DOTFILE_DIRS" tag.
+ If the dot file is found it will be used as an input file to the dot tool.
+ The resulting image will be put into the correct output directory.
+ If the dot file name contains spaces you'll have to put quotes (") around it.
+
+ The second argument is optional and can be used to specify the caption
+ that is displayed below the image. This argument has to be specified
+ between quotes even if it does not contain any spaces. The quotes are
+ stripped before the caption is displayed.
+
+<hr>
\subsection cmde \e <word>
\addindex \e
@@ -1443,7 +1488,7 @@ Public/Protected/Private/... section.
\ref cmdlatexonly "\\latexonly".
<hr>
-\subsection cmdimage \image <format> <file> ["<caption>"] [<sizeindication>=<size>]
+\subsection cmdimage \image <format> <file> ["caption"] [<sizeindication>=<size>]
\addindex \image
Inserts an image into the documentation. This command is format