diff options
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 42 |
1 files changed, 35 insertions, 7 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index ba444e2..3711e29 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -75,6 +75,7 @@ documentation: \refitem cmdelse \\else \refitem cmdelseif \\elseif \refitem cmdem \\em +\refitem cmdemoji \\emoji \refitem cmdendcode \\endcode \refitem cmdendcond \\endcond \refitem cmdenddocbookonly \\enddocbookonly @@ -574,7 +575,6 @@ Structural indicators \htmlonly Click <a href="examples/manual/html/index.html">here</a> for the corresponding HTML documentation that is generated by doxygen. - </p> \endhtmlonly \latexonly See \hyperlink{extends_example}{Extends example} @@ -726,7 +726,6 @@ Structural indicators \htmlonly Click <a href="examples/manual/html/index.html">here</a> for the corresponding HTML documentation that is generated by doxygen. - </p> \endhtmlonly \latexonly See \hyperlink{extends_example}{Implements example} @@ -2112,7 +2111,7 @@ Make sure you have first read \ref intro "the introduction". this range are considered to be 5. In case no `level` is specified `level` is set to 5 (show all) In case no `option`. is specified \c \\tableofcontents acts as if just the - `option` `HTML` was specified. In case of multiple \c \\tableofcontents + `option` `HTML` and `XML` was specified. In case of multiple \c \\tableofcontents commands in a page the `option`(s) will be used additional to the already specified `option`(s), but only the last `level` of an `option` is valid. @@ -2457,7 +2456,7 @@ Commands for displaying examples \ref cfg_example_path "EXAMPLE_PATH" tag of doxygen's configuration file. <hr> -\section cmdhtmlinclude \\htmlinclude <file-name> +\section cmdhtmlinclude \\htmlinclude ["[block]"] <file-name> \addindex \\htmlinclude This command includes the file \<file-name\> as is in the HTML documentation. @@ -2465,9 +2464,17 @@ Commands for displaying examples placing \ref cmdhtmlonly "\\htmlonly" and \ref cmdendhtmlonly "\\endhtmlonly" commands around it. + Normally the contents of the file indicated by \ref cmdhtmlinclude "\\htmlinclude" + is inserted as-is. When you + want to insert a HTML fragment that has block scope like a table or list + which should appear outside \<p\>..\</p\>, this can lead to invalid HTML. + You can use \\htmlinclude[block] to make doxygen + end the current paragraph and restart after the file is included. + Files or directories that doxygen should look for can be specified using the \ref cfg_example_path "EXAMPLE_PATH" tag of doxygen's configuration file. + \sa section \ref cmdhtmlonly "\\htmlonly". <hr> \section cmdlatexinclude \\latexinclude <file-name> @@ -2737,6 +2744,22 @@ class C {}; \endcode <hr> +\section cmdemoji \\emoji "name" + +This command will produce an emoji character given its name. + +The supported names are the ones also supported by GitHub and listed here +https://gist.github.com/rxaviers/7360908 + +You can use the name with or without colons, i.e. +`\emoji smile` is the same as writing `\emoji :smile:`. +When an emoji is not supported the name with by places in the +text with in between colons, i.e. `\emoji unsupported` will produce +`:unsupported:` in the output. Doxygen will also give a warning message. + +See also the \ref emojisup "emoji support page" for details. + +<hr> \section cmdmsc \\msc ["caption"] [<sizeindication>=<size>] \addindex \\msc @@ -3126,11 +3149,12 @@ class Receiver \sa section \ref cmdmanonly "\\manonly", \ref cmdlatexonly "\\latexonly", \ref cmdrtfonly "\\rtfonly", - \ref cmdxmlonly "\\xmlonly", and - \ref cmddocbookonly "\\docbookonly". + \ref cmdxmlonly "\\xmlonly", + \ref cmddocbookonly "\\docbookonly", and + \ref cmdhtmlinclude "\\htmlinclude". <hr> -\section cmdimage \\image <format> <file> ["caption"] [<sizeindication>=<size>] +\section cmdimage \\image['{'[option]'}'] <format> <file> ["caption"] [<sizeindication>=<size>] \addindex \\image Inserts an image into the documentation. This command is format @@ -3162,6 +3186,10 @@ class Receiver The size specifier in \LaTeX (for example `10cm` or `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 + in HTML as tooltip (ignored for the other formats). + Here is example of a comment block: \verbatim |