Bloc des informations sur le module

Suit un exemple de bloc d'informations de module, du code source de preferred.c . Chaque module peut inclure au plus un bloc d'informations sur le module.

/** @module
 *
 * @author Tomaz Solc  
 * @author-email tomaz.solc@tablix.org
 *
 * @credits 
 * Idées prises d'un patch pour Tablix 0.0.3 par 
 * Jaume Obrador <obrador@espaiweb.net>
 *
 * Porté à la version 0.2.0 et étendu par Nick Robinson <npr@bottlehall.co.uk>
 *
 * @brief Ajoute un poids à chaque fois qu'un évènement n'est pas programmé au jour 
 * et/ou au créneau préféré(s).
 *
 * @ingroup General
 */

Le bloc d'information du module utilise la balise @module . Cette balise ne prend aucun argument. Il n'est donc pas nécessaire de mettre du texte entre cette balise et la première balise "mot-clef" (keyword). Les balises "mot-clef" suivantes sont possibles dans ce type de bloc (Aucune n'est obligatoire. Au plus, une seule de chaque type, sauf précision contraire).

@author

Le nom de l'auteur ou de celui qui maintient le module.

@author-email

Email de l'auteur ou de celui qui maintient le module.

@credits

Dans le cas où plusieurs auteurs ont contribués au module, vous pouvez utiliser cette balise pour les remerciements. Supporte plusieurs paragraphes de texte.

@brief

Description de la fonctionnalité du module. Supporte plusieurs paragraphes de texte.

@ingroup

Definit les groupes de modules auxquels ce module appartient. Les groupes doivent être séparés par des virgules.