@see・@sa【参照】
@ref【インライン参照】
@link・@endlink【インライン参照ブロック】
@anchor【アンカー】
@secreflist・@endsecreflist【参照リスト】・@refitem【参照リスト項目】

@see・@sa【参照】

メモ

構文

@see 参照先
@sa 参照先

/// @see MyClass
/// @see myfunc

【HTML出力例】

参照
MyClass
myfunc

@ref【インライン参照】

メモ

構文

@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

/// MyClass (自動リンク)・
/// @link MyClass
/// クラスへのリンク
/// @endlink

【HTML出力例】

MyClass (自動リンク)・ クラスへのリンク

@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出力例】