Doxygen
=======
[[http://www.doxygen.jp/|Doxygen]]はソースファイルのコメントから文書を抜き出してドキュメント化するツール。

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

  * [[doxygen-coding-rules-c]]

インストール手順
---------------
姉妹サイトの下記の記事を参照。

  * [[myblog>2020/06/29/ubuntu-linux-doxygen-install/|【Ubuntu Linux】Doxygenをインストールして使う]]
  * [[myblog>2020/02/18/macos-doxygen-install/|【macOS】Doxygenをインストールして使う]]
  * [[myblog>2020/02/21/msys2-doxygen-install/|【msys2】Doxygenをインストールして使う]]
  * [[myblog>2020/03/01/windows-doxygen-install/|【Windows】Doxygenをインストールして使う]]


Doxygen記述例
-------------
コメント記述したサンプルソースを「[[https://github.com/jr4qpv/gcc_sample|GitHub]]」に登録しているので、参考にください。  
任意フォルダで下記コマンドで取得。

<code bash>
$ git clone https://github.com/jr4qpv/gcc_sample
</code>

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

<code bash>
$ doxygen -g
$ doxygen
</code>


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

{{:programing:doxygen:doxygen-sample-01.png?700|}}

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

{{:programing:doxygen:doxygen-sample-02.png?700|}}



参考
----

1. [[wpjp>Doxygen|Doxygen - Wikipedia]]