GenDocCLI.EXE, the Command-Line Documentation Generation Tool

Go Up to Command-Line Utilities Index

GenDocCLI.EXE is the command-line documentation generation tool. GenDocCLI.EXE runs the command-line version of the documentation generation feature from the command interpreter.

Notice the following differences between the applicability of GenDocCLI.EXE and the documentation generation feature integrated into the IDE:

• GenDocCLI.EXE can generate documentation for any Delphi projects, even for projects that do not support UML Modeling. However, GenDocCLI.EXE cannot generate documentation for C++ projects.
• The integrated documentation generation feature can generate documentation for both Delphi and C++ projects. However, this applies only to projects that support UML Modeling.

Command-Line Syntax

To display the command-line help, enter:

GenDocCLI {-h|--help}

To run the stand-alone documentation generation tool from the command interpreter, use the command-line syntax:

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

Command-Line Options

You can use the following command line options:

Option	Description
-h --help	One of these options can be specified to display the short help in the console window.
--without-diagrams	If you specify this option, GenDocCLI.EXE does not insert diagram images into the generated documentation files. By default, it inserts diagram images.
--without-navigation	If you specify this option, GenDocCLI.EXE does not include a navigation tree into the generated documentation. By default, it includes a navigation tree.
-q --quiet	You can use either version of this option. Use this option if you do not want GenDocCLI.EXE to show its service messages in the console window.
CompilerOptions	Specifies some options related to the Delphi compiler (see DCC32.EXE, the Delphi Command Line Compiler.) You can use the following options: -U<paths> -- This option is mandatory! It defines directories in which GenDocCLI.EXE searches for compiled units. The option has the -Upath_1;path_2... format. Here each path_N should specify a directory that can contain Delphi compiled units. For example, -U"C:\Program Files (x86)\Embarcadero\Studio\23.0\lib\win32\debug";C:\MyUnits -I<paths> -- Defines include directories. The option has the -Ipath_1;path_2... format. Here each path_N should specify an include directory. -D<symbols> -- Defines conditional compilation symbols. The option has the -Dsymbol_1;symbol_2... format. Here each symbol_N should specify a conditional compilation symbol. -A<unit>=<alias> -- Defines unit aliases.
-o OutputFolder	OutputFolder specifies the output folder into which GenDocCLI.EXE writes the generated documentation files. If you use a relative path, like .\doc, then this path is relative to the ProjectRootDirectory project root directory specified by the ProjectName.DPROJ option. By default, the ProjectRootDirectory\out\doc subdirectory is accepted. You can optionally use a blank character between -o and OutputFolder.
ProjectName.DPROJ	Specifies the Delphi project file. This file must have the .DPROJ file name extension. It should be created from the IDE. This option is mandatory!

See Also

• Documentation Generation Facility