diff options
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 58 |
1 files changed, 57 insertions, 1 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 035889f..01d069f 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -363,6 +363,10 @@ Structural indicators Click <a href="examples/class/html/index.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly + \latexonly + See \hyperlink{class_example}{Class example} + for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. + \endlatexonly <hr> \section cmddef \\def <name> @@ -377,6 +381,11 @@ Structural indicators Click <a href="examples/define/html/define_8h.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly + \latexonly + See \hyperlink{define_8h}{Define example} + for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. + \endlatexonly + <hr> \section cmddefgroup \\defgroup <name> (group title) @@ -425,6 +434,10 @@ Structural indicators Click <a href="examples/enum/html/class_test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly + \latexonly + See \hyperlink{class_enum___test}{Enum example} + for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. + \endlatexonly <hr> \section cmdexample \\example <file-name> @@ -456,6 +469,10 @@ Structural indicators Click <a href="examples/example/html/examples.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly + \latexonly + See \hyperlink{example_test_8cpp-example}{Example example} + for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. + \endlatexonly \sa section \ref cmdinclude "\\include". @@ -482,6 +499,10 @@ Structural indicators Click <a href="examples/manual/html/index.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly + \latexonly + See \hyperlink{extends_example}{Extends example} + for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. + \endlatexonly \sa section \ref cmdimplements "\\implements" and section \ref cmdmemberof "\\memberof" @@ -506,6 +527,10 @@ Structural indicators Click <a href="examples/file/html/file_8h.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly + \latexonly + See \hyperlink{file_example}{File example} + for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. + \endlatexonly \note In the above example \ref cfg_javadoc_autobrief "JAVADOC_AUTOBRIEF" has been set to \c YES in the configuration file. @@ -540,7 +565,10 @@ Structural indicators Click <a href="examples/func/html/class_test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly - + \latexonly + See \hyperlink{class_fn___test}{Fn example} + for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. + \endlatexonly \sa sections \ref cmdvar "\\var", \ref cmdproperty "\\property", and \ref cmdtypedef "\\typedef". @@ -622,6 +650,10 @@ Structural indicators Click <a href="examples/manual/html/index.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly + \latexonly + See \hyperlink{extends_example}{Implements example} + for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. + \endlatexonly \sa section \ref cmdextends "\\extends" and section \ref cmdmemberof "\\memberof" @@ -790,6 +822,10 @@ Structural indicators Click <a href="examples/overload/html/class_test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly + \latexonly + See \hyperlink{class_overload___test}{Overload example} + for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. + \endlatexonly <hr> \section cmdpackage \\package <name> @@ -814,6 +850,10 @@ Structural indicators Click <a href="examples/page/html/pages.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly + \latexonly + See \hyperlink{page_example}{Page example} + for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. + \endlatexonly \par Note: The \<name\> argument consists of a combination of letters and number @@ -970,6 +1010,10 @@ Structural indicators Click <a href="examples/relates/html/class_string.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly + \latexonly + See \hyperlink{class_string}{Relates example} + for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. + \endlatexonly <hr> \section cmdrelated \\related <name> @@ -1121,6 +1165,10 @@ Section indicators Click <a href="examples/author/html/class_some_nice_class.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly + \latexonly + See \hyperlink{class_some_nice_class}{Author example} + for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. + \endlatexonly <hr> \section cmdauthors \\authors { list of authors } @@ -1464,6 +1512,10 @@ ALIASES = "english=\if english" \ Click <a href="examples/par/html/class_test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly + \latexonly + See \hyperlink{class_par___test}{Par example} + for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. + \endlatexonly <hr> \section cmdparam \\param [(dir)] <parameter-name> { parameter description } @@ -2070,6 +2122,10 @@ Commands for displaying examples Click <a href="examples/include/html/example.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly + \latexonly + See \hyperlink{include_example}{Include example} + for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. + \endlatexonly Alternatively, the \ref cmdsnippet "\\snippet" command can be used to include only a fragment of a source file. For this to work the |