How to use Doxygen tableofcontents command

Question

I am trying to use tableofcontents command from Doxygen Doc.

To me \tableofcontents['{'[option[:level]][,option[:level]]*'}'] seems very cryptic. Could you give an example of how to pass options and levels?

What did you try so far? Which doxygen version.

albert
– albert

2019-11-28 15:06:57 +00:00
Commented Nov 28, 2019 at 15:06 — albert
– albert, Commented Nov 28, 2019 at 15:06

albert · Accepted Answer · 2022-10-21 16:12:45Z

3

From the doxygen documentation:

24.111 \tableofcontents['{'[option[:level]][,option[:level]]'}']

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 or XML or DocBook. 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 \tableofcontents acts as if just the option HTML and XML was specified. In case of multiple \tableofcontents commands in a page the option(s)

See also the beginning of the chapter "Special Commands" where a small description is of some of the used symbols.

So e.g.:

\tableofcontents
\tableofcontents{HTML}
\tableofcontents{HTML:3}
\tableofcontents{HTML:2,LaTex:3}

edited Oct 21, 2022 at 16:12

answered Nov 28, 2019 at 15:12

albert

9,2003 gold badges24 silver badges42 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to use Doxygen tableofcontents command

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related