diff options
author | Dimitri van Heesch <doxygen@gmail.com> | 2020-01-06 18:39:56 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-01-06 18:39:56 (GMT) |
commit | f8c32f996cac5db890c29958989d25ada389772b (patch) | |
tree | 6fc7a78206a4b68e2f519a46f0104f8beb4391f9 /doc | |
parent | d6ab8a10db09394f2e8368b6f4e787910481f91c (diff) | |
parent | afe51035be938b90b1790aa40937a93207ccdd34 (diff) | |
download | Doxygen-f8c32f996cac5db890c29958989d25ada389772b.zip Doxygen-f8c32f996cac5db890c29958989d25ada389772b.tar.gz Doxygen-f8c32f996cac5db890c29958989d25ada389772b.tar.bz2 |
Merge pull request #7481 from albert-github/feature/bug_xmlout_for_only
Showing information from all \*only commands in XML output
Diffstat (limited to 'doc')
-rw-r--r-- | doc/commands.doc | 35 |
1 files changed, 21 insertions, 14 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 9bd3f66..3415dce 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -2498,6 +2498,7 @@ Commands for displaying examples 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 cmdlatexonly "\\latexonly". <hr> \htmlonly</p><center><p>\endhtmlonly @@ -2697,8 +2698,9 @@ only copy the detailed documentation, not the brief description. \section cmddocbookonly \\docbookonly \addindex \\docbookonly - Starts a block of text that will be verbatim included in the - generated DocBook documentation only. The block ends with a + Starts a block of text that only will be verbatim included in the + generated DocBook documentation and tagged with `<docbookonly>` in the generated + XML output. The block ends with a \ref cmdenddocbookonly "\\enddocbookonly" command. \sa section \ref cmdmanonly "\\manonly", @@ -3142,8 +3144,9 @@ class Receiver \section cmdhtmlonly \\htmlonly ["[block]"] \addindex \\htmlonly - Starts a block of text that will be verbatim included in the - generated HTML documentation only. The block ends with a + Starts a block of text that only will be verbatim included in the + generated HTML documentation and tagged with `<htmlonly>` in the generated + XML output. The block ends with a \ref cmdendhtmlonly "\\endhtmlonly" command. This command can be used to include HTML code that is too complex @@ -3233,8 +3236,9 @@ class Receiver \section cmdlatexonly \\latexonly \addindex \\latexonly - Starts a block of text that will be verbatim included in the - generated \LaTeX documentation only. The block ends with a + Starts a block of text that only will be verbatim included in the + generated \LaTeX documentation and tagged with `<latexonly>` in the generated + XML output. The block ends with a \ref cmdendlatexonly "\\endlatexonly" command. This command can be used to include \LaTeX code that is too @@ -3249,15 +3253,17 @@ class Receiver \sa sections \ref cmdrtfonly "\\rtfonly", \ref cmdxmlonly "\\xmlonly", \ref cmdmanonly "\\manonly", - \ref cmdhtmlonly "\\htmlonly", and - \ref cmdhtmlonly "\\docbookonly". + \ref cmdhtmlonly "\\htmlonly", + \ref cmddocbookonly "\\docbookonly", and + \ref cmdlatexinclude "\\latexinclude". <hr> \section cmdmanonly \\manonly \addindex \\manonly - Starts a block of text that will be verbatim included in the - generated MAN documentation only. The block ends with a + Starts a block of text that only will be verbatim included in the + generated MAN documentation and tagged with `<manonly>` in the generated + XML output. The block ends with a \ref cmdendmanonly "\\endmanonly" command. This command can be used to include groff code directly into @@ -3334,8 +3340,9 @@ class Receiver \section cmdrtfonly \\rtfonly \addindex \\rtfonly - Starts a block of text that will be verbatim included in the - generated RTF documentation only. The block ends with a + Starts a block of text that only will be verbatim included in the + generated RTF documentation and tagged with `<rtfonly>` in the generated + XML output. The block ends with a \ref cmdendrtfonly "\\endrtfonly" command. This command can be used to include RTF code that is too complex @@ -3371,8 +3378,8 @@ class Receiver \section cmdxmlonly \\xmlonly \addindex \\xmlonly - Starts a block of text that will be verbatim included in the - generated XML output only. The block ends with a + Starts a block of text that only will be verbatim included in the + generated XML output. The block ends with a \ref cmdendxmlonly "\\endxmlonly" command. This command can be used to include custom XML tags. |