Doxygenでコードからドキュメントを生成する

提供: Akionux-wiki
Share/Save/Bookmark
移動先: 案内検索

概要

Doxygenは、C/C++などのソースコードからドキュメンテーションを生成するソフトウェアである。

簡単な使い方

公式マニュアル[1]から簡単な使い方を紹介する。

とりあえずドキュメントを生成してみる

doxygenに設定ファイル名を引数とした-gオプションを付けて実行すると、設定ファイルのひな形が生成される:

doxygen -g <config-file>

設定ファイル名を引数としてdoxygenを実行すれば、最も簡単にドキュメントを生成できる:

doxygen <config-file>

特に、設定ファイル名をDoxyfileとして作っておけば、doxygenの引数を省略した時にDoxyfileをカレントディレクトリから探して読むようになっているので、特に事情がなければ設定ファイル名をDoxyfileとしておくと良いだろう。

doxygen -g Doxyfile
doxygen

ひな形の設定ファイルでdoxygenを実行すると、カレントディレクトリにhtmlとlatexというディレクトリができる。

html/index.htmlをブラウザで読みこめば、ひな形のHTMLドキュメントが見える。

一方、latexの方は、

cd latex
make

とすれば、refman.pdfというひな形のPDFドキュメントができる。

コードにドキュメントを入れてみる

この節を書こうとした人は途中で投げ出してしまいました。今後場合によっては加筆されるかもしれません。


References