2012-05-25 5 views
6

Ich versuche, die doxygen zu verwenden, um eine Benutzerhilfe zu generieren, wenn ich den Befehl \ tableofcontents in der Hauptseite verwenden, zeigt nichts in der HTML-Ausgabe.Ich weiß einfach nicht warum, tut jemand wissen, wie man den Befehl von tableofcontents benutzt? Einige Beispiele werden besser sein, danke! Beachten Sie, dass der Browser in Ordnung ist.doxygen @tableofcontents don funktioniert nicht

+0

Die [ '\ tableofcontents'] (http : //www.stack.nl/~dimitri/doxygen/commands.html#cmdtableofcontents) Befehl: "Erstellt ein Inhaltsverzeichnis oben auf einer Seite, das alle Abschnitte und Unterabschnitte auf der Seite auflistet". Haben Sie Abschnitte oder Unterabschnitte auf Ihrer '\ Hauptseite? Es erzeugt kein Inhaltsverzeichnis für die gesamte Projektdokumentation. – Chris

+0

Auch in der Version 1.8.0 funktionierte der Befehl \ tableofcontents auf der Hauptseite nicht. Dies wurde in der Version 1.8.1 korrigiert. – doxygen

Antwort

2

Die Lösung Schlüssel ist, um fügen Sie ein Label auf Ihre Schlagzeilen:

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} 

Dann Inhaltsverzeichnis [TOC]

[TOC] 

sowie Schlagzeile Links

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

funktionieren.

Ein weiterer Punkt zu erwähnen ist, dass Doxygen die erste Zeile in der Datei frisst, die als Startseite verwendet wird (sucht in "meine Shorts Essen, Doxygen!": Use the README.md file as main page in Doxygen)

+0

Die gleiche Lösung wird hier veröffentlicht: https://www.mail-archive.com/[email protected]/msg01520.html – Tuka