カスタマイズ

出力対象

• 出力対象は下記を設定

  グローバル関数等
  グローバルな関数・変数・typedef・列挙型 (enum) を出力するには、@file【ファイル情報】の記述が必要
  クラス・メンバ等
  EXTRACT_ALL【有効コメントなし項目の詳細出力有無】 WARNINGS【警告メッセージの出力有無】は無視されて出力なし 下記は有効 ・EXTRACT_PRIVATE【プライベートメンバの出力有無】 ・EXTRACT_STATIC【静的メンバの出力有無】
  EXTRACT_ANON_NSPACES【匿名名前空間メンバの出力有無】
  EXTRACT_LOCAL_CLASSES【ローカル定義のクラス・構造体の出力有無】
  EXTRACT_LOCAL_METHODS【ローカルメソッドの出力有無 (Objective-C)】
  EXTRACT_PACKAGE【パッケージ・内部スコープの全メンバの出力有無】
  EXTRACT_PRIVATE【クラスのプライベートメンバの出力有無】
  EXTRACT_STATIC【静的メンバの出力有無】
  HIDE_FRIEND_COMPOUNDS【friend（class | struct | union）宣言を非表示】
  HIDE_SCOPE_NAMES【フルクラスと名前空間のスコープを持つメンバを非表示】
  HIDE_UNDOC_CLASSES【有効コメントなしクラスをクラス階層で非表示】
  HIDE_UNDOC_MEMBERS【クラス・ファイルの有効コメントなしメンバを非表示】
  HIDE_UNDOC_RELATIONS【クラス図・コラボレーション図で未記述のクラス等を非表示】
  INLINE_INFO【インラインメンバに [inline] タグの挿入有無】
  ファイル
  CASE_SENSE_NAMES【ファイル名の大文字・小文字混在表示有無】
  FORCE_LOCAL_INCLUDES【<～> ではなく "～" でインクルードファイルをリスト】
  SHOW_GROUPED_MEMB_INC【グループ化メンバ毎のインクルードファイル表示有無】
  SHOW_USED_FILES【クラス・構造体の使用ファイルリストの表示有無】
  その他
  HIDE_IN_BODY_DOCS【関数内ドキュメントの非表示】
  INTERNAL_DOCS【内部文書の表示有無】 参照：@internal・@endinternal【内部文書】

トップページ・ユーザ定義ページ・その他ページ関連

• 各種ページ作成・ページ参照 等は下記を記述

  トップページ	@mainpage【メインページ】
  ユーザ定義ページ	@page【ページ】
  ページ階層	@subpage【ページ階層作成】
  ページ内の目次作成	@tableofcontents【ページ内目次作成】
  ユーザ参照	@ref【インライン参照】
  ページタイトル	HIDE_COMPOUND_REFERENCE【ページタイトル部分の追加文言の非表示】
  ファイルページ	SHOW_FILES【ファイルページの表示有無】 SHOW_INCLUDE_FILES【ファイルページのインクルードファイル表示有無】
  名前空間ページ	SHOW_NAMESPACES【名前空間ページの表示有無】
  メンバ毎のページ	SEPARATE_MEMBER_PAGES【メンバ毎のページの生成有無】
  各種例のページ	@example【例 (ファイル)】

ユーザ定義 (段落・一覧)・既存一覧の出力有無

• ユーザ定義の段落・一覧を記述

  段落 (一覧出力なし)	@par【ユーザ定義 (段落)】
  一覧 (一覧出力あり)	@xrefitem【ユーザ定義 (一覧)】

• 既存一覧の出力有無

  一覧定義	一覧出力有無の設定
  @bug【バグ (一覧)】	GENERATE_BUGLIST
  @deprecated【非推奨 (一覧)】	GENERATE_DEPRECATEDLIST
  @test【テストケース (一覧)】	GENERATE_TESTLIST
  @todo【TODO (一覧)】	GENERATE_TODOLIST

リスト・表

