@collaborationgraph【コラボレーション図の表示】1.9.8
@hidecollaborationgraph【コラボレーション図の非表示】1.9.8
@includegraph【ファイルのインクルード関係図の表示】1.9.8
@hideincludegraph【ファイルのインクルード関係図の非表示】1.9.8
@includedbygraph【ファイルの被インクルード関係図の表示】1.9.8
@hideincludedbygraph【ファイルの被インクルード関係図の非表示】1.9.8
@dir【ディレクトリ情報】
@directorygraph【ディレクトリ依存関係図の表示】1.9.8
@hidedirectorygraph【ディレクトリ依存関係図の非表示】1.9.8
@collaborationgraph【コラボレーション図の表示】1.9.8
@hidecollaborationgraph【コラボレーション図の非表示】1.9.8
メモ
概要
- コラボレーション図(コミュニケーション図・連携図) の表示・非表示を指定
外部リンク
構文
@collaborationgraph 1.9.8
@hidecollaborationgraph 1.9.8
例
/// @brief 概要 (ClassCollaborationSub)
/// @details 詳細 (ClassCollaborationSub)
class ClassCollaborationSub {
public:
int public_sub; ///< 変数 (public_sub)
/// @brief 概要 (methodSub)
/// @details 詳細 (methodSub)
void methodSub() { }
};
/// @brief 概要 (ClassCollaborationParent)
/// @details 詳細 (ClassCollaborationParent)
/// @collaborationgraph
class ClassCollaborationParent {
private:
int private_parent; ///< 変数 (private_parent)
protected:
int protected_parent; ///< 変数 (protected_parent)
ClassCollaborationSub classSub; ///< 変数 (classSub)
public:
int public_parent; ///< 変数 (public_parent)
/// @brief 概要 (methodParent)
/// @details 詳細 (methodParent)
void methodParent() {
classSub.methodSub();
}
};
/// @brief 概要 (ClassCollaborationChild_A)
/// @details 詳細 (ClassCollaborationChild_A)
/// @hidecollaborationgraph
class ClassCollaborationChild_A : ClassCollaborationParent {
private:
int private_child_A; ///< 変数 (private_child_A)
protected:
int protected_child_A; ///< 変数 (protected_child_A)
public:
int public_child_A; ///< 変数 (public_child_A)
/// @brief 概要 (methodChild_A)
/// @details 詳細 (methodChild_A)
void methodChild_A() {
methodParent();
}
};
/// @brief 概要 (ClassCollaborationChild_B)
/// @details 詳細 (ClassCollaborationChild_B)
/// @collaborationgraph
class ClassCollaborationChild_B : ClassCollaborationParent {
private:
int private_child_B; ///< 変数 (private_child_B)
protected:
int protected_child_B; ///< 変数 (protected_child_B)
public:
int public_child_B; ///< 変数 (public_child_B)
/// @brief 概要 (methodChild_B)
/// @details 詳細 (methodChild_B)
void methodChild_B() {
methodParent();
}
};
HTML出力例:ClassCollaborationParent
ClassCollaborationParent クラス
概要 (ClassCollaborationParent) [詳解]
ClassCollaborationParent 連携図

公開メンバ関数 | |
void | methodParent () |
概要 (methodParent) | |
公開変数類 | |
int | public_parent |
変数 (public_parent) | |
限定公開変数類 | |
int | protected_parent |
変数 (protected_parent) | |
ClassCollaborationSub | classSub |
変数 (classSub) | |
非公開変数類 | |
int | private_parent |
変数 (private_parent) | |
詳解
概要 (ClassCollaborationParent)
詳細 (ClassCollaborationParent)
【以下省略】
HTML出力例:ClassCollaborationChild_A
ClassCollaborationChild_A クラス
概要 (ClassCollaborationChild_A) [詳解]
公開メンバ関数 | |
void | methodChild_A () |
概要 (methodChild_A) | |
公開変数類 | |
int | public_child_A |
変数 (public_child_A) | |
限定公開変数類 | |
int | protected_child_A |
変数 (protected_child_A) | |
非公開変数類 | |
int | private_child_A |
変数 (private_child_A) | |
![]() | |
int | public_parent |
変数 (public_parent) | |
int | protected_parent |
変数 (protected_parent) | |
ClassCollaborationSub | classSub |
変数 (classSub) | |
その他の継承メンバ | |
![]() | |
void | methodParent () |
概要 (methodParent) | |
詳解
概要 (ClassCollaborationChild_A)
詳細 (ClassCollaborationChild_A)
【以下省略】
HTML出力例:ClassCollaborationChild_B
ClassCollaborationChild_B クラス
概要 (ClassCollaborationChild_B) [詳解]
ClassCollaborationChild_B 連携図

