AdeliaDoc est un outil permettant de générer de la documentation technique associée aux programmes Adélia, à partir de l'analyse des sources L4G et de l'exploitation des informations de description des programmes.
La documentation produite est standardisée et permet de décrire les programmes, leurs procédures publiques, et les paramètres d'appel de chacune de ces entités.
Un jeu d'annotations spécifiques, sous forme de commentaire à ajouter dans le source L4G, offre par ailleurs la possibilité aux développeurs de personnaliser le contenu de la documentation générée. Ce système permet ainsi de conserver au même endroit le code source et les éléments de la documentation qui lui sont associés.
En se basant sur la notion de "projet de documentation", AdeliaDoc permet de produire différents supports de documentation à partir d'un même environnement Adélia. Chaque projet dispose de son propre paramétrage.
AdeliaDoc est destiné à documenter les programmes de type Adelia (batch, interactif), Visual Adelia (batch, serveur et interactif), Event (batch) et les classes référencées en tant que paramètres d'appel de ces derniers, et ce aussi bien au niveau d'un référentiel Adélia complet, qu'au niveau domaine (ou liste de domaines), composants de build (ou liste de composants de build), voire pour un jeu de programmes donné.
Pour leurs part, les sources des programmes de tests unitaires et des Services Web REST et SOAP sont exclus du périmètre, en sachant que, pour ces derniers, un support de documentation adapté est déjà disponible via Swagger (REST) ou, pour SOAP, via le WSDL.
A chaque fois il est possible d'appliquer des filtres utilisateurs complémentaires afin d'affiner la liste des programmes pour lesquels la documentation sera générée.
De même, grâce aux paramètres de configuration, il est possible de modifier certaines règles de génération afin de prendre en compte des besoins spécifiques.
En s'appuyant sur l'outil de génération de documentation Sphinx, AdeliaDoc permet, au choix, de produire de la documentation aux formats HTML, Latex, PDF, Texte brut et reStructuredText (langage de markup).
Sphinx est par ailleurs un outil paramétrable, offrant de nombreuses possibilités de personnalisation de la documentation produite.
Il est important de noter qu'AdeliaDoc fonctionne en mode incrémental, ce qui signifie que d'une génération de documentation à l'autre, seules les pages de documentation pour lesquelles les programmes source correspondants (et/ou leurs dépendances) ont changé, sont regénérées.
Enfin, même si il n'est pas possible en tant que tel de produire une documentation multilingue, AdeliaDoc permet néanmoins de localiser la documentation générée dans plus de 50 langues différentes.