• リスト・表の記述

  項目番号なしリスト 入れ子不可	@arg・@li【リスト】
  項目番号なしリスト 入れ子可能	マークダウン【リスト】
  	HTML コマンド ・<ul>【項目番号なしリスト】 ・<li>【リスト項目】
  項目番号ありリスト 入れ子可能	マークダウン【リスト】
  	HTML コマンド ・<ol>【項目番号ありリスト】 ・<li>【リスト項目】
  表	マークダウン【表】
  	HTML コマンド ・<table>【表】 ・<tr>【表の行定義】 ・<th>【表のヘッダセル】 ・<td>【表のデータセル】

ファイル内容・コードブロック・テキストブロック

• ファイル内容・コードブロック・テキストブロックの記述

  ファイル内容	ドキュメント対象 ソースファイル	SOURCE_BROWSER【ソースファイルの埋め込み有無】 SOURCE_TOOLTIPS【ソースファイル内ハイパーリンクのツールチップの表示有無】
  	コードブロック	@include【コードブロック (ファイル)】 @includelineno【行番号付きコードブロック (ファイル)】 @snippet【コードブロック (ファイル指定部分)】 @snippetlineno【行番号付きコードブロック (ファイル指定部分)】 @dontinclude【コードブロック (ファイル・非表示)】 @line【コードブロック (１行表示)】 @skip【コードブロック (スキップ)】 @skipline【コードブロック (スキップ・１行表示)】 @until【コードブロック (範囲表示)】
  	テキストブロック	@verbinclude【テキストブロック (ファイル)】
  	ドキュメントコメント	@snippetdoc【ファイル部分挿入 (コマンド有効)】 @includedoc【ファイル挿入 (コマンド有効)】
  	例ファイル	@example【例 (ファイル)】
  コードブロック		@code【コードブロック (開始)】 @endcode【コードブロック (終了)】
  テキストブロック		@verbatim【テキストブロック (開始)】 @endverbatim【テキストブロック (終了)】

索引の生成

• 索引の関連設定

  ALPHABETICAL_INDEX【アルファベット順索引の生成有無】

  COLS_IN_ALPHA_INDEX【索引の列数】

  IGNORE_PREFIX【索引で無視するプレフィックス】 (複数指定可)

図の生成・挿入

左側ナビ・上部インデックス・検索ボックス 【HTML出力】

• 左側ナビ・上部インデックス・検索ボックスを下記で設定

  左側ナビ	GENERATE_TREEVIEW【左側ナビの作成有無】 TREEVIEW_WIDTH【左側ナビの初期幅】 FULL_SIDEBAR【左側ナビの全体使用】
  上部インデックス	DISABLE_INDEX【上部インデックスの無効化】 HTML_DYNAMIC_MENUS【上部インデックスの動的メニュー】
  検索ボックス	SEARCHENGINE【検索ボックスの作成有無】

• 関連
  • Doxygen (英語)：Customizing the output - Navigation

ページ生成日時の挿入 【HTML出力】

• ページ生成日時の挿入有無を、下記で設定
  • GENERATE_TREEVIEW【フッタのページ生成日時の挿入有無】

ヘッダ部・フッタ部・スタイルシート 【HTML出力】

• ヘッダ部・フッタ部・スタイルシートの変更は下記を設定

  ヘッダ部	HTML_HEADER【ユーザー定義のヘッダ部HTMLファイル】
  フッタ部	HTML_FOOTER【ユーザー定義のフッタ部HTMLファイル】
  スタイルシート	HTML_EXTRA_STYLESHEET【ユーザー定義の追加CSS】 (変更・追加分)

• デフォルトファイルを下記で取得可
  • doxygen -w html 【ヘッダ部HTMLファイル名】 【フッタ部HTMLファイル名】 【スタイルシート名】
• 関連
  • Doxygen (英語)：Customizing the output - Header, Footer, and Stylesheet changes

全体の色 【HTML出力】

• 全体の色を、下記で設定
  • ウイザード：Wizard-Output-"HTML [Change color...]" (リアルタイム変更)
  • 数値設定：
    HTML_COLORSTYLE_HUE【色相】
    HTML_COLORSTYLE_SAT【彩度】
    HTML_COLORSTYLE_GAMMA【ガンマ補正】
• 関連
  • Doxygen (英語)：Customizing the output - Overall Color