Eclipse - ドキュメント自動化 - 基本設定
プロジェクトに合わせて定義ファイルの設定を行っていきます。以下は、「C++」プロジェクトの例です。
この項目で設定した項目は、以降の詳細設定で上書されることがあります。
- 1. Doxyfile オープン
- 2. プロジェクト
- 3. モード
- 4. 出力
- 5. ダイアグラム
1. Doxyfile オープン
前項の設定をしておけば、プロジェクト・エクスプローラー上の doxyfile をダブルクリックすることで、Doxywizard でファイルを開くことができます。
2. プロジェクト
「Project name」にプロジェクト名を入れます。これが後で結果をブラウザで見るときのタイトルになります。①
「Select」でソースのルートディレクトリを選択します。
「scanrecursively」にチェックをいれます。（ソースが階層ディレクトリになっている場合に再帰的にソースを検索する）
「Next」
①でいれたものは、後でこのように表示されます。
3. モード
「Select the desired ...」で 「All entries」と 「Include cross-referenced ...」にチェックをいれます。
「Select programming language ...」で対象とする言語にチェックをいれます。
わたしは、C言語も C++ も 「Optimize for C++/CLI output」にチェックをいれています。
「Next」
4. 出力
わたしは HTML のみ使います。
「LaTeX」以降のチェックは、すべてはずします。
「HTML」、「plain HTML」、「With search function」にチェックをいれて
「Next」
5. ダイアグラム
「Use dot tool」にチェックをいれます。
チェックボックスの項目は後で上書きしますので、ここではそのままにしておきます。
|
|
