@section【セクション】
@subsection【サブセクション】
@subsubsection【サブサブセクション】
@paragraph【パラグラフ】
@tableofcontents【ページ内目次作成】1.8.15
@section【セクション】
@subsection【サブセクション】
@subsubsection【サブサブセクション】
@paragraph【パラグラフ】
メモ
概要
- セクション・サブセクション・サブサブセクション・パラグラフを記述
- @mainpage【メインページ】・@page【ページ】のみで有効
- @tableofcontents【ページ内目次作成】の対象 (高い階層から以下の順)
- @section【セクション】 (最上位層)
- @subsection【サブセクション】
- @subsubsection【サブサブセクション】
- @paragraph【パラグラフ】
関連
外部リンク
構文
@section セクション名 セクション タイトル
セクション名：別ページを含めて一意
@subsection サブセクション名 サブセクション タイトル
サブセクション名：別ページを含めて一意
@subsubsection サブサブセクション名 サブサブセクション タイトル
サブサブセクション名：別ページを含めて一意
@paragraph パラグラフ名 パラグラフ タイトル
パラグラフ名：別ページを含めて一意
例
@tableofcontents【ページ内目次作成】1.8.15
メモ
概要
- 該当ページ内の目次作成
- 表示対象 (高い階層から以下の順)
- 出力対象
HTML 出力のみ有効1.8.15
HTML・LaTeX・XML・DocBook に出力可 (オプション参照) 1.8.15
- 複数指定 1.8.15
表示範囲
1.8.15- オプション未指定
- すべて表示
- オプション 指定
- レベルで階層指定 (以下が表示対象)
- レベル１：@section【セクション】
- レベル２：@subsection【サブセクション】 まで
- レベル３：@subsubsection【サブサブセクション】 まで
- レベル４：@paragraph【パラグラフ】 まで
- レベル５ / 省略：すべて
関連
外部リンク
構文
@tableofcontents 1.8.15
@tableofcontents[{[オプション[:レベル]]...[,オプション[:レベル]]}] 1.8.15
オプション1.8.15：出力対象 (HTML | LaTeX | XML | DocBook)
全て省略：HTML と XML
レベル1.8.15：表示階層レベル
1 ～ 5：指定レベルまで表示
省略 / 6以上：5 (すべて表示)
※ { はコマンド直後に記述例
レベル指定なし
/// @page page_toc 目次付きページ
/// @tableofcontents
///
/// @section section1 セクション１
/// セクション１ コンテンツ
///
/// ---
/// @section section2 セクション２
/// セクション２ コンテンツ
/// @subsection sub2 サブセクション２
/// サブセクション２ コンテンツ
///
/// ---
/// @section section3 セクション３
/// セクション３ コンテンツ
/// @subsection sub3 サブセクション３
/// サブセクション３ コンテンツ
/// @subsubsection subsub3 サブサブセクション３
/// サブサブセクション３ コンテンツ
///
/// ---
/// @section section4 セクション４
/// セクション４ コンテンツ
/// @subsection sub4 サブセクション４
/// サブセクション４ コンテンツ
/// @subsubsection subsub4 サブサブセクション４
/// サブサブセクション４ コンテンツ
/// @paragraph paragraph4 パラグラフ４
/// パラグラフ４ コンテンツ
HTML出力例
目次付きページ
セクション１
セクション１ コンテンツ
セクション２
セクション２ コンテンツ
サブセクション２
サブセクション２ コンテンツ
セクション３
セクション３ コンテンツ
サブセクション３
サブセクション３ コンテンツ
サブサブセクション３
サブサブセクション３ コンテンツ
セクション４
セクション４ コンテンツ
サブセクション４
サブセクション４ コンテンツ
サブサブセクション４
サブサブセクション４ コンテンツ
パラグラフ４
パラグラフ４ コンテンツ
レベル指定
// 上記 @tableofcontents を以下に変更
/// @tableofcontents{HTML:2}