Running Documentation Generation from the Command Line

From RAD Studio
Jump to: navigation, search

Go Up to Documentation Generation Procedures

You can run GenDocCLI.EXE from the command line to generate HTML-format documentation on modeling projects. GenDocCLI.EXE can run in two modes:

  • Showing help
  • Generating documentation

Showing the help in the console window

  1. To start the command interpreter, click Startand then click Run. In the Run dialog box, type cmd in the Open field and click OK. The command interpreter opens.
  2. At the command prompt in the command interpreter, change to the \bin subdirectory of your RAD Studio installation. For example, you can execute the following command:
    cd "C:\Program Files (x86)\Embarcadero\Studio\20.0\bin"
  1. Execute one of the following command lines:
 GenDocCLI -h
 GenDocCLI --help
The short instructions on usage of GenDocCLI.EXE appear in the console window.

Generating documentation on a modeling project

  1. Start the command interpreter.
  2. Run the documentation generation tool by invoking, at the command prompt, the GenDocCLI.EXE application. To do this, execute a command line like this:
GenDocCLI <options>
For descriptions of options that you can use, see the GenDocCLI.EXE, the Command Line Documentation Generation Tool section of Documentation Generation Facility.

Example

The following example demonstrates running documentation generation from the command line:

GenDocCLI.exe --without-diagrams --without-navigation -q^
 -U"C:\Program Files (x86)\Embarcadero\Studio\20.0\lib\release"^
 -I"C:\Program Files (x86)\Embarcadero\Studio\20.0\lib";"C:\Program Files (x86)\Embarcadero\Studio\20.0\include"^
 -DDEBUG;DEVELOPERS;^ 
 -o "C:\Users\<user>\Documents\Embarcadero\Studio\Projects\p1\out\Doc"^
 "C:\Users\<user>\Documents\Embarcadero\Studio\Projects\p1\Project1.dproj"

Command-line options

This example demonstrates the usage of the following options:

  • --without-diagrams -- defines that GenDocCLI.EXE will not insert diagram images into the generated HTML-format documentation files.
  • --without-navigation -- defines that GenDocCLI.EXE will not include a navigation tree into the generated documentation files.
  • -q -- defines that GenDocCLI.EXE will not show its service messages in the console window.
  • -U -- defines that GenDocCLI.EXE will search for compiled units in the C:\Program Files (x86)\Embarcadero\Studio\20.0\lib\release folder.
  • -I -- defines that GenDocCLI.exe will use the C:\Program Files (x86)\Embarcadero\Studio\20.0\lib and C:\Program Files (x86)\Embarcadero\Studio\20.0\include include directories.
  • -D -- defines that GenDocCLI.exe will use the DEBUG and DEVELOPERS conditional compilation symbols.
  • -o -- defines that GenDocCLI.exe will save the generated HTML and other documentation files in the C:\Users\<user>\Documents\Embarcadero\Studio\Projects\p1\out\Doc subdirectory. Notice that you can optionally use a blank character between -o and the specified path.
  • The Project1.dproj file should be the Delphi project file whose source code and UML model are to be documented. If the specified Delphi project does not support Modeling, then GenDocCLI.exe will analyze the project sources and automatically generate all required class diagrams.

See Also