Doxygen スタートアップ設定でグラフ画像を生成する Dot 機能を有効化

ソフトウェア開発で広く使用されているドキュメント生成ツールDoxygen」で関数呼び出しやクラス図などのグラフ画像を生成するために必要な dot コマンド使用できるようにするために、起動時のスタートアップの設定変更する手順を紹介します。

GodotEngine4 ソースコードからDoxygenで生成したドキュメントの確認2

※ Graphviz 12.1.1 を使用します。
※ Doxygen 1.12.0 を使用します。

関連記事

Graphviz のインストールについては以下の記事を参照してください。

Doxygen のインストールについては以下の記事を参照してください。

Graphviz → Doxygen インストール時について

今回は Doxygen, Graphviz の順番でインストールして、 Doxygen で Graphviz の dot.exe を設定する手順になっています。

しかし、以前に Graphviz を先にインストールしてから Doxygen をインストールした際に、 Doxygen が自動的に Graphviz を認識して Dot 機能を最初から有効にしてくれました。

そのため Graphviz → Doxygen の順番でインストールした場合は、これから行う設定はすでに行われているかもしれないので、 Dot 機能が有効になっているかの確認事項としてお読みください。

Dot 機能を有効にする

Doxygen の GUI 版アプリ Doxywizard を起動します。
※デスクトップ下側の検索ボックスで Doxywizard で検索するとアプリを開けます。

Expert タブを選択して、左上の Topics リストから Dot を選択します。
Dot の設定ページが右側に表示されるので HAVE_DOTチェックを入れます。

Doxygen Graphviz の dot コマンドを使用してグラフを描画する設定1

DOT_PATH 項目に dot.exe のパスを設定します。
Graphviz をインストールしたフォルダの bin/dot.exe を指定しました。

Doxygen Graphviz の dot コマンドを使用してグラフを描画する設定2

スタートアップの設定の保存

Dot 機能設定有効にしたら、その設定が起動するたびに反映されるように、スタートアップの設定保存します。

スタートアップ設定保存するには、メニュー「Settings」→「Use current settings at startup」を選択します。

Doxygen Graphviz の dot コマンドを使用してグラフを描画する設定3

確認ダイアログが表示されるので Save ボタンを押します。
これでスタートアップの設定が保存されました。

Doxygen Graphviz の dot コマンドを使用してグラフを描画する設定4

Doxywizard を閉じる際に、現在の設定をファイルに保存するか確認されるので、Discard ボタンで破棄を選択して保存せずに終了します。
※すでにスタートアップの設定は保存されています。

Doxygen Graphviz の dot コマンドを使用してグラフを描画する設定5

テスト

もう一度 Doxywizard を開いて Expert タブDot のページを表示すると、HAVE_DOTチェックされた状態で、 DOT_PATH には先ほど指定した dot.exe のパス設定された状態で起動したことが確認できます。

Doxygen Graphviz の dot コマンドを使用してグラフを描画する設定6

まとめ

今回は、ソフトウェア開発で広く使用されているドキュメント生成ツールDoxygen」で関数呼び出しやクラス図などのグラフ画像を生成するために必要な dot コマンド使用できるようにするために、起動時のスタートアップの設定変更する手順を紹介しました。

参照サイト Thank You!

記事一覧 → Compota-Soft-Press

コメント

Ads Blocker Image Powered by Code Help Pro

お願い - Ads Blocker Detected

このサイトは広告を掲載して運営しています。

ポップアップを閉じて閲覧できますが、よろしければ

このサイト内の広告を非表示にする拡張機能をオフにしていただけませんか?

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

We have detected that you are using extensions to block ads. Please support us by disabling these ads blocker.

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