Écrire de la documentation en utilisant DocBook: Un cours accéléré
Précédent	Chapitre 10. Description de l'interface d'une application	Suivant

10.4. Description d'une API

DocBook possède des moyens plutôt détaillés pour baliser les descriptions de comportement d'une fonction. La balise concernée est <funcsynopsis>. Voici un exemple :

Exemple 10-8. Description d'une fonction dans la bibliothèque C API


<funcsynopsis>
<funcsynopsisinfo>#include <stdlib.h></funcsynopsisinfo>
<funcprototype>
<funcdef>double <function>atof</function></funcdef>
<paramdef>const char *<parameter>nptr</parameter></paramdef>
</funcprototype>
</funcsynopsis>

Qui ressemble à ça :

#include <stdlib.h>

double atof(const char *nptr);

Précédent	Sommaire	Suivant
Éléments de ligne de commande	Niveau supérieur	Diverses balises utiles