summaryrefslogtreecommitdiffstats
path: root/doc/docblocks.doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/docblocks.doc')
-rw-r--r--doc/docblocks.doc32
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index 3b42506..7f91db5 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -262,6 +262,10 @@ Here is an example of the use of these comment blocks:
Click <a href="examples/afterdoc/html/class_test.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
+ \latexonly
+ See \hyperlink{afterdoc_example}{After Block example}
+ for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
+ \endlatexonly
\warning These blocks can only be used to document \e members and \e parameters.
They cannot be used to document files, classes, unions, structs,
@@ -278,6 +282,10 @@ Here is an example of a documented piece of C++ code using the Qt style:
Click <a href="examples/qtstyle/html/class_test.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
+ \latexonly
+ See \hyperlink{qtstyle_example}{QT Style example}
+ for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
+ \endlatexonly
The brief descriptions are included in the member overview of a
class, namespace or file and are printed using a small italic font
@@ -308,6 +316,10 @@ JavaDoc style and \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" set to YES:
Click <a href="examples/jdstyle/html/class_test.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
+ \latexonly
+ See \hyperlink{jdstyle_example}{Javadoc Style example}
+ for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
+ \endlatexonly
Similarly, if one wishes the first sentence of a Qt style documentation
block to automatically be treated as a brief description, one may set
@@ -384,6 +396,10 @@ using structural commands:
Click <a href="examples/structcmd/html/structcmd_8h.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
+ \latexonly
+ See \hyperlink{structcmd_example}{Structural Commands example}
+ for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
+ \endlatexonly
Because each comment block in the example above contains a structural command, all
the comment blocks could be moved to another location or input file
@@ -424,6 +440,10 @@ and assume they have to be represented in a preformatted way.
Click <a href="examples/docstring/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
+ \latexonly
+ See \hyperlink{python_example}{Python Docstring example}
+ for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
+ \endlatexonly
Note that in this case none of doxygen's \ref cmd_intro "special commands"
are supported.
@@ -440,6 +460,10 @@ Here is the same example again but now using doxygen style comments:
Click <a href="examples/pyexample/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
+ \latexonly
+ See \hyperlink{py_example}{Python example}
+ for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
+ \endlatexonly
Since python looks more like Java than like C or C++, you should set
\ref cfg_optimize_output_java "OPTIMIZE_OUTPUT_JAVA" to \c YES in the
@@ -465,6 +489,10 @@ Here is an example VHDL file with doxygen comments:
Click <a href="examples/mux/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
+ \latexonly
+ See \hyperlink{vhdl_example}{VHDL example}
+ for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
+ \endlatexonly
To get proper looking output you need to set
\ref cfg_optimize_output_vhdl "OPTIMIZE_OUTPUT_VHDL" to \c YES in the
@@ -574,6 +602,10 @@ Following is an example using doxygen style comments:
Click <a href="examples/tclexample/html/index.html">here</a>
for the corresponding HTML documentation that is generated by doxygen.
\endhtmlonly
+ \latexonly
+ See \hyperlink{tcl_example}{TCL example}
+ for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
+ \endlatexonly
\section docstructure Anatomy of a comment block