Ovlivnění výsledku
Spuštění GTK-Doc vygeneruje ve složkách pro dokumentaci soubory s výstupními sestavami. Generované soubory jsou nazvané: <balíček>-undocumented.txt, <balíček>-undeclared.txt a <balíček>-unused.txt. Všechno to jsou prosté textové soubory, které si lze jednoduše prohlížet a zpracovávat je.
Soubor <balíček>-undocumented.txt začíná souhrnnými údaji o dokumentaci. Následují dva oddíly oddělené prázdnými řádky. První oddíl je seznam nezdokumentovaných nebo neúplných symbolů. Druhý oddíl je to stejné, ale pro dokumentace oddílů. Neúplné položky jsou takové, které mají dokumentaci, ale u kterých byl například přidán nový parametr.
Soubor <balíček>-undeclared.txt uvádí symboly, které jsou zadané v <balíček>-section.txt, ale nebyly nalezené ve zdrojových kódech. Ověřte, jestli nebyly odstraněny, nebo v nich není překlep.
Soubor <balíček>-unused.txt uvádí názvy symbolů, které GTK-Doc při procházení dokumentace nalezl, ale neví, kam je zařadit. To znamená, že tyto symboly nejsou zatím zařazené v souboru <balíček>-section.txt.
Povolte nebo přidejte řádek TESTS=($GTKDOC_CHECK) v Makefile.am. Pokud máte nainstalované GTK-Doc ve verzi minimálně 1.9, bude se díky tomu při spuštění make check provádět kontrola správnosti údajů.
Můžete se také podívat do souborů vytvořených skenerem zdrojového kódu: <package>-decl-list.txt a <package>-decl.txt. První můžete porovnat se souborem s oddíly, pokud je ručně spravován. Ve druhém jsou uvedené všechny deklarace z hlavičkových souborů. Pokud v dokumentaci schází některý symbol, můžete zkontrolovat, jestli se vyskytuje v tomto souboru.
Pokud je základem projektu GObject, můžete se také podívat do souborů vytvořených skenerem objektů: <package>.args.txt, <package>.hierarchy.txt, <package>.interfaces.txt, <package>.prerequisites.txt a <package>.signals.txt. Jestliže v kterémkoliv z nich jsou chybějící symboly, můžete spuštěním GTK_DOC_KEEP_INTERMEDIATE=1 make požádat GTK-Doc, aby přechodně zachovat soubor pro pozdější analýzu.