Génération de la documentation

Remonter à Concepts de modélisation

La fonctionnalité de génération de la documentation de la modélisation génère automatiquement la documentation pour vos projets de modélisation UML. Utilisez cette fonctionnalité pour illustrer vos programmes avec une documentation au format HTML. Vous pouvez mettre à jour cette documentation générée automatiquement quand votre projet est modifié, ou modifier cette documentation manuellement plus tard.

Fichiers de la documentation

Tous les fichiers de la documentation générée sont écrits dans un répertoire de documentation unique que vous spécifiez dans le dossier Sortie de la boîte de dialogue Générer la documentation. Par défaut, la documentation générée s'ouvre dans votre navigateur web. Si vous choisissez de ne pas ouvrir la documentation immédiatement, vous pourrez l'ouvrir par la suite en utilisant le fichier INDEX.HTML du répertoire de documentation spécifié.

Cadres de la documentation HTML

La documentation HTML comporte les cadres suivants :

• Le cadre Diagramme, quand l'option Inclure les diagrammes est activée.
• Les cadres Projet et Vue globale, quand l'option Inclure l'arborescence de navigation est activée.
• Les cadres Liste des packages et Vue globale des packages, quand l'option Inclure l'arborescence de navigation est désactivée.
• Le Cadre Documentation

Vous pouvez cliquer sur l'onglet Projet gauche et développer les noeuds de l'arborescence de la vue projet. Notez qu'un clic sur un nom de classe dans l'onglet Projet ouvre la documentation dans le volet Documentation. Quand vous sélectionnez un diagramme dans l'onglet Projet, il s'ouvre dans le cadre Diagramme. Les éléments du cadre Diagramme sont hyperliés au cadre Documentation. Si vous sélectionnez un élément dans le cadre Diagramme, son contenu est affiché dans le cadre Documentation.

Le cadre Documentation affiche la documentation de votre code source et de vos diagrammes, et il inclut tout ce dont vous pourriez avoir besoin lors de la génération de la documentation HTML. La partie supérieure du cadre Documentation contient une barre de navigation vous permettant de parcourir la documentation de votre projet.

L'onglet Projet contient une représentation arborescente du projet. Développez les noeuds pour afficher les diagrammes et les éléments individuels. Cliquer sur une classe ou une interface ouvre la documentation associée dans le cadre Documentation.

GenDocCLI.EXE, l'outil de génération de la documentation en ligne de commande

GenDocCLI.EXE est l'outil de génération de la documentation en ligne de commande. GenDocCLI.EXE exécute la version ligne de commande de la fonctionnalité de génération de la documentation depuis l'interpréteur de commandes.

Notez les différences suivantes entre l'applicabilité de GenDocCLI.EXE et de la fonctionnalité de génération de la documentation intégrée dans l'EDI :

• GenDocCLI.EXE peut générer la documentation de projets Delphi, même pour les projets qui ne supportent pas la modélisation UML. Toutefois, GenDocCLI.EXE ne peut pas générer la documentation des projets C++.
• La fonctionnalité intégrée de génération de la documentation peut générer la documentation des projets Delphi et C++. Toutefois, elle s'applique seulement aux projets qui supportent la modélisation UML.

Syntaxe de ligne de commande

Pour afficher l'aide de la ligne de commande, entrez :

GenDocCLI {-h|--help}

Pour exécuter l'outil autonome de génération de la documentation depuis l'interpréteur de commandes, utilisez la syntaxe de ligne de commande suivante :

GenDocCLI  [--without-diagrams] [--without-navigation] [{-q|--quiet}]^
 CompilerOptions [-o OutputFolder] ProjectName.DPROJ 

Options de la ligne de commande

Vous pouvez utiliser les options de ligne de commande suivantes :

Option	Description
-h --help	Une de ces options peut être spécifiée pour afficher l'aide courte dans la fenêtre console.
--without-diagrams	Si vous spécifiez cette option, GenDocCLI.EXE n'insère pas les images des diagrammes dans les fichiers de documentation générés. Par défaut, il insère les images des diagrammes.
--without-navigation	Si vous spécifiez cette option, GenDocCLI.EXE n'inclut pas une arborescence de navigation dans la documentation générée. Par défaut, il inclut une arborescence de navigation.
-q --quiet	Vous pouvez utiliser l'une de ces deux versions. Utilisez cette option si vous ne voulez pas que GenDocCLI.EXE affiche ses messages de service dans la fenêtre console.
CompilerOptions	Spécifie des options associées au compilateur Delphi (voir DCC32.EXE, le compilateur en ligne de commande Delphi.) Vous pouvez utiliser les options suivantes : -U<chemins> -- Cette option est obligatoire ! Elle définit les répertoires dans lesquels GenDocCLI.EXE recherchera les unités compilées. L'option a le format -Uchemin_1;chemin_2.... Chaque chemin_N doit spécifier un répertoire qui peut contenir des unités compilées Delphi. Par exemple, -U"c:\RAD Studio\8.0\lib\win32\debug";C:\MyUnits . -I<chemins> -- Définit les répertoires d'inclusion. L'option a le format -Ichemin_1;chemin_2.... Chaque chemin_N doit spécifier un répertoire d'inclusion. -D<symboles> -- Définit les symboles de compilation conditionnelle.  : : L'option a le format -Dsymbole_1;symbole_2.... Chaque symbole_N doit spécifier un symbole de compilation conditionnelle. -A<unit>=<alias> -- Définit les alias d'unités.
-o OutputFolder	OutputFolder spécifie le dossier de sortie dans lequel GenDocCLI.EXE écrira les fichiers de la documentation générée. Si vous utilisez un chemin relatif, tel que .\doc, ce chemin est relatif au répertoire racine du projet ProjectRootDirectory spécifié par l'option ProjectName.DPROJ. Par défaut, le sous-répertoire ProjectRootDirectory\out\doc est accepté. Vous pouvez utiliser facultativement un caractère espace entre -o et OutputFolder
ProjectName.DPROJ	Spécifie le fichier projet Delphi. Ce fichier doit avoir l'extension de nom de fichier .DPROJ. Il doit être créé depuis l'EDI. Cette option est obligatoire !

Voir aussi

• Génération de la documentation d'un projet
• Configuration de la génération de la documentation
• Exécution de la génération de la documentation depuis la ligne de commande