diff options
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 29 |
1 files changed, 19 insertions, 10 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 48991fb..9bd3f66 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -32,7 +32,7 @@ Each argument has a certain range: Paragraphs are delimited by a blank line or by a section indicator. Note that {curly} braces are also used for command options, here the braces are mandatory and just 'normal' characters. The starting curly brace has to directly follow - the command, so without whitspace. + the command, so without whitespace. </ul> If in addition to the above argument specifiers [square] brackets are used the argument is optional, unless they are placed between quotes in that case they are a mandatory @@ -349,7 +349,7 @@ Structural indicators \addindex \\showrefby When this command is put in a comment block of a function, method or variable, then doxygen will generate an overview for that function, method, variable of - the, documented, funcions and methods that call / use it. + the, documented, functions and methods that call / use it. The overview will be generated regardless of the value of \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION". \note The completeness (and correctness) of the overview depends on the @@ -1411,6 +1411,13 @@ contains \c TEST, or \c DEV then the \c \\details command is not needed. <hr> +\section cmdnoop \\noop ( text to be ignored ) + + \addindex \\noop + All the text, including the command, till the end of the line is ignored. + The command will most commonly be used in combination with \ref cfg_aliases "ALIASES" + to ignore not supported commands that are present for e.g. other processing tools. +<hr> \section cmdelse \\else \addindex \\else @@ -2270,8 +2277,8 @@ Commands for displaying examples The `option` `lineno` can be used to enable line numbers for the included code if desired. The `option` `doc` can be used to treat the file as documentation rather than code. - \note Some that when using the `{doc}` option, - commands like \ref cmdcond "\\cond" and \ref cmdif "\\if" don't work with + \note When using the `{doc}` option, + 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 they will appear @@ -2402,8 +2409,8 @@ Commands for displaying examples The `option` `lineno` can be used to enable line numbers for the included code if desired. The `option` `doc` can be used to treat the file as documentation rather than code. - \note Some that when using the `{doc}` option, - commands like \ref cmdcond "\\cond" and \ref cmdif "\\if" don't work with + \note When using the `{doc}` option, + 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 they will appear @@ -2592,7 +2599,7 @@ Commands for visual enhancements a Python file for instance, the syntax highlight will be done according to the Python syntax. - If it unclear from the context which language is meant (for instance the + If it is unclear from the context which language is meant (for instance the comment is in a <code>.txt</code> or <code>.markdown</code> file) then you can also explicitly indicate the language, by putting the file extension typically that doxygen associated with the language in curly brackets after the @@ -3191,7 +3198,7 @@ class Receiver \anchor image_sizeindicator \par Size indication The \c sizeindication can specify the width or height to be used (or a combination). The size specifier in \LaTeX (for example `10cm` or - `4in` or a symbolic width like `\\textwidth`). + `4in` or a symbolic width like `\textwidth`). Currently only the option `inline` is supported. In case the option `inline` is specified the image is placed "in the line", when a caption s present it is shown @@ -3214,8 +3221,10 @@ class Receiver \endverbatim \warning The image format for HTML is limited to what your - browser supports. For \LaTeX, the image format - must be Encapsulated PostScript (eps). + browser supports.<br>For \LaTeX, the image format + must be supported by the \LaTeX `\includegraphics` command i.e. + Encapsulated PostScript (eps), Portable network graphics (png), + Joint photographic experts group (jpg / jpeg). <br><br> Doxygen does not check if the image is in the correct format. So \e you have to make sure this is the case! |