Rule

exclude_annotations

Rrègle d'exclusion à appliquer à certaines annotations saisies dans le source L4G

date_annotation

Règle d'interprétation de l'annotation *@date

index_procedure

Règle de génération des index pour une section procédure

index_generation

Règle de génération des entrées d'index

default_filter

Définition d'un filtre par défaut

Substitution

@desription

Règle de substitution à appliquer à l'annotation *@description

@date

Règle de substitution à appliquer à l'annotation *@date

@version

Règle de substitution à appliquer à l'annotation *@version

@author

Règle de substitution à appliquer à l'annotation *@author  

Localisation

date_sep

Paramétrage du séparateur de date

date_format

Paramétrage du format de date

Liste des annotations (séparées par le caractère ";") à exclure de la documentation, même si celles-ci sont explicitement présentes dans un source L4G (programme/procédure).
Par exemple, dans le cas d'une documentation destinée au grand public, ce paramètre peut être utilisé afin de ne pas faire figurer le nom des concepteurs dans la documentation générée, le tout sans rien changer au code source des programmes.

• Pour les programmes et procédures : toutes les annotations supportées, à l'exception de *@adeliadoc , *@param et *@field
• Pour les classes : s'applique aux métadonnées correspondant aux annotations *@description , *@date , *@version , *@index et *@author

Vide (i.e. aucune exclusion)

exclude_annotations = *@author;*@since

Dans le cas où l'annotation *@date est présente et valorisée, ce paramètre permet de forcer la manière dont cette annotation est exploitée par le générateur.
Le but étant de forcer la substitution de la date annotée, par la métadonnée correspondante stockée en base de données (c'est-à-dire la date de dernière modification d'un programme telle que définie dans les informations du programme).

• meta : métadonnée forcée
• default : comportement par défaut : la valeur associée à l'annotation est utilisée, ou bien application de la règle de substitution définie.

default

date_annotation = meta

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 index_generation est positionné à entity, mixed ou cumulative et que la procédure ne contient pas d'annotation *@index .
Dans cette configuration, ce paramètre permet de déterminer si l'index doit être défini de manière hiérarchique (par rapport à son programme), ou faire l'objet d'une entrée propre.

• subentry : l'index de la procédure est défini de manière hiérarchique par rapport à son programme (sous-entrée). La hiérarchie est représentée sous la forme 'nom programme/nom procédure'

• entry : la procédure dispose de sa propre entrée d'index, qui porte le nom de la procédure

subentry

index_procedure = entry

Permet de piloter la génération de l'index de la documentation, en lien avec l'annotation *@index .
En fonction de la valeur de ce paramètre, il est possible d'indiquer à AdeliaDoc :

• soit de ne pas générer de page d'index,
• soit de générer et constituer la page d'index en se basant sur l'annotation *@index ,
• soit encore de générer et constituer automatiquement la page d'index en se basant sur le nom des sections (i.e. programme/procédure).

• annotation : l'index est constitué exclusivement à partir des annotations *@index .

  • Les entités ne disposant pas d'annotation *@index ne figurent donc pas dans la page index.

  • Dans le cas où l'annotation est présente mais non valorisée, c'est le nom de la section qui est utilisé comme code index.

• entity : même si les annotations *@index sont renseignées, l'index est constitué automatiquement en se basant sur le nom des sections. Toutes les sections figurent de facto dans la page index.
• mixed : l'index est constitué à partir des annotations *@index , ou en se basant sur le nom des sections dans le cas où *@index n'est pas renseigné. Toutes les entités figurent de facto dans la page index.
• cumulative : entrées d'index multiples, cumulant à la fois le nom de la section correspondante et les annotations *@index (si présentes).
• none : la page d'index n'est pas générée.

mixed

index_generation = cumulative

Permet de configurer le comportement du générateur de documentation lorsque AdeliaDoc est lancé sans que le paramètre de ligne de commande filter n'ait été renseigné.

Dans ce cas de figure, ce paramètre permet de forcer un filtre implicite.
Si le paramètre de lancement filter est renseigné et valide, ce paramètre de configuration est ignoré.

Les valeurs possible sont mêmes que celles du paramètre de ligne de commande filter .

Aucun filtre : toute les sections sont générées, sans tenir compte de la présence et du contenu de l'annotation *@adeliadoc .

default_filter = *NONE

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.

• empty : la substitution par la métadonnée s'opère uniquement lorsque l'annotation est présente mais non valorisée.
• default : la substitution par la métadonnée s'opère lorsque l'annotation est absente ou non valorisée.

default

*@date = empty

*@author = default

Valeur définie au niveau des options régionales de la session Windows®.

date_sep = | 

• DMY : jour, mois, année
• MDY : mois, jour, année
• YDM : année, mois, jour

Valeur définie au niveau des options régionales de la session Windows®.

date_format = MDY