PIB

GPL

• doxygen

• Doxygen を使おう Take me back...
• サクラエディタ/開発に参加したい方へ/doxygen Take me back...

-g オプションでテンプレートが生成される。

doxygen -g

以下の4項目くらいを設定しておけば幸せかなと思う。

EXTRACT_ALL            = YES
RECURSIVE              = YES
SOURCE_BROWSER         = YES
HAVE_DOT               = YES

上記項目の sed による自動書き換え

sed -re 's/^((EXTRACT_ALL|RECURSIVE|SOURCE_BROWSER|HAVE_DOT) += +)NO( *\r?)$/\1YES\3/g' -i Doxyfile

JavaScript はサポートしてるんだけど、なぜかデフォルトではちゃんと処理してくれない。
拡張子が .js のファイルを処理対象に加えると共に、
拡張子に対して言語のパーサーをマッピングしてやる必要があるようだ。

Doxyfile の変更点は二つ
一つは FILE_PATTERNS へ *.js の追加
もう一つは以下の設定の追加

EXTENSION_MAPPING      = js=JavaScript

sed

sed -E 's/^([[:space:]]*)\*\.cc[[:space:]]*\\$/\0\n\1*.js \\/g' -i Doxyfile
sed -E 's/^(EXTENSION_MAPPING[[:space:]]*=.*?)([[:space:]]?)/\1 js=JavaScript/g' -i Doxyfile

関連:

• 20190613: Doxygen - js2doxy.pl

grep -E '^(EXTRACT_ALL|RECURSIVE|SOURCE_BROWSER|HAVE_DOT|EXTENSION_MAPPING)' Doxyfile

doxygen に Doxyfile を食わせる

doxygen Doxyfile

• ソースコード管理ツール
• 20210203: vscode - Doxygen と JSDoc