Doxygen4(DoxygenでGraphwizを使用)

Image may be NSFW.
Clik here to view.

・目次

1.目的

　・DoxygenでGraphwizを使用する。

　・出力には、Doxywizardを使用し、DoxywizardでGraphwizを使用できるように設定する。

　マニュアル：Doxygen

2.事前準備

　・DoxygenでGraphizを使用するためには、Graphizのインストールが必要。

　・下記を参照し、インストールを行う。

　　・https://project-oki.hatenablog.com/entry/plantuml1

3.DoxywizardでGraphizを使用する。

　3.1 doxygenの基本出力設定

　　(1) doxygenのbinファイル、出力対象ファイル、出力場所の設定

Image may be NSFW.
Clik here to view.

　※Nextを押し、次へ移動

　　(2)出力ドキュメントの種類及び、出力ソースコードの種類を設定

Image may be NSFW.
Clik here to view.

　　※Runを押し、次へ移動

　　(3)ドキュメントの作成

Image may be NSFW.
Clik here to view.

　3.2 Graphizを使用するための設定

　　Graphizを使用する場合、上記設定に追加で下記設定を行う。

　　(1) WizardのDiagramsを選択する。

　　(2) Use dot tool from the GrapViz packageを選択し、全てにチェックを入れる。

Image may be NSFW.
Clik here to view.

　(3) ExpertのDotを選択する。

　(4) DotのDOT_PATHにインストールしたGraphvizのbinファイルのパスを入れる。

Image may be NSFW.
Clik here to view.

4.Doxywizardでの出力

index.mdファイル

# Doxygen確認プログラム {#mainpage}

## doxygen導入1{#sec1}
* これはmarkdown形式での書き方です。
* doxygenで使用できるコメントの出力確認
* メインページ(.md)ファイルの作成と、main.cファイルを作成し、その出力を確認する。

・main.cファイル

/** * @file main.c * @brief サンプルプログラム for Doxygen */#include <stdio.h>/** * @brief 2つの整数を加算する * @param int a :1つ目の整数 * @param int b :2つ目の整数 * @return 加算結果 */intadd(int a, int b) {
    return a + b;
}

/** * @brief 計算を実行し結果を表示する * @param x 1つ目の整数 * @param y 2つ目の整数 */voidcalculate(int x, int y) {
    int sum = add(x, y);
    printf("%d+%d = %d\n",x,y,sum);
}

/** * @brief メイン関数 * @return プログラムの終了コード */intmain() {
    calculate(5, 3);
    return0;
}