【macOS】Doxygenをインストールして使う

スポンサーリンク

Doxygenはソースファイルのコメントから文書を抜き出してドキュメント化するツール。macOSにインストールして使えるようにしたので備忘録を残す。

インストール

Homebrewからインストールできる。コンソールから下記コマンドを実行。

$ brew install doxygen
$ brew install graphviz
  • Graphvizをインストールすると、関数のコールグラフやクラスのUML表現が可能になるので、インストールしておく。

使い方

ドキュメント作成したいソースのあるフォルダに移動し、下記コマンドで設定ファイル(Doxyfile)が作成される。

$ doxygen -g
  • 必要に応じて、作成されたDoxyfileを編集して調整する。

実行

下記のようにコマンド実行すると カレントディレクトリにあるDoxyfileを読込み、ドキュメント生成する。

$ doxygen

結果は、「html/」フォルダに出力されてるので、その中の index.html をブラウザで開く。

関連記事

Doxygen [新石器Wiki]

参考

  1. Doxygen マニュアル
  2. Doxygen – Wikipedia
  3. macOSでDoxygenを使ってC,C++ソースコードからドキュメントを作成する
  4. DoxygenとGraphvizでコードのドキュメントを自動生成する
  5. 最近覚えた便利アプリ[doxygen]
  6. Doxygen入門の入門
  7. Doxygenを利用して、コードコメントからドキュメントを作ろう! Githubとの連携も出来るよ!

コメント

タイトルとURLをコピーしました