@see・@sa【参照】
@ref【インライン参照】1.11.0
@link・@endlink【インライン参照ブロック】
@anchor【アンカー】
@secreflist・@endsecreflist【参照リスト】・@refitem【参照リスト項目】1.11.0
@related・@relates【関連関数 (クラス専用)】
@relatedalso・@relatesalso【関連関数】
@see【参照】
@sa【参照】
メモ
概要
- 参照を記述
- 隣接する複数の @see【参照】・@sa【参照】コマンドは1つの段落に結合
- 参照先
- クラス・メソッド・関数・変数・ファイル・URL・クラスメンバ・オーバーロードメソッド・コンストラクタ ・グループ
関連
- @ref【インライン参照】
- @link【インライン参照ブロック (開始)】・@endlink【インライン参照ブロック (終了)】
- @anchor【アンカー】
- @secreflist【参照リスト (開始)】・@endsecreflist【参照リスト (終了)】・@refitem【参照リスト項目】
- @defgroup【グループ定義】 ・@addtogroup【グループ定義追加 (優先)】 ・@weakgroup【グループ定義追加 (通常)】
外部リンク
構文
@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【参照】
@ref【インライン参照】1.11.0
メモ
概要
- 自動リンクされないインライン参照を記述
- 参照先 (カッコ内は、"リンクテキスト"が省略された場合のリンクテキスト)
- @file【ファイル情報】 (ファイル名)
- @mainpage【メインページ】 (ページのタイトル)
- @page【ページ】 (ページのタイトル)
- @section【セクション】 (セクションのタイトル)
- @subsection【サブセクション】 (サブセクションのタイトル)
- @subsubsection【サブサブセクション】 (サブサブセクションのタイトル)
- @paragraph【段落】 (段落のタイトル)
- @subparagraph【サブ段落】 (サブ段落のタイトル) 1.11.0
- @subsubparagraph【サブサブ段落】 (サブサブ段落のタイトル) 1.11.0
- @anchor【アンカー】 (アンカー名)
- @defgroup【グループ定義】 (グループ名)
- @addtogroup【グループ定義追加 (優先)】 (グループ名)
- @weakgroup【グループ定義追加 (通常)】 (グループ名)
- 自動リンクされるインライン参照を指定テキストにするには、以下を利用
関連
外部リンク
構文
@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 "セクション1へ"・@ref section_ref_1
/// @n
/// @ref subsection_ref_1 "サブセクション1へ"
/// ・@ref subsection_ref_1
/// @n
/// @ref subsubsection_ref_1 "サブサブセクション1へ"
/// ・@ref subsubsection_ref_1
/// @n
/// @ref paragraph_ref_1 "段落1へ"・@ref paragraph_ref_1
/// @n
/// @ref subparagraph_ref_1 "サブ段落1へ"
/// ・@ref subparagraph_ref_1
/// @n
/// @ref subsubparagraph_ref_1 "サブサブ段落1へ"
/// ・@ref subsubparagraph_ref_1
/// @n
/// @ref anchor_ref_1 "アンカー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)
/// 段落 コンテンツ
///
/// ---
/// @subparagraph subparagraph_ref_1 サブ段落 タイトル (1)
/// サブ段落 コンテンツ
///
/// ---
/// @subsubparagraph subsubparagraph_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)
サブサブセクション1へ・ サブサブセクション タイトル (1)
段落1へ・ 段落 タイトル (1)
サブ段落1へ・ サブ段落 タイトル (1)
サブサブ段落1へ・ サブサブ段落 タイトル (1)
アンカー1へ・ anchor_ref_1
グループへ・ グループ (@ref)
セクション タイトル (1)
セクション コンテンツ
サブセクション タイトル (1)
サブセクション コンテンツ
サブサブセクション タイトル (1)
サブサブセクション コンテンツ
段落 タイトル (1)
段落 コンテンツ
サブ段落 タイトル (1)
サブ段落 コンテンツ
サブサブ段落 タイトル (1)
サブサブ段落 コンテンツ
アンカー
@link【インライン参照ブロック (開始)】1.11.0
@endlink【インライン参照ブロック (終了)】1.11.0
メモ
概要
- インライン参照ブロックを記述
- クラス等の自動的にリンクが作成されるオブジェクトに対して、リンクテキストを指定
- @section【セクション】等のタイトルに指定可〔詳細・例:@section【セクション】 参照〕1.11.0
- 自動リンクされないインライン参照は、@ref【インライン参照】を利用
関連
外部リンク
構文
@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【ページ】・その他位置に記述可能
関連
- @see・@sa【参照】
- @ref【インライン参照】
- @link【インライン参照ブロック (開始)】・@endlink【インライン参照ブロック (終了)】
- @secreflist【参照リスト (開始)】・@endsecreflist【参照リスト (終了)】・@refitem【参照リスト項目】
外部リンク
構文
@anchor アンカー名
例
/// @page page_anchor ページ:@anchor【アンカー】
/// @section section_anchor セクション タイトル
/// セクション コンテンツ
/// @n
/// @ref anchor_1 "アンカー1へ"・@ref anchor_1
/// @n
/// @ref anchor_2 "アンカー2へ"・@ref anchor_2
/// @n
/// @ref anchor_class "アンカー (クラス)へ"・@ref anchor_class
/// @n
/// @ref anchor_method "アンカー (メソッド)へ"・@ref anchor_method
///
/// @anchor anchor_1
/// アンカー1 コンテンツ
///
/// @anchor anchor_2
/// アンカー2 コンテンツ
/// @brief 概要 (ClassAnchor)
/// @details 詳細 (ClassAnchor)
/// @anchor anchor_class
class ClassAnchor {
/// @brief 概要 (methodAnchor)
/// @details 詳細 (methodAnchor)
/// @anchor anchor_method
void methodAnchor() { }
};
HTML出力例
ページ:@anchor【アンカー】
セクション タイトル
セクション コンテンツ
アンカー1へ・anchor_1
アンカー2へ・anchor_2
アンカー (クラス)へ・anchor_class
アンカー (メソッド)へ・anchor_method
アンカー1 コンテンツ
アンカー2 コンテンツ
@secreflist【参照リスト (開始)】
@endsecreflist【参照リスト (終了)】
@refitem【参照リスト項目】1.11.0
メモ
概要
- 参照リストを記述 (複数列で出力)
- 参照先
関連
外部リンク
構文
@secreflist
@refitem 参照先 リンクテキスト
...
@endsecreflist
例
/// @page page_refitem_1 ページ:参照リスト
/// 参照リスト
/// ==========
///
/// @secreflist
/// @refitem index メインページ
/// @refitem section_refitem_1 セクション1
/// @refitem subsection_refitem_1 サブセクション1
/// @refitem subsubsection_refitem_1 サブサブセクション1
/// @refitem paragraph_refitem_1 段落1
/// @refitem subparagraph_refitem_1 サブ段落1
/// @refitem subsubparagraph_refitem_1 サブサブ段落1
/// @refitem anchor_refitem_1 アンカー1
/// @refitem page_refitem_2 他ページ
/// @refitem section_refitem_2 セクション2
/// @refitem subsection_refitem_2 サブセクション2
/// @refitem subsubsection_refitem_2 サブサブセクション2
/// @refitem paragraph_refitem_2 段落2
/// @refitem subparagraph_refitem_2 サブ段落2
/// @refitem subsubparagraph_refitem_2 サブサブ段落2
/// @refitem anchor_refitem_2 アンカー2
/// @endsecreflist
///
/// ---
/// @section section_refitem_1 セクション1
/// セクション1 コンテンツ
///
/// @anchor anchor_refitem_1
/// アンカー1
///
/// ---
/// @subsection subsection_refitem_1 サブセクション1
/// サブセクション1 コンテンツ
///
/// ---
/// @subsubsection subsubsection_refitem_1 サブサブセクション1
/// サブサブセクション1 コンテンツ
///
/// ---
/// @paragraph paragraph_refitem_1 段落1
/// 段落1 コンテンツ
///
/// ---
/// @subparagraph subparagraph_refitem_1 サブ段落1
/// サブ段落1 コンテンツ
///
/// ---
/// @subsubparagraph subsubparagraph_refitem_1 サブサブ段落1
/// サブサブ段落1 コンテンツ
/// @mainpage メインページ
/// メインページ コンテンツ
/// @page page_refitem_2 ページ:被参照リスト
/// @section section_refitem_2 セクション2
/// セクション2 コンテンツ
///
/// @anchor anchor_refitem_2
/// アンカー2
///
/// ---
/// @subsection subsection_refitem_2 サブセクション2
/// サブセクション2 コンテンツ
///
/// ---
/// @subsubsection subsubsection_refitem_2 サブサブセクション2
/// サブサブセクション2 コンテンツ
///
/// ---
/// @paragraph paragraph_refitem_2 段落2
/// 段落2 コンテンツ
///
/// ---
/// @subparagraph subparagraph_refitem_2 サブ段落2
/// サブ段落2 コンテンツ
///
/// ---
/// @subsubparagraph subsubparagraph_refitem_2 サブサブ段落2
/// サブサブ段落2 コンテンツ
HTML出力例
【その他ページは省略】
@related【関連関数 (クラス専用)】
@relates【関連関数 (クラス専用)】
@relatedalso【関連関数】
@relatesalso【関連関数】
メモ
概要
- 特定クラスに強く関連する非フレンド関数を記述
- @related【関連関数 (クラス専用)】・@relates【関連関数 (クラス専用)】は、ファイル内関数の出力なし
関連
外部リンク
構文
@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)
【以下省略】