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

@mainpage【メインページ】

メモ

概要

関連

外部リンク

構文

@mainpage [タイトル | notitle]

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

例

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


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

HTML出力例

【メインページ】

メインページ

メインページ コンテンツ

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

【ページ１ (page1)】

ページ１

ページ１ コンテンツ

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

@page【ページ】

メモ

概要

関連

外部リンク

構文

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

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

例

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


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

HTML出力例

【メインページ】

メインページ

メインページ コンテンツ

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

【ページ１ (page1)】

ページ１

ページ１ コンテンツ

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

@subpage【ページ階層作成】

メモ

概要

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

関連

外部リンク

構文

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

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

例

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


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


/// @page subpage1 サブページ１
/// @subpage subpage2 "サブページ２へ"


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

HTML出力例

【左側ナビ】

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

【ページＡ (page_a)】

【ページＢ (page_b)】

【サブページ１ (subpage1)】

サブページ１

サブページ２へ

【サブページ２ (subpage2)】

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

メインページへ