GTK-Doc
| Développé par | L'équipe GTK+ et de nombreux contributeurs |
|---|---|
| Dépôt | gitlab.gnome.org/GNOME/gtk-doc |
| Écrit en | Python |
| Environnement | Multiplate-forme |
| Type | Bibliothèque logicielle |
| Licence | GNU LGPL 2.1 |
| Site web | GTK-Doc |
GTK-Docest unlogiciel libregénérant de la documentation à partir decode sourceenLangage C.Il est typiquement utilisé pour documenter lesAPIpubliques debibliothèques,telles que celles utilisées par lesframeworksGTK+etGNOME.Mais il peut aussi être utilisé pour documenter du code d'application.
Fonctionnement deGTK-Doc
[modifier|modifier le code]GTK-Docfonctionne en utilisant la documentation de fonctions placées dans le code source sous la forme de blocs de commentaires avec un formatage spécifique ou la documentation ajoutée aux fichiers prototypes queGTK-Docutilise (notez cependant queGTK-Docne documente que les fonctions déclarées dans des fichiers d'en-tête; il ne fait rien pour les fonctions statiques).
Exemple
[modifier|modifier le code]Voici un morceau de code à documenter:
#include<stdio.h>
/*
* Commentaire simple ne générant aucune documentation
* car il n'y a qu'une seule étoile après le slash
*/
voidaffichage(char*phrase)
{
fprintf(stdin,"%s",phrase);
}
main()
{
affichage("hello, world\n");
}
La documentation se fait donc par les commentaires et est initiée par les symboles/**au lieu d'un simple/*
#include<stdio.h>
/**
* affichage:
* La fonction affichage() permet l'extraordinaire exploit
* d'afficher une phrase qui est passée dans l'argument @phrase.
*
* Returns: La fonction ne renvoie aucune valeur
*/
voidaffichage(char*phrase)
{
fprintf(stdin,"%s",phrase);
}
main()
{
affichage("hello, world\n");
}
Ceci permettra de documenter son code à la manière de laGlibouGtk+dont on peut voir un exempleici.
