@see・@sa【参照】
@ref【インライン参照】
@link・@endlink【インライン参照ブロック】
@anchor【アンカー】
@secreflist・@endsecreflist【参照リスト】・@refitem【参照リスト項目】
@related・@relates【関連関数 (クラス専用)】
@relatedalso・@relatesalso【関連関数】

@see【参照】
@sa【参照】

メモ

概要

参照を記述
- 隣接する複数の @see【参照】・@sa【参照】コマンドは１つの段落に結合
参照先
- クラス・メソッド・関数・変数・ファイル・URL・クラスメンバ・オーバーロードメソッド・コンストラクタ ・グループ

外部リンク

Doxygen Special Commands (英語)
- \see
- \sa

構文

@see 参照先
@sa 参照先

例

/// @page page_see ページ：@see【参照】・@sa【参照】
/// @see ClassSee
/// @see ClassSee::methodSee
/// @see ClassSee::intSee
/// 
/// @sa funcSee
/// @sa intSee
/// @sa https://cercopes-z.com/
/// @sa GROUP_SEE

/// @defgroup GROUP_SEE グループ (@see)
/// @{
class ClassSee {
    int intSee;
    void methodSee() { }
};

int intSee;

void funcSee() { }

/// @}

HTML出力例

ページ：@see【参照】・@sa【参照】

参照: ClassSee; ClassSee::methodSee; ClassSee::intSee; funcSee; intSee; https://cercopes-z.com/; グループ (@see)

@ref【インライン参照】

メモ

概要

自動リンクされないインライン参照を記述
参照先 (カッコ内は、"リンクテキスト"が省略された場合のリンクテキスト)
- @file【ファイル情報】 (ファイル名)
- @mainpage【メインページ】 (ページのタイトル)
- @page【ページ】 (ページのタイトル)
- @section【セクション】 (セクションのタイトル)
- @subsection【サブセクション】 (サブセクションのタイトル)
- @subsubsection【サブサブセクション】 (サブサブセクションのタイトル)
- @paragraph【パラグラフ】 (パラグラフのタイトル)
- @anchor【アンカー】 (アンカー名)
- @defgroup【グループ定義】 (グループ名)
- @addtogroup【グループ定義追加 (優先)】 (グループ名)
- @weakgroup【グループ定義追加 (通常)】 (グループ名)
自動リンクされるインライン参照を指定テキストにするには、以下を利用
- @link【インライン参照ブロック (開始)】・@endlink【インライン参照ブロック (終了)】

外部リンク

Doxygen Special Commands (英語)
- \ref

構文

@ref 参照先 ["リンクテキスト"]

参照先：メインページは、index を使用

例

/// @page page_ref_1 ページ：@ref【インライン参照】
/// 
/// @ref index "メインページへ"・
/// @ref index
/// @n
/// @ref page_ref_2 "別ページへ"・
/// @ref page_ref_2
/// @n
/// @ref section_ref_1 "セクション１へ"・
/// @ref section_ref_1
/// @n
/// @ref subsection_ref_1 "サブセクション１へ"・
/// @ref subsection_ref_1
/// @n
/// @ref subsubsection_ref_1 "サブサブセクション１へ"・
/// @ref subsubsection_ref_1
/// @n
/// @ref paragraph_ref_1 "パラグラフ１へ"・
/// @ref paragraph_ref_1
/// @n
/// @ref anchor_ref_1 "アンカー１へ"・
/// @ref anchor_ref_1
/// @n
/// @ref GROUP_REF "グループへ"・
/// @ref GROUP_REF
/// 
/// ---
/// @section section_ref_1 セクション タイトル (1)
/// セクション コンテンツ
/// 
/// ---
/// @subsection subsection_ref_1 サブセクション タイトル (1)
/// サブセクション コンテンツ
/// 
/// ---
/// @subsubsection subsubsection_ref_1 サブサブセクション タイトル (1)
/// サブサブセクション コンテンツ
/// 
/// ---
/// @paragraph paragraph_ref_1 パラグラフ タイトル (1)
/// パラグラフ コンテンツ
/// 
/// ---
/// @anchor anchor_ref_1
/// アンカー

/// @mainpage メインページ
/// メインページ コンテンツ

/// @page page_ref_2 別ページ

/// @defgroup GROUP_REF グループ (@@ref)
/// @{
class ClassRef {
    void methodRef() { }
};

int intRef;

void funcSee() { }

/// @}

HTML出力例

ページ：@ref【インライン参照】

メインページへ・メインページ
 別ページへ・別ページ
 セクション１へ・セクションタイトル (1)
