# Doxygenで生成

> ソースコードから自動的にドキュメントを生成するツール。
> 
- C++、C言語、Java、C#など

## ⚠️下記のzennのサイトを参考にすべし。
## DoxygenGUI frontendでグラフィカルに設定できるよ

[就活には自動生成ドキュメントが効くらしい](https://zenn.dev/kd_gamegikenblg/articles/118e85d099c3e6)

[](http://www.ee.t-kougei.ac.jp/tuushin/lecture/technicalWriting/doxygenOperation.html)

### 設定ファイルを生成

---

```notion
doxygen -g
```

カレントディレクトリに、Doxyfileという名前で出力される。

### 設定ファイルを編集

---

[Doxygen + Graphviz を使って呼び出し依存関係図を生成する - Posts - Seaside Laboratory](https://www.notion.so/Doxygen-Graphviz-Posts-Seaside-Laboratory-1e8839501633813fbce3fb452a711f87?pvs=21)

- テキストエディタでDoxyfile編集をする。

| **項目名** | **意味** | **設定例** |
| --- | --- | --- |
| PROJECT_NAME | プロジェクト名 | "Knuckle Fighter Maniax" |
| OUTPUT_DIRECTORY | ドキュメントの出力先 | "C:\My Program\doxygen" |
| OUTPUT_LANGUAGE | 出力言語 | Japanese |
| FULL_PATH_NAMES | 出力ファイル名をフルパスにする | NO |
| OPTIMIZE_OUTPUT_FOR_C | C 言語に最適化 | YES |
| EXTRACT_ALL | 全てを展開 | YES |
| INPUT | ソースファイルのパス | "C:\My Program" |
| INPUT_ENCODING | ソースファイルの文字コード | SHIFT_JIS |
| FILE_PATTERNS | 対象とするファイル | *.cpp *.h |
| RECURSIVE | サブディレクトリーも含める | YES |
| VERBATIM_HEADERS | ドキュメントにヘッダーを引用 | NO |
| GENERATE_TREEVIEW | ツリービューの利用 | YES |
| ENUM_VALUES_PER_LINE | 列挙型を行に並べる数 | 1 |
| GENERATE_LATEX | LATEX 版の出力 | NO |

### ドキュメント作成

---

- 設定ファイルのあるディレクトリで以下のコマンドを実行。

```notion
doxygen
```

- 出力先に「html」という名前のフォルダが自動で作成されるので、その中にあるindex.htmlを開く。

<aside>
⚠️

//Graphivizも使った方法はのページに

</aside>