Dokumentieren des Codes

GTK-Doc benutzt Quellcode-Kommentare mit einer speziellen Syntax für Code-Dokumentation. Weiterhin werden Informationen über Ihre Projektstruktur aus anderen Quellen geholt. Im nächsten Abschnitt finden Sie umfassende Informationen über die Syntax der Kommentare.

Platzierung der Dokumentation

In der Vergangenheit wurde die Dokumentation oft in Dateien gespeichert, die im Ordner tmpl liegen. Das hat den Nachteil, dass die Informationen oft nicht aktualisiert wurden und die Datei tendenziell Konflikte mit Versionsverwaltungssystemen verursachen kann.

Um die bereits genannten Probleme zu vermeiden, empfehlen wir, die Dokumentation innerhalb der Quellen zu halten. In diesem Handbuch wird ausschließlich dieser Weg des Dokumentierens des Quellcodes beschrieben.

Der Scanner kann mit den meisten C-Kopfdateien umgehen. Im Falle von Warnungen des Scanners, die wie ein Spezialfall aussehen, kann man GTK-Doc anweisen diese zu überspringen.

Beispiel 3-1GTK-Doc-Kommentarblock
#ifndef __GTK_DOC_IGNORE__
/* unparseable code here */
#endif

Einschränkungen

Beachten Sie, dass GTK-Doc zwar #ifndef(__GTK_DOC_IGNORE__) unterstützt, aber nicht #if !defined(__GTK_DOC_IGNORE__) oder andere Kombinationen.