Controlando o resultado
Uma execução do GTK-Doc gera arquivos de relatórios dentro do diretório de documentação. Os arquivos gerados são chamados: <pacote>-undocumented.txt, <pacote>-undeclared.txt e <pacote>-unused.txt. Todos eles são arquivos texto simples que podem ser facilmente visualizados e pós-processados.
O arquivo <pacote>-undocumented.txt começa com um sumário de cobertura da documentação. Abaixo estão duas seções divididas por linhas brancas. A primeira seção lista símbolos não documentados e incompletos. A segunda seção faz o mesmo para os documentos de seção. Entradas incompletas são aquelas que foram documentadas, mas nas quais, por exemplo, um novo parâmetro foi adicionado.
O arquivo <pacote>-undeclared.txt lista símbolos dados no <pacote>-sections.txt, mas não encontrados nos fontes. Verifique se eles foram removidos ou se eles foram escritos incorretamente.
O arquivo <pacote>-unused.txt lista nomes de símbolo cuja documentação foi localizada na varredura do GTK-Doc, mas que não sabe onde colocá-los. Isso significa que o símbolo não foi adicionado ainda ao arquivo <pacote>-sections.txt.
Habilite ou adicione a linha TESTS=$(GTKDOC_CHECK) no Makefile.am. Se pelo menos GTK-Doc 1.9 estiver instalado, isso vai executar verificações de sanidade durante a execução de make check.
Também pode-se buscar nos arquivos produzidos pela varredura do código aberto: <pacote>-decl-list.txt e <pacote>-decl.txt. O primeiro pode ser comparado com o arquivo de seção, se ele for mantido manualmente. O segundo lista todas as declarações de cabeçalhos. Se um símbolo está faltando, pode-se verificar se este arquivo o contém.
Se o projeto é baseado em GObject, pode-se também procurar nos arquivos produzidos pela varredura de objetos: <pacote>.args.txt, <pacote>.hierarchy.txt, <pacote>.interfaces.txt, <pacote>.prerequisites.txt e <pacote>.signals.txt. Se há símbolos faltando em qualquer um deles, pode-se exigir que o GTK-Doc mantenha o arquivo intermediário de varredura para análise posterior, executando GTK_DOC_KEEP_INTERMEDIATE=1 make.