doxygen @tableofcontents don not work

Question

I am trying to use the doxygen to generate a user help, when I use the command \tableofcontents in the mainpage, nothing shows in the html output.I just don't know why, does anyone know how to use the command of tableofcontents? Some examples will be better, thanks! Note that the browser is OK.

Answer 1

The solution key is to add a label to your headlines:

This is a level 1 header {#labelid_H1}
========================

This is a level 2 header {#labelid_H2}
------------------------

# This is a level 1 header # {#labelidH1}

## This is level 2 header ## {#labelidH2}

Then table of contents [TOC]

[TOC]

as well as headline links

[Link to first headline](@ref labelid_H1) 
[Link to second headline](#labelid_H2)

are working.

Another point to mention is that Doxygen eats up the first line in the file that's used as mainpage (look for "Eat my shorts, Doxygen!" in: Use the README.md file as main page in Doxygen)