@mainpage【メインページ】
@page【ページ】
@subpage【ページ階層作成】
@mainpage【メインページ】
メモ
概要
- メインページ (ルート) を記述
- 見出し:@section【セクション】等 (詳細:リンク先参照)
- 目次作成:@tableofcontents【ページ内目次作成】
- 参照:@ref index (@ref【インライン参照】)
関連
外部リンク
構文
@mainpage [タイトル | notitle]
タイトルメインページタイトル
notitleタイトルなし
省略プロジェクト名
例
@page【ページ】
メモ
概要
- ページを記述
- 見出し:@section【セクション】等 (詳細:リンク先参照)
- 目次作成:@tableofcontents【ページ内目次作成】
- 参照:@ref【インライン参照】
関連
外部リンク
構文
@page ページ名 ページ タイトル
ページ名:文字と数字の組み合わせ (小文字の英数字を推奨)
大文字の英字を含む場合、CASE_SENSE_NAMES【ファイルシステムの大文字・小文字の区別有無】を YES に設定
例
@subpage【ページ階層作成】
メモ
概要
- ページ階層を作成
- @page【ページ】で作成したページを、該当ページの子(サブ)ページに指定 (循環構造は不可)
- 同一ページを複数ページのサブページに指定可
関連
外部リンク
構文
@subpage ページ名 (@page 指定) ["サブページへのリンクテキスト"]
ページ名@page【ページ】指定のページ名
"サブページへのリンクテキスト"リンクテキスト (省略:@page【ページ】指定のページ タイトル)
例
HTML出力例
【左側ナビ】
【ページA (page_a)】
ページA
【ページB (page_b)】
ページB
ページAへ (相互リンク)
リンクタイトル未指定: サブページ2 (複数ページのサブページ)
【サブページ1 (subpage1)】
サブページ1
【サブページ2 (subpage2)】
サブページ2 (複数ページのサブページ)