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

Remonter à Utilitaires de ligne de commande - Index

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 prennent pas en charge 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 prennent en charge la modélisation UML.

Syntaxe de la 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 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 l'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:\Program Files (x86)\Embarcadero\Studio\21.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 des symboles conditionnels de compilation. L'option a le format -Dsymbole_1;symbole_2.... Chaque symbole_N doit spécifier un symbole conditionnel de compilation. -A<unité>=<alias> -- Définit les alias de l'unité.
-o OutputFolder	OutputFolder spécifie le dossier de sortie dans lequel GenDocCLI.EXE écrit 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 de 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

• Fonctionnalité de génération de la documentation