Steuerung der LaTeX-Ausgabe von Doxygen für die PDF-Dokumentation

8

Ich verwende Doxygen, um Dokumentation für meinen Code zu generieren. Ich muss eine PDF-Version davon machen und die Verwendung von Doxygens LaTeX-Ausgabe scheint der richtige Weg dafür zu sein.

Ich habe jedoch eine Reihe von nervigen Problemen kennengelernt, und da ich bisher nichts über LaTeX wusste, habe ich nicht wirklich eine Idee davon, wie man sich ihnen nähert, und die unzähligen Referenzen für LaTeX-ähnliche Dinge sind keine große Hilfe. ..

Ich habe herausgefunden, wie man in einer sty-Datei ein Custom-Style-Ding erstellt und wie man Doxygen dazu bringt, es zu benutzen. Nach vielen Recherchen habe ich herausgefunden, wie man die Seitenränder etc. einstellen kann, und ich vermute, dass dies die Datei ist, die ich für die anderen Dinge, die ich will, haben möchte, aber ich kann anscheinend keine Befehle finden was ich will: (

  1. Das Inhaltsverzeichnis am Anfang des Dokuments enthält eine Menge von Elementen, aber es hat es nicht gemacht, da es den Inhalt sehr lang macht. Gibt es eine Möglichkeit, diesen Inhalt auf die ersten beiden Ebenen zu beschränken, anstatt Einträge für jede einzelne Funktion, Variable usw. zu haben? Ich möchte jedoch alle Lesezeichen behalten. Ich habe die "COMPACT_LATEX" -Option versucht, aber nicht nur die Elemente auf den Inhaltsseiten entfernt, sondern auch die Lesezeichen und die Mitgliederlisten am Anfang jedes Abschnitts, die ich wirklich behalten möchte.

  2. Gibt es eine Möglichkeit, die Reihenfolge der Dinge zu ändern, zum Beispiel die vollständige Klassenbeschreibung am Anfang des Abschnitts und nicht nach allen Mitgliedern und Attributen?

Fire Lancer 28.02.2010, 00:11
quelle

3 Antworten

7

Wow, das ist etwas Böses von Doxygen.

Okay, um das tocdepth -Zählerproblem zu umgehen, fügen Sie Ihrer .sty -Datei die folgende Zeile hinzu:

%Vor%

Sie können die PDF-Lesezeichentiefe auf einen separaten Wert setzen:

%Vor%

Beachten Sie auch, dass, wenn Sie eine Liste mit Zahlen / Tabellen haben, tocdepth mindestens 2 sein muss, damit sie angezeigt werden.

Ich sehe keine Möglichkeit, diese Gegenstände in den LaTeX-Dateien neu zu arrangieren --- Doxygen bockt sie einfach da draußen, also können wir nicht viel tun. Sie müssen die Doxygen-Dokumentation durchsuchen, um zu sehen, ob es eine Möglichkeit gibt, die Reihenfolge anzugeben, die ich vermute. (Hier hofft!)

    
godbyk 01.03.2010, 14:14
quelle
1

Sie sind also geschlossen.

Googeln auf "Latex-Inhalt Ebene" brachte mich zu LaTeX - Anpassen der Tiefe des Inhaltsverzeichnisses für verschiedene Teile der Diplomarbeit was suggeriert

%Vor%

wobei n bei Null für nur die höchste Division beginnt. Dies ist mutmaßlich in allen Standardstilen definiert, aber in doxygen ist es einen Versuch wert.

    
dmckee 28.02.2010 00:27
quelle
1

Sie könnten ein Perl / Awk-Skript schreiben, um die unerwünschten Zeilen einfach aus dem Inhaltsverzeichnis zu löschen. Für die Datei burble.tex erzeugt Latex die Datei burble.toc , die folgende Zeilen enthält:

%Vor%

Mit einfachen Regexen wird festgelegt, zu welchen Ebenen jede Zeile gehört. Sie können die Datei danach filtern. Sobald Sie das Inhaltsverzeichnis so haben, wie Sie es wollen, fügen Sie \nofiles an der entsprechenden Stelle ein (das Stylesheet?), Was bedeutet, dass Latex die Hilfsdateien liest, aber nicht überschreibt.

    
Charles Stewart 01.03.2010 10:38
quelle