GenDocCLI.EXE - コマンドライン ドキュメント生成ツール

提供: RAD Studio
移動先: 案内検索

コマンドライン ユーティリティ:インデックス への移動


GenDocCLI.EXE は、コマンドラインのドキュメント生成ツールです。GenDocCLI.EXE は、コマンドライン バージョンのドキュメント生成機能をコマンド インタープリタから実行します。

GenDocCLI.EXE と IDE に統合されているドキュメント生成機能では、適用できる対象に次の相違があることに注意してください。

  • GenDocCLI.EXE は、UML モデリングをサポートしないプロジェクトを含む、すべての Delphi プロジェクトのドキュメントを生成できます。ただし GenDocCLI.EXE は、C++ プロジェクトのドキュメントを生成することはできません。
  • 統合ドキュメント生成機能は、Delphi プロジェクトのドキュメントも、C++ プロジェクトのドキュメントも生成できます。ただし、UML モデリングをサポートするプロジェクトに限られます。

コマンドライン構文

コマンドライン ヘルプを表示するには、次のように入力します。

GenDocCLI {-h|--help}

スタンドアロンのドキュメント生成ツールをコマンド インタープリタから実行するには、次のコマンドライン構文を使用します。

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

コマンドライン オプション

次のコマンドライン オプションを指定することができます。

オプション 説明

-h
--help

このオプションのいずれかを指定すると、簡単なヘルプがコンソール ウィンドウに表示されます。

--without-diagrams

このオプションを指定すると、GenDocCLI.EXE は生成するドキュメント ファイルにダイアグラムの画像を挿入しません。デフォルトでは、ダイアグラムの画像を挿入します。

--without-navigation

このオプションを指定すると、GenDocCLI.EXE は生成するドキュメントにナビゲーション ツリーを含めません。デフォルトでは、ナビゲーション ツリーを含めます。

-q
--quiet

このオプションは、どちらのバージョンも使用できます。コンソール ウィンドウに GenDocCLI.EXE のサービス メッセージを表示させたくない場合に、このオプションを使用します。

CompilerOptions

Delphi コンパイラに関連するオプションを指定します(「DCC32.EXE - Delphi コマンドライン コンパイラ」を参照)。以下のオプションを指定することができます。

  • -U<パス> -- このオプションは必須です! GenDocCLI.EXE がコンパイル済みユニットを検索するディレクトリを指定します。
このオプションの形式は、-U<パス_1>;<パス_2>... です。それぞれの <パス_番号> に、Delphi のコンパイル済みユニットが含まれるディレクトリを指定します。以下に例を示します。
-U"C:\Program Files (x86)\Embarcadero\Studio\20.0\lib\win32\debug";C:\MyUnits
  • -I<パス> -- インクルード ディレクトリを指定します。このオプションの形式は、-I<パス_1>;<パス_2>... です。それぞれの <パス_番号> に、インクルード ディレクトリを指定します。
  • -D<シンボル> -- 条件付きコンパイル シンボルを指定します。
このオプションの形式は、-D<シンボル_1>;<シンボル_2>... です。それぞれの <シンボル_番号> に、条件付きコンパイル シンボルを指定します。
  • -A<ユニット>=<エイリアス> -- ユニットのエイリアスを指定します。

-o OutputFolder

OutputFolder には、GenDocCLI.EXE が生成するドキュメント ファイルを書き出す、出力フォルダを指定します。.\doc のような相対パスを使用する場合は、ProjectName.DPROJ オプションで指定した ProjectRootDirectory プロジェクト ルート ディレクトリからの相対パスとします。
デフォルトでは、ProjectRootDirectory\out\doc サブディレクトリが出力先となります。-oOutputFolder の間に、空白文字を 1 つ挿入することもできます。

ProjectName.DPROJ

Delphi プロジェクト ファイルを指定します。このファイルの拡張子は .DPROJ でなければなりません。このファイルは IDE で作成する必要があります。このオプションは必須です!

関連項目