2012-05-25 12 views
6

Sto provando a usare doxygen per generare un aiuto utente, quando uso il comando \ tableofcontents nella pagina principale, niente viene mostrato nell'output html. Solo non so perché, qualcuno sapere come usare il comando di tableofcontents? Alcuni esempi saranno migliori, grazie! Si noti che il browser è OK.doxygen @tableofcontents don not work

+0

Il [ '\ tableofcontents'] (http : //www.stack.nl/~dimitri/doxygen/commands.html#cmdtableofcontents) comando: "Crea un sommario nella parte superiore di una pagina, elencando tutte le sezioni e sottosezioni nella pagina". Avete sezioni o sottosezioni sul vostro '\ mainpage'? Non genera un sommario per la documentazione del progetto nel suo complesso. – Chris

+0

Anche nella versione 1.8.0 il comando \ tableofcontents non funzionava nella pagina principale. Questo è stato corretto nella versione 1.8.1. – doxygen

risposta

2

La chiave soluzione è quella di aggiungere un'etichetta per i titoli:

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} 

Poi indice [sommario]

[TOC] 

così come headline collega

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

stanno funzionando.

Un altro punto da menzionare è che Doxygen mangia la prima riga del file che viene utilizzato come mainpage (cercare in "Eat miei pantaloncini, Doxygen!": Use the README.md file as main page in Doxygen)

+0

La stessa soluzione è pubblicata qui: https://www.mail-archive.com/[email protected]/msg01520.html – Tuka