diff options
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 6cb7a4d..12b85db 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -433,7 +433,7 @@ Structural indicators \par Example: \include enum.h \htmlonly - Click <a href="examples/enum/html/class_test.html">here</a> + Click <a href="examples/enum/html/class_enum___test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \latexonly @@ -565,7 +565,7 @@ Structural indicators \par Example: \include func.h \htmlonly - Click <a href="examples/func/html/class_test.html">here</a> + Click <a href="examples/func/html/class_fn___test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \latexonly @@ -823,7 +823,7 @@ Structural indicators \par Example: \include overload.cpp \htmlonly - Click <a href="examples/overload/html/class_test.html">here</a> + Click <a href="examples/overload/html/class_overload___test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \latexonly @@ -1121,7 +1121,7 @@ Structural indicators <hr> \section cmdweakgroup \\weakgroup <name> [(title)] - \addindex \\addtogroup + \addindex \\weakgroup Can be used exactly like \ref cmdaddtogroup "\\addtogroup", but has a lower priority when it comes to resolving conflicting grouping definitions. @@ -1513,7 +1513,7 @@ ALIASES = "english=\if english" \ \par Example: \include par.cpp \htmlonly - Click <a href="examples/par/html/class_test.html">here</a> + Click <a href="examples/par/html/class_par___test.html">here</a> for the corresponding HTML documentation that is generated by doxygen. \endhtmlonly \latexonly @@ -2120,8 +2120,8 @@ Commands for displaying examples \par Example: \include include.cpp - Where the example file \c example_test.cpp looks as follows: - \include example_test.cpp + Where the example file \c include_test.cpp looks as follows: + \include include_test.cpp \htmlonly Click <a href="examples/include/html/example.html">here</a> for the corresponding HTML documentation that is generated by doxygen. @@ -2197,7 +2197,7 @@ Commands for displaying examples \note Some commands like \ref cmdcond "\\cond" and \ref cmdif "\\if" don't work with this command due to the moment of parsing. - \note The included documentation should not have comment signs in it as the will appear + \note The included documentation should not have comment signs in it as they will appear in the documentation as well. \sa section \ref cmdinclude "\\include". @@ -2325,7 +2325,7 @@ Commands for displaying examples \note Some commands like \ref cmdcond "\\cond" and \ref cmdif "\\if" don't work with this command due to the moment of parsing. - \note The included documentation should not have comment signs in it as the will appear + \note The included documentation should not have comment signs in it as they will appear in the documentation as well. \sa section \ref cmdsnippet "\\snippet" and \ref cmdincludedoc "\\includedoc". @@ -2704,7 +2704,7 @@ class Receiver \addindex \\startuml Starts a text fragment which should contain a valid description of a - PlantUML diagram. See http://plantuml.sourceforge.net/ for examples. + PlantUML diagram. See http://plantuml.com/ for examples. The text fragment ends with \ref cmdenduml "\\enduml". \note You need to install Java and the PlantUML's jar file, if you want to use this command. The location of the jar file should be specified @@ -3317,7 +3317,7 @@ class Receiver \addindex \\\% This command writes the \c \% character to the output. This 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. + prevent auto-linking to a word that is also a documented class or struct. <hr> \section cmdquot \\" |