@mainpage【メインページ】
@page【ページ】
@subpage【ページ階層作成】

@mainpage【メインページ】

メモ

概要

関連

外部リンク

構文

@mainpage [タイトル | notitle]

タイトルメインページタイトル
    notitleタイトルなし
    省略プロジェクト名

/// @mainpage メインページ
/// メインページ コンテンツ
///
/// @ref page1 "ページ1へ (相互リンク)"


/// @page page1 ページ1
/// ページ1 コンテンツ
///
/// @ref index "メインページへ (相互リンク)"

HTML出力例

【メインページ】

メインページ

メインページ コンテンツ

ページ1へ (相互リンク)

【ページ1 (page1)】

ページ1

ページ1 コンテンツ

メインページへ (相互リンク)


@page【ページ】

メモ

概要

関連

外部リンク

構文

@page ページ名 ページ タイトル

ページ名:文字と数字の組み合わせ (小文字の英数字を推奨)
大文字の英字を含む場合、CASE_SENSE_NAMES【ファイルシステムの大文字・小文字の区別有無】を YES に設定

/// @mainpage メインページ
/// メインページ コンテンツ
///
/// @ref page1 "ページ1へ (相互リンク)"


/// @page page1 ページ1
/// ページ1 コンテンツ
///
/// @ref index "メインページへ (相互リンク)"

HTML出力例

【メインページ】

メインページ

メインページ コンテンツ

ページ1へ (相互リンク)

【ページ1 (page1)】

ページ1

ページ1 コンテンツ

メインページへ (相互リンク)


@subpage【ページ階層作成】

メモ

概要

  • ページ階層を作成
    • @page【ページ】で作成したページを、該当ページの子(サブ)ページに指定 (循環構造は不可)
    • 同一ページを複数ページのサブページに指定可

関連

外部リンク

構文

@subpage ページ名 (@page 指定) ["サブページへのリンクテキスト"]

ページ名@page【ページ】指定のページ名
"サブページへのリンクテキスト"リンクテキスト (省略:@page【ページ】指定のページ タイトル)

/// @page page_a ページA
/// @ref page_b "ページBへ (相互リンク)"
/// @n
/// @subpage subpage1 "サブページ1へ"


/// @page page_b ページB
/// @ref page_a "ページAへ (相互リンク)"
/// @n
/// リンクタイトル未指定:
/// @subpage subpage2


/// @page subpage1 サブページ1
/// @subpage subpage2 "サブページ2へ"


/// @page subpage2 サブページ2 (複数ページのサブページ)
/// @ref index "メインページへ"

HTML出力例

【左側ナビ】

サブページのツリービュー

【ページA (page_a)】

【ページB (page_b)】

【サブページ1 (subpage1)】

サブページ1

【サブページ2 (subpage2)】

サブページ2 (複数ページのサブページ)