公開メンバ関数 | |
void | methodChild_B () |
概要 (methodChild_B) | |
公開変数類 | |
int | public_child_B |
変数 (public_child_B) | |
限定公開変数類 | |
int | protected_child_B |
変数 (protected_child_B) | |
非公開変数類 | |
int | private_child_B |
変数 (private_child_B) | |
![]() | |
int | public_parent |
変数 (public_parent) | |
int | protected_parent |
変数 (protected_parent) | |
ClassCollaborationSub | classSub |
変数 (classSub) | |
その他の継承メンバ | |
![]() | |
void | methodParent () |
概要 (methodParent) | |
詳解
概要 (ClassCollaborationChild_B)
詳細 (ClassCollaborationChild_B)
【以下省略】
@includegraph【ファイルのインクルード関係図の表示】1.9.8
@hideincludegraph【ファイルのインクルード関係図の非表示】1.9.8
@includedbygraph【ファイルの被インクルード関係図の表示】1.9.8
@hideincludedbygraph【ファイルの被インクルード関係図の非表示】1.9.8
メモ
@includegraph【ファイルのインクルード関係図の表示】
@hideincludegraph【ファイルのインクルード関係図の非表示】
- ファイルのインクルード関係図(依存先関係図)の表示・非表示を指定
@includedbygraph【ファイルの被インクルード関係図の表示】
@hideincludedbygraph【ファイルの被インクルード関係図の非表示】
- ファイルの被インクルード関係図(被依存関係図)の表示・非表示を指定
外部リンク
構文
@includegraph 1.9.8
@hideincludegraph 1.9.8
@includedbygraph 1.9.8
@hideincludedbygraph 1.9.8
例
ClassInclude.cpp
// ClassInclude.cpp
/// @file
/// @brief 概要 (ClassInclude.cpp)
/// @details 詳細 (ClassInclude.cpp)
/// @includegraph
#include "inc_A.h"
#include "inc_D.h"
HTML出力例:
ClassInclude.cpp ファイル
inc_A.h
// inc_A.h
/// @file
/// @brief 概要 (inc_A.h)
/// @details 詳細 (inc_A.h)
/// @includegraph
/// @includedbygraph
#include "inc_B.h"
#include "inc_C.h"
HTML出力例:
inc_A.h ファイル
概要 (inc_A.h) [詳解]
#include "inc_B.h"
#include "inc_C.h"
inc_A.h の依存先関係図:

被依存関係図:

[ソースコード]
詳解
概要 (inc_A.h)
詳細 (inc_A.h)
inc_D.h
// inc_D.h
/// @file
/// @brief 概要 (inc_D.h)
/// @details 詳細 (inc_D.h)
/// @hideincludegraph
/// @hideincludedbygraph
#include "inc_E.h"
#include "inc_F.h"
HTML出力例:inc_D.h
inc_D.h ファイル
概要 (inc_D.h) [詳解]
#include "inc_E.h"
#include "inc_F.h"
[ソースコード]
詳解
概要 (inc_D.h)
詳細 (inc_D.h)
@dir【ディレクトリ情報】
@directorygraph【ディレクトリ依存関係図の表示】1.9.8
@hidedirectorygraph【ディレクトリ依存関係図の非表示】1.9.8
メモ
@dir【ディレクトリ情報】
- ディレクトリ情報を記述
- ファイル一覧に表示し、ディレクトリ情報ページを作成
- STRIP_FROM_PATH【ファイルリストの除去パス】部分は出力時に削除
@directorygraph【ディレクトリ依存関係図の表示】
@hidedirectorygraph【ディレクトリ依存関係図の非表示】
- ディレクトリ依存関係図の表示・非表示を指定
- @dir【ディレクトリ情報】に指定
- DIRECTORY_GRAPH【ディレクトリ依存関係図の表示有無】の設定を無視
関連
外部リンク
構文
@dir [ディレクトリ名 (一意)]
@directorygraph 1.9.8
@hidedirectorygraph 1.9.8
例
/// @dir inc
/// @brief 概要 (dir-inc)
/// @details 詳細 (dir-inc)
/// @dir inc/inc2
/// @directorygraph
/// @brief 概要 (dir-inc-inc2)
/// @details 詳細 (dir-inc-inc2)
/// @dir inc/inc2/inc3
/// @hidedirectorygraph
/// @brief 概要 (dir-inc-inc2-inc3)
/// @details 詳細 (dir-inc-inc2-inc3)
/// @dir inc/inc2/inc3/inc4
/// @directorygraph
/// @brief 概要 (dir-inc-inc2-inc3-inc4)
/// @details 詳細 (dir-inc-inc2-inc3-inc4)
HTML出力例:ファイル一覧
ファイル一覧
HTML出力例:inc
inc ディレクトリリファレンス
HTML出力例:inc2
inc2 ディレクトリリファレンス
概要 (dir-inc-inc2)
[詳解]
inc2 のディレクトリ依存関係図

ディレクトリ | |
inc3 | |
概要 (dir-inc-inc2-inc3) | |
ファイル | |
inc_2.h | |
概要 (inc_2.h) | |
詳解
概要 (dir-inc-inc2)
詳細 (dir-inc-inc2)
HTML出力例:inc3
inc3 ディレクトリリファレンス
概要 (dir-inc-inc2-inc3)
[詳解]
ディレクトリ | |
inc4 | |
概要 (dir-inc-inc2-inc3-inc4) | |
ファイル | |
inc_3.h | |
概要 (inc_3.h) | |
詳解
概要 (dir-inc-inc2-inc3)
詳細 (dir-inc-inc2-inc3)
HTML出力例:inc4
inc4 ディレクトリリファレンス
概要 (dir-inc-inc2-inc3-inc4)
[詳解]
inc4 のディレクトリ依存関係図

ファイル | |
inc_4.h | |
概要 (inc_4.h) | |
詳解
概要 (dir-inc-inc2-inc3-inc4)
詳細 (dir-inc-inc2-inc3-inc4)