summaryrefslogtreecommitdiffstats
path: root/doc/commands.doc
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2018-05-21 09:37:42 (GMT)
committeralbert-github <albert.tests@gmail.com>2018-05-21 09:37:42 (GMT)
commitba30b13cfd4910a5913f080a039fc429ec8a7e3f (patch)
tree21a3f69741314fdb29dc076c11b83d9e1e27788d /doc/commands.doc
parentdf0d9c3df44dbce633c38e99d33be4de06706f7b (diff)
downloadDoxygen-ba30b13cfd4910a5913f080a039fc429ec8a7e3f.zip
Doxygen-ba30b13cfd4910a5913f080a039fc429ec8a7e3f.tar.gz
Doxygen-ba30b13cfd4910a5913f080a039fc429ec8a7e3f.tar.bz2
Enable in page table of contents for LaTeX
currently the \tableofcontents command is only supported for HTML. In this patch: - enable in page table of contents for LaTeX: \tableofcontents['{'[option][,option]*'}'] where option can be 'HTML, and 'LaTeX' (side effect: possibility to have options with, nearly, all commands.)
Diffstat (limited to 'doc/commands.doc')
-rw-r--r--doc/commands.doc10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 1c7e7cf..67d8fe4 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
+\section cmdtableofcontents \\tableofcontents['{'[option][,option]*'}']
\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`.
+ 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).
\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)