目次

Doxygen

Doxygenはソースファイルのコメントから文書を抜き出してドキュメント化するツール。

Doxygenに関する情報を、本ページを起点に作成していく。

インストール手順

姉妹サイトの下記の記事を参照。

Doxygen記述例

コメント記述したサンプルソースを「GitHub」に登録しているので、参考にください。
任意フォルダで下記コマンドで取得。 

$ git clone https://github.com/jr4qpv/gcc_sample

取得したgcc_sampleフォルダに移動して、doxygen コマンドを実行してドキュメント生成。 

$ doxygen -g
$ doxygen

ドキュメント表示例

上記のサンプルでドキュメントのHTML表示例。

Filesリストの、sample.c をクリック。

参考

  1. Doxygen - Wikipedia