GenDocCLI.EXE: Das Befehlszeilentool zur Dokumentationserzeugung

Nach oben zu Befehlszeilenhilfsprogramme - Index

GenDocCLI.EXE ist das Befehlszeilentool für die Dokumentationserzeugung. GenDocCLI.EXE führt die Befehlszeilenversion der Dokumentationserzeugung über den Befehlszeilen-Interpreter aus.

Beachten Sie bitte die folgenden Unterschiede bei der Anwendung von GenDocCLI.EXE und der in der IDE integrierten Funktion zur Dokumentationserzeugung:

• GenDocCLI.EXE kann für alle Delphi-Projekte, sogar für Projekte, die die UML-Modellierung nicht unterstützen, Dokumentationen generieren. GenDocCLI.EXE kann aber keine Dokumentationen für C++-Projekte erzeugen.
• Die integrierte Dokumentationserzeugung kann sowohl für Delphi- als auch für C++-Projekte Dokumentationen erstellen. Jedoch nur für Projekte, die die UML-Modellierung unterstützen.

Befehlszeilensyntax

Um die Hilfe für die Befehlszeile anzuzeigen, geben Sie Folgendes ein:

GenDocCLI {-h|--help}

Um das eigenständige Tool zur Dokumentationserzeugung im Befehlszeilen-Interpreter auszuführen, verwenden Sie die folgende Befehlszeilensyntax:

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

Befehlszeilenoptionen

Die folgenden Befehlszeilenoptionen stehen zur Verfügung:

Option	Beschreibung
-h --help	Wenn Sie eine dieser Optionen angeben, wird die Kurzhilfe im Konsolenfenster angezeigt.
--without-diagrams	Wenn Sie diese Option angeben, fügt GenDocCLI.EXE keine Diagrammbilder in die erzeugten Dokumentationsdateien ein. Standardmäßig werden Diagrammbilder eingefügt.
--without-navigation	Wenn Sie diese Option angeben, fügt GenDocCLI.EXE keine Navigationshierarchie in die erzeugte Dokumentation ein. Standardmäßig wird eine Navigationshierarchie eingefügt.
-q --quiet	Sie können eine der beiden Versionen dieser Option verwenden. Wenn Sie diese Option angeben, zeigt GenDocCLI.EXE keine Dienstmeldungen im Konsolenfenster an.
CompilerOptions	Legt Optionen für den Delphi-Compiler fest (siehe DCC32.EXE: Der Delphi-Befehlszeilen-Compiler). Die folgenden Optionen stehen zur Verfügung: -U<Pfade> – Diese Option muss angegeben werden! Sie legt die Verzeichnisse fest, in denen GenDocCLI.EXE nach compilierten Units sucht. Die Option hat das Format -UPfad_1;Pfad_2.... Jede Pfad_N-Angabe sollte hier ein Verzeichnis angeben, das compilierte Delphi-Units enthalten kann. Zum Beispiel: -U"C:\Program Files (x86)\Embarcadero\Studio\19.0\lib\win32\debug";C:\MyUnits -I<Pfade> – Legt Include-Verzeichnisse fest. Die Option hat das Format -IPfad_1;Pfad_2.... Jede Pfad_N-Angabe sollte hier ein Include-Verzeichnis festlegen. -D<Symbole> – Definiert bedingte Compilierungssymbole. Die Option hat das Format -DSymbol_1;Symbol_2.... Jede Symbol_N-Angabe sollte hier ein bedingtes Compilierungssymbol festlegen. -A<Unit>=<Alias> – Legt Unit-Aliase fest.
-o OutputFolder	OutputFolder gibt den Ausgabeordner an, in dem GenDocCLI.EXE die erzeugten Dokumentationsdateien ablegt. Wenn Sie einen relativen Pfad, wie .\doc, verwenden, dann handelt es sich um den relativen Pfad zum Projektstammverzeichnis ProjectRootDirectory, das in der Option ProjectName.DPROJ angegeben ist. Standardmäßig wird das Unterverzeichnis ProjectRootDirectory\out\doc verwendet. Sie können optional zwischen -o und OutputFolder ein Leerzeichen einfügen.
Projektname.DPROJ	Gibt die Delphi-Projektdatei an. Diese Datei muss die Dateinamenserweiterung .DPROJ besitzen. Sie sollte von der IDE erstellt werden. Diese Option muss angegeben werden!

Siehe auch

• Dokumentationserzeugung