diff options
| author | albert-github <albert.tests@gmail.com> | 2018-11-25 15:34:58 (GMT) |
|---|---|---|
| committer | albert-github <albert.tests@gmail.com> | 2018-11-25 15:34:58 (GMT) |
| commit | 1c0a565a28582d0bc0776988ffef16565563e950 (patch) | |
| tree | 2ec63650e76e2f1e57bfa1f6eef0d84059e07b52 /doc/commands.doc | |
| parent | 4c1d17ef7579dabd4db55dc4777185c290edb256 (diff) | |
| download | Doxygen-1c0a565a28582d0bc0776988ffef16565563e950.zip Doxygen-1c0a565a28582d0bc0776988ffef16565563e950.tar.gz Doxygen-1c0a565a28582d0bc0776988ffef16565563e950.tar.bz2 | |
Incorrect number tag sequence for xhtml with htmlinclude command possible
Analogous to the `\htmlonly` also with the `\htmlinclude` command it is possible that some parts are added that cannot be inside a `<p> ... <\/p>` and thus we have to temporary close (and later reopen) the paragraph.
The option `[block]` has been added to the `\htmlinclude` command (analogous to the `\htmlonly` command).
Problem can be seen with the default doxygen test 30 (`[030_htmlinclude.dox]: test the \htmlinclude command`).
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 15 |
1 files changed, 12 insertions, 3 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index f04b543..20c94e1 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -2457,7 +2457,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 +2465,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> @@ -3126,8 +3134,9 @@ 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['{'[option]'}'] <format> <file> ["caption"] [<sizeindication>=<size>] |