summaryrefslogtreecommitdiffstats
path: root/doc/commands.doc
diff options
context:
space:
mode:
authordimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2002-02-10 18:17:19 (GMT)
committerdimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7>2002-02-10 18:17:19 (GMT)
commitd1e917df5d2bb4125a22eba3c984640c099a7096 (patch)
treed1468ce96ea2cb67fa7825027a3f93a67bf4d9a6 /doc/commands.doc
parent88c84f0affadf69d1813d1a971692a5097f8870a (diff)
downloadDoxygen-d1e917df5d2bb4125a22eba3c984640c099a7096.zip
Doxygen-d1e917df5d2bb4125a22eba3c984640c099a7096.tar.gz
Doxygen-d1e917df5d2bb4125a22eba3c984640c099a7096.tar.bz2
Release-1.2.13-20020210
Diffstat (limited to 'doc/commands.doc')
-rw-r--r--doc/commands.doc23
1 files changed, 22 insertions, 1 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index cd49226..fd4f71d 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -137,6 +137,7 @@ documentation:
<li> \refitem cmdat \@
<li> \refitem cmdbackslash \\
<li> \refitem cmdamp \&
+<li> \refitem cmdtilde \~
<li> \refitem cmdlt \\<
<li> \refitem cmdgt \\>
<li> \refitem cmdhash \#
@@ -1330,6 +1331,7 @@ ALIASES = "english=\if english" \
\addindex \b
Displays the argument \<word\> using a bold font.
Equivalent to \<b\>word\</b\>.
+ To put multiple words in bold use \<b\>multiple words\</b\>.
<hr>
\subsection cmdc \c <word>
@@ -1348,6 +1350,7 @@ ALIASES = "english=\if english" \
... This function returns \c void and not \c int ...
Equivalent to \ref cmdp "\\p"
+ To have multiple words in typewriter font use \<tt\>multiple words\</tt\>.
<hr>
\subsection cmdcode \code
@@ -1393,7 +1396,8 @@ ALIASES = "english=\if english" \
will result in the following text:<br><br>
... this is a \e really good example ...
- Equivalent to \ref cmdem "\\em"
+ Equivalent to \ref cmdem "\\em".
+ To emphasis multiple words use \<em\>multiple words\</em\>.
<hr>
\subsection cmdem \em <word>
@@ -1642,6 +1646,23 @@ ALIASES = "english=\if english" \
because doxygen uses it to detect JavaDoc commands.
<hr>
+\subsection cmdtilde \~[LanguageId]
+ \addindex \~
+ This command enables/disables a language specific filter. This can be
+ used to put documentation for different language into one comment block
+ and use the \c OUTPUT_LANGUAGE tag to filter out only a specific language.
+ Use \\~language_id to enable output for a specific language only and
+ \\~ to enable output for all languages (this is also the default mode).
+
+ Example:
+\verbatim
+/*! \~english This is english \~dutch Dit is Nederlands \~german Dieses ist
+ deutsch. \~ output for all languages.
+ */
+\endverbatim
+
+
+<hr>
\subsection cmdamp \&
\addindex \&