Doxygen
作成日時:2019/06/21
更新日時:2019/06/21
スポンサーリンク
この記事の確認環境
Doxygen 1.8.15
Doxygenとは
ソースコードからドキュメントを生成するツールです。
公式サイト
インストール方法
http://www.doxygen.nl/download.html
上記ダウンロードページにGITリポジトリからコマンドラインでのインストール方法、各OS用のインストーラーのリンクが記載されています。
また、Graphvizのインストールを行っておくとダイアグラムの描画に使用可能です。
設定
GUIのツールによる設定方法を記載しています。
公式サイトの設定についてのマニュアル : http://www.doxygen.nl/manual/config.html
Step 1 : Specify the working directory from which doxygen will run
作業ディレクトリを設定します。
Step 2 : Configure doxygen using the Wizard and/or Expert tab, then switch to the Run tab to generate the documentation
Wizardタブで基本的な設定を、Expertタブで詳細な設定が可能です。
設定が完了後、RunタブにてRun doxygenを実行するとドキュメントが生成されます。
Wizardタブ
Topics - Project
| ラベル | Expertタブでのキー | 説明 |
|---|---|---|
| Project name | Project - PROJECT_NAME | プロジェクト名を指定します。 デフォルト値 : My Project |
| Project synopsis | Project - PROJECT_BRIEF | プロジェクトの梗概を設定します。 |
| Project version or id | Project - PROJECT_NUMBER | プロジェクトのバージョン等を設定します。 |
| Project logo | Project - PROJECT_LOGO | プロジェクトのロゴ画像を指定します。 |
| Source code directory | - | ソースコードのディレクトリを指定します。 |
| Scan recursively | Input - RECURSIVE | チェックを入れるとソースコードのディレクトリを再帰的にスキャンします。 |
| Destination directory | - | 出力先のディレクトリを指定します。 |
Topics - Mode
| ラベル | Expertタブでのキー | 説明 |
|---|---|---|
| Select the desired extraction mode | - | Documented entities only All Entities Include cross-referenced source code in the output |
| Select programming language to optimize the results for | - | 結果を指定の言語に最適化します。 Optimize for C++ output Optimize for C++/CLI output Optimize for Java or C# output Optimize for C or PHP output Optimize for Fortran output Optimize for VHDL output |
Topics - Output
| ラベル | Expertタブでのキー | 説明 |
|---|---|---|
| HTML | HTML - GENERATE_HTML | チェックを入れるとHTML形式でドキュメントを生成します。 |
| LaTeX | LaTeX - GENERATE_LATEX | チェックを入れるとLaTeX形式でドキュメントを生成します。 |
| Man pages | Man - GENERATE_MAN | チェックを入れるとMan pages形式でドキュメントを生成します。 |
| Rich Text Format (RTF) | RTF - GENERATE_RTF | チェックを入れるとRich Text Format (RTF)形式でドキュメントを生成します。 |
| XML | XML - GENERATE_XML | チェックを入れるとXML形式でドキュメントを生成します。 |
HTMLのwith navigation panelを選択してもナビゲーションが表示されない場合、ExpertタブのTopics > HTMLにあるDISABLE_INDEX及びGENERATE_TREEVIEWのチェックが入っているか確認し、入っていない場合は両方にチェックを入れることで表示される場合があります。
Topics - Diagrams
| ラベル | Expertタブでのキー | 説明 |
|---|---|---|
| Diagrams to generate | - | No Diagramsを選択するとダイアグラムの生成を行いません。 Use built-in class diagram generatorを選択するとビルトインのジェネレータを使用しダイアグラムを生成します。 Use dot tool from the GraphViz packageを選択するとGraphVizがインストールされている場合dot言語を使用したダイアグラムを生成します。 |
Expertタブ
Topics - Project
| ラベル | 説明 |
|---|---|
| FULL_PATH_NAMES | チェックを入れるとドキュメントに記載するファイル名の前に絶対パスを付与します。 |
Topics - Preprocessor
| ラベル | 説明 |
|---|---|
| PREDEFINED | プリプロセッサ起動前に定義するマクロや定数を設定します。 この設定値はENABLE_PREPROCESSINGにチェックが入っている場合に有効になります。 Unityの場合、Edit > Project Settings > Playerを選択で表示されるPlayer SettingsのOther Settings パネルで、 Scripting Define Symbolsに定義している値をこちらに定義する必要があります。 https://docs.unity3d.com/ja/2018.1/Manual/PlatformDependentCompilation.html |