Documentation du code
GTK-Doc utilise les commentaires du code source, avec une syntaxe spéciale pour la documentation du code. En outre, il récupère des informations sur la structure de votre projet à partir d'autres sources. La section suivante vous donne toutes les informations concernant la syntaxe des commentaires.
Par le passé, la plupart de la documentation devait être placé dans des fichiers dans le répertoire tmpl. Les inconvénients étaient que l'information n'était pas souvent mise à jour et que ces fichiers avaient tendance à provoquer des conflits avec les systèmes de gestion de versions.
Pour éviter ces problèmes, il est conseillé de placer la documentation dans le code source. Ce manuel ne décrit que cette manière de documenter du code.
L'analyse peut prendre en charge de manière correcte la majorité des en-têtes C. Au cours de l'analyse, en cas d'apparition d'avertissements qui ont l'air d'être des cas spéciaux, vous pouvez indiquer à GTK-Doc de les passer.
#ifndef __GTK_DOC_IGNORE__ /* unparseable code here */ #endif
- III.I. Commentaires de documentation
- III.II. Documentation des sections
- III.III. Documentation des symboles
- III.IV. Balises DocBook utiles