diff options
| author | albert-github <albert.tests@gmail.com> | 2018-07-12 12:15:33 (GMT) |
|---|---|---|
| committer | albert-github <albert.tests@gmail.com> | 2018-07-12 12:15:33 (GMT) |
| commit | 5b735d5118581e3bca686f79de341b8b2e76691f (patch) | |
| tree | 4448208ebb60ef4fdc3a41b83774565d532ab1c0 /doc/commands.doc | |
| parent | ba30b13cfd4910a5913f080a039fc429ec8a7e3f (diff) | |
| download | Doxygen-5b735d5118581e3bca686f79de341b8b2e76691f.zip Doxygen-5b735d5118581e3bca686f79de341b8b2e76691f.tar.gz Doxygen-5b735d5118581e3bca686f79de341b8b2e76691f.tar.bz2 | |
Enable in page table of contents for XML and add maximum level to in page table of contents
- add the in page table of contents for XML
- add the possibility to have maximum levels in the in page table of contents (possible per output type and per in page table of contents. Default is show all)
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 16 |
1 files changed, 10 insertions, 6 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 67d8fe4..601de3e 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -2016,15 +2016,19 @@ Make sure you have first read \ref intro "the introduction". \endverbatim <hr> -\section cmdtableofcontents \\tableofcontents['{'[option][,option]*'}'] +\section cmdtableofcontents \\tableofcontents['{'[option[:level]][,option[:level]]*'}'] \addindex \\tableofcontents Creates a table of contents at the top of a page, listing all - sections and subsections in the page. The option can be `HTML` or `LaTeX`. - In case no option is specified \c \\tableofcontents acts as if just the - option `HTML` 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). + sections and subsections in the page. The `option` can be `HTML` or `LaTeX` + or `XML`. When a `level` is specified this means the maximum nesting level + that is shown. The value of `level` should be in the range 1..5, values outside + 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 + 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. \warning This command only works inside related page documentation and \e not in other documentation blocks and only has effect in the |