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.
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.
The scanner can handle the majority of c headers fine. In the case of receiving warnings from the scanner that look like a special case, one can hint GTK-Doc to skip over them.
#ifndef __GTK_DOC_IGNORE__ /* unparseable code here */ #endif