サブセクション１へ・サブセクションタイトル (1)
サブサブセクション１へ・サブサブセクションタイトル (1)
パラグラフ１へ・パラグラフタイトル (1)
アンカー１へ・ anchor_ref_1
グループへ・グループ (@ref)

セクションタイトル (1)

セクションコンテンツ

サブセクションタイトル (1)

サブセクションコンテンツ

サブサブセクションタイトル (1)

サブサブセクションコンテンツ

パラグラフタイトル (1)

パラグラフコンテンツ

アンカー

@link【インライン参照ブロック (開始)】
@endlink【インライン参照ブロック (終了)】

メモ

概要

インライン参照ブロックを記述
- クラス等の自動的にリンクが作成されるオブジェクトに対して、リンクテキストを指定
- 自動リンクされないインライン参照は、@ref【インライン参照】を利用

外部リンク

Doxygen Special Commands (英語)
- \link
- \endlink

構文

@link リンク先オブジェクト
リンクテキスト
@endlink

例

/// @page page_link ページ：@link・@endlink【インライン参照ブロック】
/// 
/// ClassLink (自動リンク)
/// ・
/// @link ClassLink クラスへのリンク (1) @endlink
/// ・
/// @link ClassLink
/// クラスへのリンク (2)
/// @endlink
/// ・
/// @link ClassLink
/// クラスへの
/// リンク (3)
/// @endlink


/// @brief 概要 (ClassLink)
/// @details 詳細 (ClassLink)
class ClassLink { };

HTML出力例

ページ：@link・@endlink【インライン参照ブロック】

ClassLink (自動リンク) ・クラスへのリンク (1) ・クラスへのリンク (2) ・クラスへのリンク (3)

@anchor【アンカー】

メモ

概要

@ref【インライン参照】のリンク先となるアンカーを記述
- 表示上の変化なし
- @mainpage【メインページ】・@page【ページ】・その他位置に記述可能

外部リンク

Doxygen Special Commands (英語)
- \anchor

構文

@anchor アンカー名

例

/// @page page_anchor ページ：@anchor【アンカー】
/// @section section_anchor セクション タイトル
/// セクション コンテンツ
/// @n
/// @ref anchor_1 "アンカー１へ"・@ref anchor_1
/// @n
/// @ref anchor_2 "アンカー２へ"・@ref anchor_2
/// @n
/// @ref anchor_class "アンカー (クラス)へ"・@ref anchor_class
/// @n
/// @ref anchor_method "アンカー (メソッド)へ"・@ref anchor_method
/// 
/// @anchor anchor_1
/// アンカー１ コンテンツ
/// 
/// @anchor anchor_2
/// アンカー２ コンテンツ


/// @brief 概要 (ClassAnchor)
/// @details 詳細 (ClassAnchor)
/// @anchor anchor_class
class ClassAnchor {
    /// @brief 概要 (methodAnchor)
    /// @details 詳細 (methodAnchor)
    /// @anchor anchor_method
void methodAnchor() { }
};

HTML出力例

ページ：@anchor【アンカー】

セクションタイトル

セクションコンテンツ
アンカー１へ・anchor_1
アンカー２へ・anchor_2
アンカー (クラス)へ・anchor_class
アンカー (メソッド)へ・anchor_method

アンカー１コンテンツ

アンカー２コンテンツ

@secreflist【参照リスト (開始)】
@endsecreflist【参照リスト (終了)】
@refitem【参照リスト項目】

メモ

概要

参照リストを記述 (複数列で出力)
参照先

外部リンク

Doxygen Special Commands (英語)

構文

@secreflist
@refitem 参照先 リンクテキスト
...
@endsecreflist

例

/// @page page_refitem_1 ページ：参照リスト
/// 参照リスト
/// ==========
///
/// @secreflist
/// @refitem index メインページ
/// @refitem section_refitem_1 セクション１
/// @refitem subsection_refitem_1 サブセクション１
/// @refitem subsubsection_refitem_1 サブサブセクション１
/// @refitem paragraph_refitem_1 パラグラフ１
/// @refitem anchor_refitem_1 アンカー１
/// @refitem page_refitem_2 他ページ
/// @refitem section_refitem_2 セクション２
/// @refitem subsection_refitem_2 サブセクション２
/// @refitem subsubsection_refitem_2 サブサブセクション２
/// @refitem paragraph_refitem_2 パラグラフ２
/// @refitem anchor_refitem_2 アンカー２
/// @endsecreflist
/// 
/// ---
/// @section section_refitem_1 セクション１
/// セクション１ コンテンツ
///
/// @anchor anchor_refitem_1
/// アンカー１
///
/// ---
/// @subsection subsection_refitem_1 サブセクション１
/// サブセクション１ コンテンツ
/// 
/// ---
/// @subsubsection subsubsection_refitem_1 サブサブセクション１
/// サブサブサブセクション１ コンテンツ
/// 
/// ---
/// @paragraph paragraph_refitem_1 パラグラフ１
/// パラグラフ１ コンテンツ


