@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 参照先
例
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 を使用
例
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
例
HTML出力例
ページ:@link・@endlink【インライン参照ブロック】
ClassLink (自動リンク) ・ クラスへのリンク (1) ・ クラスへのリンク (2) ・ クラスへの リンク (3)
@anchor【アンカー】
メモ
概要
- @ref【インライン参照】のリンク先となるアンカーを記述
- 表示上の変化なし
- @mainpage【メインページ】・@page【ページ】・その他位置に記述可能
関連
- @see・@sa【参照】
- @ref【インライン参照】
- @link【インライン参照ブロック (開始)】・@endlink【インライン参照ブロック (終了)】
- @secreflist【参照リスト (開始)】・@endsecreflist【参照リスト (終了)】・@refitem【参照リスト項目】
外部リンク
構文
@anchor アンカー名
例
HTML出力例
ページ:@anchor【アンカー】
セクション タイトル
セクション コンテンツ
アンカー1へ・anchor_1
アンカー2へ・anchor_2
アンカー (クラス)へ・anchor_class
アンカー (メソッド)へ・anchor_method
アンカー1 コンテンツ
アンカー2 コンテンツ
@secreflist【参照リスト (開始)】
@endsecreflist【参照リスト (終了)】
@refitem【参照リスト項目】1.11.0
メモ
概要
- 参照リストを記述 (複数列で出力)
- 参照先
関連
外部リンク
構文
@secreflist
@refitem 参照先 リンクテキスト
...
@endsecreflist
例
@related【関連関数 (クラス専用)】
@relates【関連関数 (クラス専用)】
@relatedalso【関連関数】
@relatesalso【関連関数】
メモ
概要
- 特定クラスに強く関連する非フレンド関数を記述
- @related【関連関数 (クラス専用)】・@relates【関連関数 (クラス専用)】は、ファイル内関数の出力なし
関連
外部リンク
構文
@related クラス名
@relates クラス名
@relatedalso クラス名
@relatesalso クラス名
例
HTML出力例
ClassRelated クラス
概要 (ClassRelated) [詳解]
フレンド | |
void | funcRelatedFriend () |
概要 (funcRelatedFriend) | |
関連関数 | |
(これらはメソッドではありません) | |
void | funcRelated_1 () |
概要 (funcRelated_1) | |
void | funcRelated_2 () |
概要 (funcRelated_2) | |
詳解
概要 (ClassRelated)
詳細 (ClassRelated)
【以下省略】