La documentation pour les options et les restrictions des modules peuvent être entrées dans un ou plusieurs blocs de commentaires. Suit un exemple de bloc documentant la restriction de tuple preferred-period du code source du module preferred.c .
/** @tuple-restriction preferred-period * * <restriction type="preferred-period">period</restriction> * * Cette restriction spécifie la période préférée pour un évènement */
Les balises qui peuvent être utilisées pour documenter les options et les restrictions sont les suivantes :
Utilisée pour les restrictions de tuple (évènement). Doit être suivi par le nom de la restriction, comme définie dans la fonction handler_tup_new() .
Utilisée pour les restrictions de ressource. Doit être suivie par le nom de la restriction, comme définie dans la fonction handler_res_new() .
Utilisée pour les options de module. Doit être suivie par le nom de l'option, comme utilisée dans les fonctions option_find(), option_int() ou option_str() .
Les blocs d'informations sur les options et les restrictions du module n'acceptent aucune balise "mot-clef". Le contenu entier du bloc de commentaire est considéré comme la description de la restriction ou de l'option du module.
Plusieurs paragraphes de texte sont possibles dans ces blocs de commentaires. Des exemples de configuration XML peuvent être insérées dans le texte, sans balise spéciale. N'importe quel paragraphe dont toutes les lignes commencent par des balises XML valides est considéré comme un exemple et est imprimé avec une font "monospace" dans le manuel de référence.
Note: Une restriction ou une option de module est documentée par bloc de commentaires. La balise de bloc dépend du type de restriction.
| Précédent | Sommaire | Suivant |
| Bloc des informations sur le module | Niveau supérieur | Architecture de test |