Controlar el resultado
Una ejecución de GTK-Doc genera archivos de informe dentro del directorio de la documentación. Los archivos generados se llaman <paquete>-undocumented.txt, <paquete>-undeclared.txt y <paquete>-unused.txt.Todos son archivos de texto plano y se pueden ver y posprocesar fácilmente.
El archivo <package>-undocumented.txt comienza con el resumen de cobertura de la documentación. Debajo hay dos secciones divididas por líneas vacías. La primera sección lista los símbolos incompletos o indocumentados. La segunda sección hace lo mismo para los documentos de sección. Las entradas incompletas son aquellas que tienen documentación pero dónde; p.e. se ha añadido un parámetro nuevo.
El archivo <package>-undeclared.txt lista símbolos proporcionados en el archivo <package>-sections.txt, pero no encontrados en los fuentes. Compruebe si se han eliminado o no se han escrito correctamente.
El archivo <package>-unused.txt lista nombres de símbolos, donde el analizador de GTK-Doc ha encontrado documentación, pero no sabe dónde ponerla. Esto significa que el símbolo no se ha añadido todavía al archivo <package>-sections.txt.
Activar o añadir la línea TESTS=($GTKDOC_CHECK) en Makefile.am. Si como mínimo está instalado GTK-Doc 1.9, esto ejecutará comprobaciones de integridad durante la ejecución de make check.
También puede mirar los archivos producidos por el analizador del código fuente: <paquete>-decl-list.txt y <paquete>-decl.txt. El primero se puede comparar con el archivo de sección si se mantiene manualmente. El segundo lista todas las declaraciones desde las cabeceras. Si falta un símbolo, se puede comprobar si este archivo lo contiene.
Si el proyecto está basado en GObject, también se puede mirar en los archivos producidos por el analizador de objetos: <paquete>.args.txt, <paquete>.hierarchy.txt, <paquete>.interfaces.txt, <paquete>.prerequisites.txt y <paquete>.signals.txt. Si faltan símbolos en cualquiera de ellos, puede hacer que gtkdoc guarde el análisis de archivos para futuros análisis, pero ejecutándolo como GTK_DOC_KEEP_INTERMEDIATE=1 make.