Gtk-doc
- Gtk-doc
-
GTK-Doc est utilisé pour documenter du code C. Il est typiquement utilisé pour documenter les API publiques de bibliothèques, comme les bibliothèques GTK+ et GNOME. Mais il peut aussi être utilisé pour documenter du code d'application. GTK-Doc est un logiciel libre.
Fonctionnement de GTK-Doc
GTK-Doc fonctionne 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 que GTK-Doc utilise (notez cependant que GTK-Doc ne documente que les fonctions déclarées dans des fichiers d'en-tête ; il ne fait rien pour les fonctions statiques).
Exemple
Voici un morceau de code à documenter :
#include <stdio.h>
/*
* commentaire simple ne provoquant aucune documentation
* car il y a une seule étoile après le slash
*/
void affichage(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
*/
void affichage(char *phrase)
{
fprintf(stdin, "%s", phrase);
}
main()
{
affichage("hello, world\n");
}
Ceci permettra de documenter son code à la manière de la Glib ou Gtk+ dont on peut voir un exemple ici.
Voir aussi
Liens externes
Catégories :
- Logiciel libre sous licence GPL
- Outil de développement logiciel
Wikimedia Foundation.
2010.
Contenu soumis à la licence CC-BY-SA. Source : Article Gtk-doc de Wikipédia en français (auteurs)
Regardez d'autres dictionnaires:
Gtk-gnutella — Infobox Software name = gtk gnutella caption = gtk gnutella 0.96.4 in ultrapeer mode. developer = Raphael Manfredi, Richard Eckart released = 2000 04 16 frequently updated = yes programming language = C operating system = Cross platform language … Wikipedia
Devhelp — Тип просмотр документации Разработчик Mikael Hallendal Операционная система … Википедия
Devhelp — Developer(s) Mikael Hallendal Stable release 3.0.0 (April 4, 2011; 7 months ago (2011 04 04) [ … Wikipedia
Sven Neumann — is credited with keeping the GIMP software project going for many years. His [http://svenfoo.geekheim.de/index.php/about/ weblog says] : Since I am a GIMP hacker, there will be quite a bit of GIMP talk here. But it’s my blog, so I reclaim the… … Wikipedia
PackageKit — Infobox Software name = PackageKit caption = gnome packagekit , a front end for PackageKit, running on Fedora collapsible = author = developer = Richard Hughes released = latest release version = 0.3.3 latest release date = release date and… … Wikipedia
Comparison of Tryton and Open ERP — Tryton is a community fork of the commercial open source project OpenERP and began development in November 2008. This article compares both projects from technical, business and conceptual perspectives. Subject Tryton OpenERP Language Python… … Wikipedia
GObject — The GLib Object System, or GObject, is a free software library (covered by the LGPL) that provides a portable object system and transparent cross language interoperability. GObject is designed for use both directly in C programs and through… … Wikipedia
GDK — (GIMP Drawing Kit) is a computer graphics library that acts as a wrapper around the low level drawing and windowing functions provided by the underlying graphics system. Originally developed on the X Window System, GDK lies between the X server… … Wikipedia
Debian — GNU/Linux 6.0 ( Squeeze ) with GNOME Company / developer … Wikipedia
GNOME — infobox software name = GNOME caption = A GNOME 2.24 desktop developer = The GNOME Project latest release version = 2.24.0 latest release date = release date|mf=yes|2008|09|24 operating system = Cross platform genre = Desktop environment language … Wikipedia
