diff options
| author | Dimitri van Heesch <dimitri@stack.nl> | 2018-07-22 13:34:57 (GMT) |
|---|---|---|
| committer | Dimitri van Heesch <dimitri@stack.nl> | 2018-07-22 13:34:57 (GMT) |
| commit | 982fce9e021e5359ec2572cbbb815a47bc822e70 (patch) | |
| tree | 24d8fc538734f725ebb718ff720b4e8b61d9720d /doc/commands.doc | |
| parent | 5c4ee43f13433a0c1de63805cc139b61e9a4d872 (diff) | |
| parent | 956342ae0b2e09f5e398778c255006f9d26e7b52 (diff) | |
| download | Doxygen-982fce9e021e5359ec2572cbbb815a47bc822e70.zip Doxygen-982fce9e021e5359ec2572cbbb815a47bc822e70.tar.gz Doxygen-982fce9e021e5359ec2572cbbb815a47bc822e70.tar.bz2 | |
Merge branch 'feature/bug_tableofcontents_latex' of https://github.com/albert-github/doxygen into albert-github-feature/bug_tableofcontents_latex
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index eeb5041..4b71285 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -2028,15 +2028,23 @@ Make sure you have first read \ref intro "the introduction". \endverbatim <hr> -\section cmdtableofcontents \\tableofcontents +\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. + 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 - HTML output! + the specified output! <hr> \section cmdsection \\section <section-name> (section title) |