MPLAB X IDEにDoxygenを組み込む。

プログラムのドキュメンテーションというと、まず最初に Doxygen が思い浮かぶ人も多いかと思います。もちろん pydoc や Javadoc という、言語固有のツールもあるわけですが、そうは言っても C言語だと Doxygen が最も多く使われているのではないでしょうか。

C に限らず、ソースコードはコメントやメモをしっかり残しておかないとあとでわからなくなるというのはよく言われていることで、そういう点でもコミットする際にはその都度、ある程度コメントを整備したり、API リファレンスを作ったりしておかないと、あとでまとめてやろうとしてもすでに記憶の彼方で「あれ、なんでこんなことしてるんだっけ？」というのが出てきたりします。

ということで MPLAB X IDE で Doxygen を使うためのセットアップを行います。

まずはプラグイン。

"Doxygen Integrator" というのがあるので、これを選択してインストールします。インストールが終わると IDE の再起動が求められるので、再起動します。

次に Doxygen とツール類のインストールです。
Doxygen はダウンロードページから GUIベースのインストーラが提供されていて、これは64bit版も含んでいるようです。
関数などの依存関係のグラフは GraphViz で描画しますので、必要があればダウンロードしてインストールします。現時点では graphviz-2.38.msi があるようです。

Doxygen の Installing the binaries on Windowsを見ると、GraphViz は推奨、また PDF 出力まで行いたければ LaTeX と Ghostscript もインストールしましょうと書いてあります。

インストールが終わったら、IDE のプラグインの管理ページで設定を行います。"Tools" → "Options" → "Plugins" で、"Doxygen Integrator" のタブです。

ここでは Doxygen の exe ファイルを指定しておけばOKです。

Doxygen をインストールすると、"Doxywizard" というウィザード形式の GUI フロントエンドもインストールされるので、これを使ってプロジェクトの設定などを行い、Doxyfile という config ファイルをプロジェクトごとに作成しておけば、そのとおりに生成してくれます。さらにここではプロジェクトロゴも指定できるので、必要があれば指定します。

Doxygen でのドキュメントの生成は、IDE からだとプロジェクトを右クリックして現れるメニューから "Create Doxygen" を実行します。

html ファイルと一緒に latex ファイルも生成してくれるようなので、LaTeX（TeXLive）が適切にインストールされていれば make.bat で PDF まで生成してくれます。
あとはドキュメントを書いていくだけです。