doxygen
doxygenとは
コードから自動的にソフトウェアドキュメントを作成出来るソフト
参考:https://tracpath.com/works/development/doxygen_beginers_guide/
https://qiita.com/wakaba130/items/faa6671bd5c954cb2d02
doxygenマニュアル:http://www.doxygen.jp/manual.html
基本操作方法:
ファイル選択(Step2:Wizard → Project)
Step1 にdoxygen.exeが入っているディレクトリを指定
Source code directoryにソースコードのディレクトリを指定
Destination directoryに結果の出力先のディレクトリを指定
https://gyazo.com/24d0121704cac363d19edcee72e5b936
モード設定(Step2:Wizard → Mode)
All Entitiesを選択
Select programming language to optimize the results forで、ソースコードの言語を設定
https://gyazo.com/ed1fea39b46c588535526500b1a01127
結果の出力(Step2:Run →Run doxygenをクリック→Show HTML outputをクリック。出力先にファイル有り)
https://gyazo.com/30140073bb70b6b4cf441445ab6b126b
文字化けする際の変更内容:http://marupeke296.com/DOXY_No2_Japanese.html
Expertタブ→ Project → OUTPUT_LANGUAGE をJapaneseに変更
Expertタブ→Input→INPUT_ENCODINGにCP932に変更 (ソースコード作成した時のもの)
関連記事:JAVADOC
階層の違うファイルを追加する
ExpertタブのINPUTにファイルURLを追加し、+マークを押す。
https://gyazo.com/8baedf7d3c0c18271271bd0c9d3281fa
docxygenでコメントの書き方
///構造体説明
構造体
変数 ///<変数説明
とする。
code:doxygen
列挙型:
/**
/*
* group
*/
{a}
///内容
設定内容参考:
https://cercopes-z.com/Doxygen/list-config-dxy.html
https://dcc-scripts.blogspot.com/2017/01/doxygen.html
https://youtu.be/GCAr9zD5JfY?si=4QvRv8Aua-UPMUtw