@mainpage【メインページ】
@page【ページ】
@subpage【ページ階層作成】
@mainpage【メインページ】
メモ
- メインページ (ルート) を記述
- 参照:@ref index ()
- 目次作成:@tableofcontents【ページ内目次作成】
- 関連:
構文
@mainpage [タイトル | notitle]
例
/// @mainpage メインページ
/// メインページ コンテンツ
///
/// @ref page1 "ページ1へ"
/// @page page1 ページ1
/// ページ1 コンテンツ
///
/// @ref index "メインページへ"
@page【ページ】
メモ
構文
@page ページ名 ページ タイトル
ページ名:文字と数字の組み合わせ (小文字の英数字を推奨)
大文字の英字を含む場合、CASE_SENSE_NAMES を YES に設定
例
/// @mainpage メインページ
/// メインページ コンテンツ
///
/// @ref page1 "ページ1へ"
/// @page page1 ページ1
/// ページ1 コンテンツ
///
/// @ref index "メインページへ"
@subpage【ページ階層作成】
メモ
- ページ階層を作成
- ページを子(サブ)ページに指定 (循環構造は不可)
- 同一ページを複数ページのサブページに指定可
- 関連
構文
@subpage ページ名 (@page 指定) ["サブページへのリンクテキスト"]
例
/// @page page_a ページA
/// ページA コンテンツ@n
/// @subpage subpage1 "サブページ1へ"
/// @page page_b ページB
/// ページB コンテンツ@n
/// @subpage subpage2
/// @page subpage1 サブページ1
/// サブページ1 コンテンツ@n
/// @subpage subpage2 "サブページ2へ"
/// @page subpage2 サブページ2
/// サブページ2 コンテンツ