@see・@sa【参照】
@ref【インライン参照】
@link・@endlink【インライン参照ブロック】
@anchor【アンカー】
@secreflist・@endsecreflist【参照リスト】・@refitem【参照リスト項目】
@see【参照】
@sa【参照】
メモ
- 参照を記述
- 参照先は、クラス・関数・メソッド・変数・ファイル・URL・クラスメンバ・オーバーロードメソッド・コンストラクタ
- 隣接する複数の @see・@sa【参照】コマンドは1つの段落に結合
- 関連
構文
@see 参照先
@sa 参照先
例
@ref【インライン参照】
メモ
- 自動リンクされないインライン参照を記述
- 参照先は、(カッコ内は、"リンクテキスト"が省略された場合のリンクテキスト)
名前付き@section【セクション】 (セクションのタイトル)
@subsection【サブセクション】 (サブセクションのタイトル)
@subsubsection【サブサブセクション】 (サブサブセクションのタイトル)
@paragraph【パラグラフ】 (パラグラフのタイトル)
@mainpage【メインページ】 (ページのタイトル)
@page【ページ】 (ページのタイトル)
@anchor【アンカー】 (アンカー名) - 自動リンクされるインライン参照は、@link【インライン参照ブロック (開始)】・@endlink【インライン参照ブロック (終了)】を利用
- 参照先は、(カッコ内は、"リンクテキスト"が省略された場合のリンクテキスト)
- 関連
構文
@ref 参照先 ["リンクテキスト"]
参照先:メインページは、index を使用
例
/// @ref sec1 "セクション1"・
/// @ref sub1 "サブセクション1"・
/// @ref subsub1 "サブサブセクション1"・
/// @ref paragraph1 "パラグラフ1"
/// @n
/// @ref anchor1 "アンカー1"・
/// @ref anchor_example
/// @n
/// @ref index
/// ・
/// @ref page1
【HTML出力例】
@link【インライン参照ブロック (開始)】
@endlink【インライン参照ブロック (終了)】
メモ
- インライン参照ブロックを記述
- クラス等の自動的にリンクが作成されるオブジェクトに対して、リンクテキストを指定
- 自動リンクされないインライン参照は、@ref【インライン参照】を利用
- 関連
構文
@link リンク先オブジェクト
【リンクテキスト】
@endlink
例
@anchor【アンカー】
メモ
構文
@anchor アンカー名
例
/// @page page_anchor1 ページ:アンカー1
/// @anchor anchor1
/// @ref anchor2 "アンカー2"
/// @page page_anchor2 ページ:アンカー2
/// @anchor anchor2
/// @ref anchor1 "アンカー1"
@secreflist【参照リスト (開始)】
@endsecreflist【参照リスト (終了)】
@refitem【参照リスト項目】
メモ
構文
@secreflist
@refitem 参照先 リンクテキスト
...
@endsecreflist
例
/// @secreflist
/// @refitem index メインページ
/// @refitem page1 ページ1
/// @refitem page2 ページ2
/// @refitem Class1 クラス1
/// @refitem Class2 クラス2
/// @refitem Class3 クラス3
/// @refitem section1 セクション1
/// @refitem sub1 サブセクション1
/// @refitem subsub1 サブサブセクション1
/// @endsecreflist
【HTML出力例】