Lors de la création d'un projet AdeliaDoc, un fichier de configuration, "adeliadoc.ini", est automatiquement généré à la racine du projet.
Ce fichier contient un certain nombre de paramètres destinés, principalement, à la personnalisation des règles de génération par défaut appliquées par AdeliaDoc pour produire la documentation.
Ces règles portent en grande partie sur la façon dont AdeliaDoc est amené à exploiter les annotations ajoutées par les développeurs dans les sources L4G.
Ainsi, et selon vos impératifs, en ajustant ces paramètres de configuration, il est possible, projet par projet, de personnaliser la manière dont la documentation sera générée.
Remarques
A sa création, le fichier de configuration est initialisé avec l'ensemble des sections et des paramètres supportés par AdeliaDoc.
En standard, aucune valeur n'est affectée à ces paramètres, ce qui correspond au comportement par défaut tel que décrit dans la suite (voir les tableaux descriptifs ci-dessous).
Lorsque la valeur saisie pour un paramètre est invalide, c'est la valeur par défaut qui s'applique.
Le fichier de configuration est encodé en UTF-8 sans BOM.
En cas de modification, veillez à respecter cet encodage en utilisant un éditeur de texte adapté.
Tableau synthétique des paramètres de configuration
Le fichier de configuration AdeliaDoc respecte le formalisme standard d'un fichier Windows® de type .INI.
Section | Paramètre | Rôle |
---|---|---|
Rrègle d'exclusion à appliquer à certaines annotations saisies dans le source L4G | ||
Règle d'interprétation de l'annotation | ||
Règle de génération des index pour une section procédure | ||
Règle de génération des entrées d'index | ||
Définition d'un filtre par défaut | ||
Règle de substitution à appliquer à l'annotation | ||
Règle de substitution à appliquer à l'annotation | ||
Règle de substitution à appliquer à l'annotation | ||
Règle de substitution à appliquer à l'annotation | ||
Paramétrage du séparateur de date | ||
Paramétrage du format de date |
Description détaillée
Section Rules
Cette section comprend les paramètres permettant de configurer les principales règles de génération de la documentation
Paramètre exclude_annotations
Description | Liste des annotations (séparées par le caractère " |
---|---|
Valeurs possibles |
|
Valeur par défaut | Vide (i.e. aucune exclusion) |
Exemple |
|
Paramètre date_annotation
Description | Dans le cas où l'annotation |
---|---|
Valeurs possibles |
|
Valeur par défaut |
|
Exemple |
|
Paramètre index_procedure
Description | Permet de piloter la manière dont l'index d'une section procédure est généré dans le cas où le paramètre |
---|---|
Valeurs possibles |
|
Valeur par défaut |
|
Exemple |
|
Paramètre index_generation
Description | Permet de piloter la génération de l'index de la documentation, en lien avec l'annotation
|
---|---|
Valeurs possibles |
|
Valeur par défaut |
|
Exemple |
|
Paramètre default_filter
Description | Permet de configurer le comportement du générateur de documentation lorsque AdeliaDoc est lancé sans que le paramètre de ligne de commande Dans ce cas de figure, ce paramètre permet de forcer un filtre implicite. |
---|---|
Valeurs possibles | Les valeurs possible sont mêmes que celles du paramètre de ligne de commande |
Valeur par défaut | Aucun filtre : toute les sections sont générées, sans tenir compte de la présence et du contenu de l'annotation |
Exemple |
|
Section Substitution
Cette section permet de configurer les règles de substitution à appliquer pour les annotations non renseignées ou non valorisées, ce qui offre la possibilité d'établir des standards d'utilisation de ces annotations.
Elle comprend un paramètre par annotation concernée par les règles de substitution, à savoir :
- @description pour l'annotation
*@description
- @date pour l'annotation
*@date
- @version pour l'annotation
*@version
- @author pour l'annotation
*@author
Le tableau descriptif suivant s'applique indifféremment à l'ensemble des paramètres de cette section.
Règles de substitution
Description | Permet de définir la manière dont la substitution par la métadonnée correspondante s'opère lorsque l'annotation en question n'est pas présente, ou pas valorisée. |
---|---|
Valeurs possibles |
|
Valeur par défaut |
|
Remarque | Les métadonnées sont issues des informations du programme telles qu'elles sont stockées en base de données. |
exemples |
|
Section Localisation
Cette section regroupe l'ensemble des paramètres relatifs à la personnalisation des options régionales.
Paramètre date_sep
Description | Séparateur de date à utiliser |
---|---|
Valeurs possibles | Un seul caractère, au choix. |
Valeur par défaut | Valeur définie au niveau des options régionales de la session Windows®. |
Exemple |
|
Paramètre date_format
Description | Format de restitution de la date, pour les dates issues des métadonnées stockées en base |
---|---|
Valeurs possibles |
|
Valeur par défaut | Valeur définie au niveau des options régionales de la session Windows®. |
Exemple |
|