Doxygen 特殊コマンド (≒Javadoc タグ)
特殊コマンド名 | 用途 |
---|---|
brief | 概要 |
details | 詳細説明 |
note | 注記 |
param | 引数 |
return | 返却値 |
Doxygen 特殊コマンド (≒Javadoc タグ)
特殊コマンド名 | 用途 |
---|---|
brief | 概要 |
details | 詳細説明 |
note | 注記 |
param | 引数 |
return | 返却値 |
設定ファイルをゼロから記述しても良い。しかしながら、下記のコマンドを使い設定ファイルのテンプレートを自動生成し、必要な箇所だけを編集する方法が簡便である。
1 |
$ doxygen -g [configName] |
[configName] にて設定ファイルのファイル名を明示的に指定できる。明示的に指定しなければデフォルトの設定ファイル名の "Doxyfile" で作成される。
ただし、自動生成されたテンプレートのDoxyfileを使うと「ほぼ」中身のないドキュメントしか出力されない。