Überprüfung des Ergebnisses
Ein GTK-Doc-Durchlauf erzeugt Protokolldateien im Dokumentationsordner. Die Namen der erzeugten Dateien sind: <package>-undocumented.txt, <package>-undeclared.txt und <package>-unused.txt. Sie liegen alle als Klartext vor und können daher einfach betrachtet und weiterverarbeitet werden.
Die Datei <package>-undocumented.txt beginnt mit der Zusammenfassung der Dokumentation. Darunter sind zwei durch Leerzeilen getrennte Abschnitte. Der erste Abschnitt listet undokumentierte oder unvollständige Symbole. Der zweite Abschnitt macht das gleiche für Abschnitts-Dokumente. Unvollständige Einträge sind jene, welche Dokumentation haben, aber z.B. ein neuer Parameter hinzugefügt worden ist.
Die Datei <package>-undeclared.txt listet die in <package>-sections.txt gelieferten, aber nicht in den Quellen gefundenen Symbole. Prüfen Sie, ob diese entfernt oder falsch geschrieben wurden.
Die Datei <package>-unused.txt listet Symbolnamen auf, in denen der GTK-Doc-Scanner Dokumentation gefunden hat, aber nicht weiß, wo sie abgelegt werden soll. Dies bedeutet, dass das Symbol noch nicht der Datei <package>-sections.txt hinzugefügt wurde.
Aktivieren Sie oder fügen Sie die Zeile TESTS=$(GTKDOC_CHECK) in Makefile.am hinzu. Wenn zumindest GTK-Doc 1.9 installiert ist, so wird damit eine Plausibilitätsprüfung während make check ausgeführt.
Man kann sich auch die Dateien ansehen, die durch den Quellcode-Scanner erzeugt wurden: <package>-decl-list.txt und <package>-decl.txt. Die erste kann mit der Abschnittsdatei verglichen werden, falls diese händisch verwaltet wird. Die zweite listet alle Deklarationen aus den Kopfdateien. Falls ein Symbol fehlt kann man prüfen, ob diese Datei es enthält.
Wenn das Projekt auf GObject basiert, kann man auch in die Dateien schauen, die der Objekt-Scanner erzeugt hat: <package>.args.txt, <package>.hierarchy.txt, <package>.interfaces.txt, <package>.prerequisites.txt und <package>.signals.txt. Falls in irgendeiner Datei Symbole fehlen, können Sie Gtk-Doc anweisen, die zwischenläufige Scanner-Datei zur weiteren Analyse zu behalten, indem Sie GTK_DOC_KEEP_INTERMEDIATE=1 make ausführen.