Contrôle du résultat

Une exécution de GTK-Doc produit des fichiers de compte-rendu dans le répertoire de documentation. Ces fichiers sont nommés : <package>-undocumented.txt, <package>-undeclared.txt et <package>-unused.txt. Tous ces fichiers texte peuvent être lus et post-traités facilement.

Le fichier <package>-undocumented.txt commence avec un résumé du sujet couvert par la documentation. Suivent deux sections séparées par des lignes blanches. La première section liste les symboles non documentés ou incomplets. La seconde section fait de même pour les documentations de sections. Les éléments incomplets sont ceux qui possèdent une documentation mais auxquels, par exemple, un paramètre a été ajouté.

Le fichier <package>-undeclared.txt liste les symboles contenus dans le fichier <package>-sections.txt mais non trouvés dans les fichiers sources. Vérifiez s'ils n'ont pas été supprimés ou mal orthographiés.

Le fichier <package>-unused.txt liste les noms des symboles pour lesquels l'analyseur GTK-Doc a trouvé de la documentation mais ne sait pas où la placer. Cela signifie que le symbole n'a pas encore été ajouté au fichier <package>-sections.txt.

Activez ou ajoutez la ligne TESTS=($GTKDOC_CHECK) dans le fichier Makefile.am. Si la version installée de GTK-Doc est supérieure à 1.9, des contrôles de validité seront lancés pendant l'exécution de make check.

Vous pouvez également regarder les fichiers produits par le scanneur de code source : <package>-decl-list.txt et <package>-decl.txt. Le premier peut être comparé avec le fichier section s'il est maintenu manuellement. Le second liste toutes les déclarations contenues dans les fichiers en-tête. Si un symbole est manquant, il faut vérifier si ce fichier le contient.

Si le projet est basé sur GObject, il est possible de regarder dans les fichiersgénérés par le scanneur d'objet : <package>.args.txt, <package>.hierarchy.txt, <package>.interfaces.txt, <package>.prerequisites.txt et <package>.signals.txt. S'il manque des symboles dans l'un d'eux, il est possible de demander à gtkdoc de conserver le fichier de scanneur intermédiaire pour en faire une analyse ultérieure mais en le lançant comme GTK_DOC_KEEP_INTERMEDIATE=1 make.