/// @mainpage メインページ
/// メインページ コンテンツ


/// @page page_refitem_2 ページ：被参照リスト
/// @section section_refitem_2 セクション２
/// セクション２ コンテンツ
///
/// @anchor anchor_refitem_2
/// アンカー２
/// 
/// ---
/// @subsection subsection_refitem_2 サブセクション２
/// サブセクション２ コンテンツ
/// 
/// ---
/// @subsubsection subsubsection_refitem_2 サブサブセクション２
/// サブサブサブセクション２ コンテンツ
/// 
/// ---
/// @paragraph paragraph_refitem_2 パラグラフ２
/// パラグラフ２ コンテンツ

HTML出力例

ページ：参照リスト

参照リスト

メインページ
セクション１
サブセクション１
サブサブセクション１
パラグラフ１
アンカー１
他ページ
セクション２
サブセクション２
サブサブセクション２
パラグラフ２
アンカー２

セクション１

セクション１コンテンツ

アンカー１

サブセクション１

サブセクション１コンテンツ

サブサブセクション１

サブサブサブセクション１コンテンツ

パラグラフ１

パラグラフ１コンテンツ

【その他ページは省略】

メモ

概要

特定クラスに強く関連する非フレンド関数を記述
- @related【関連関数 (クラス専用)】・@relates【関連関数 (クラス専用)】は、ファイル内関数の出力なし

外部リンク

Doxygen Special Commands (英語)

構文

@related クラス名 
@relates クラス名

@relatedalso クラス名 
@relatesalso クラス名

例

/// @brief 概要 (ClassRelated)
/// @details 詳細 (ClassRelated)
class ClassRelated {
    friend void funcRelatedFriend();
};


/// @brief 概要 (funcRelatedFriend)
/// @details 詳細 (funcRelatedFriend)
void funcRelatedFriend() { }


/// @related ClassRelated
/// @brief 概要 (funcRelated_1)
/// @details 詳細 (funcRelated_1)
void funcRelated_1() { }


/// @relatedalso ClassRelated
/// @brief 概要 (funcRelated_2)
/// @details 詳細 (funcRelated_2)
void funcRelated_2() { }

HTML出力例

ClassRelated クラス

概要 (ClassRelated) [詳解]

フレンド
void	funcRelatedFriend ()
	概要 (funcRelatedFriend)

関連関数
（これらはメソッドではありません）
void	funcRelated_1 ()
	概要 (funcRelated_1)

void	funcRelated_2 ()
	概要 (funcRelated_2)

詳解

概要 (ClassRelated)

詳細 (ClassRelated)

【以下省略】

省略 ^1.8.14	Ver. 1.8.14 対応
^x.y.z ^x.y.z	Ver. x.y.z 対応
^x.y.z ^x.y.z	Ver. x.y.z で廃止
	単一の単語
	行末までが対象
	次の段落までが対象
構文：[～]	～は省略可能
構文：[～]	[と] はそのまま記述
構文：x\|y	x または y
構文： \|	\| はそのまま記述
	半角スペース
	Graphviz を使用
	Mscgen を使用
	PlantUML を使用
	Dia を使用
Link	別リファレンスリンク
Link	外部リンク

@see【参照】@sa【参照】

メモ

概要

関連

外部リンク

構文

例

HTML出力例

@ref【インライン参照】

メモ

概要

関連

外部リンク

構文

例

HTML出力例

@link【インライン参照ブロック (開始)】@endlink【インライン参照ブロック (終了)】

メモ

概要

関連

外部リンク

構文

例

HTML出力例

@anchor【アンカー】

メモ

概要

関連

外部リンク

構文

例

HTML出力例

@secreflist【参照リスト (開始)】@endsecreflist【参照リスト (終了)】@refitem【参照リスト項目】

メモ

概要

関連

外部リンク

構文

例

HTML出力例

@related【関連関数 (クラス専用)】@relates【関連関数 (クラス専用)】@relatedalso【関連関数】@relatesalso【関連関数】

メモ

概要

関連

外部リンク

構文

例

HTML出力例

フレンド

関連関数

詳解

@see【参照】
@sa【参照】

@link【インライン参照ブロック (開始)】
@endlink【インライン参照ブロック (終了)】

@secreflist【参照リスト (開始)】
@endsecreflist【参照リスト (終了)】
@refitem【参照リスト項目】

@related【関連関数 (クラス専用)】
@relates【関連関数 (クラス専用)】
@relatedalso【関連関数】
@relatesalso【関連関数】