カスタマイズ
出力対象
- 出力対象は下記を設定
トップページ・ユーザ定義ページ・その他ページ関連
- 各種ページ作成・ページ参照 等は下記を記述
トップページ @mainpage【メインページ】 ユーザ定義ページ @page【ページ】 ページ階層 @subpage【ページ階層作成】 ページ内の目次作成 @tableofcontents【ページ内の目次作成】 (HTML出力のみ) ユーザ参照 @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>【表のデータセル】
ファイル内容・コードブロック・テキストブロック
- ファイル内容・コードブロック・テキストブロックの記述
索引の生成
図の生成・挿入
ツール
- 下記ツールを使用し(一部はビルトインでも可)、図の生成・挿入が可能
各種設定
各種図表
| 図表 | 設定・コマンド |
|---|---|
| 自動作成 (HTML_DYNAMIC_SECTIONS【開閉可能セクションの有効化 (HTML出力のみ)】の対象) | |
| クラス図 | CLASS_DIAGRAMS【クラス図の生成有無 (dotツール未使用)】 CLASS_GRAPH【クラス図の生成有無 (dotツール使用)】 GRAPHICAL_HIERARCHY【全体のクラス階層図の生成有無】 |
| コラボレーション図 (コミュニケーション図) | COLLABORATION_GRAPH【コラボレーション図の生成有無】 |
| 呼び出し関係図 | CALL_GRAPH【呼び出し関係図の生成有無】 個別に指定する場合は、 @callgraph【呼び出し関係図 (生成あり)】 @hidecallgraph【呼び出し関係図 (生成なし)】 |
| 被呼び出し関係図 | CALLER_GRAPH【被呼び出し関係図の生成有無】 個別に指定する場合は、 @callergraph【被呼び出し関係図 (生成あり)】 @hidecallergraph【被呼び出し関係図 (生成なし)】 |
| ファイルのインクルード関係図 | INCLUDE_GRAPH【ファイルのインクルード関係図】 |
| ファイルの被インクルード関係図 | INCLUDED_BY_GRAPH【ファイルの被インクルード関係図】 |
| 手動作成 | |
| DOT図表 | @dot・@enddot【DOT：テキストブロック】 @dotfile【DOT：ファイル挿入】 (参照：DOTFILE_DIRS【DOTファイルパス (複数指定可)】) |
| メッセージシーケンスチャート | @msc・@endmsc【シーケンスチャート：テキストブロック】 @mscfile【シーケンスチャート：ファイル挿入】 (参照：MSCFILE_DIRS【mscファイルパス (複数指定可)】) |
| UML 等 | @startuml・@enduml【UML：テキストブロック】 |
| Dia図表 | @diafile【Dia：図表ファイル挿入】 (参照：DIAFILE_DIRS【Diaファイルパス (複数指定可)】) |
関連
左側ナビ・上部インデックス・検索ボックス 【HTML出力】
ページ生成日時の挿入 【HTML出力】
- ページ生成日時の挿入有無を、下記で設定
ヘッダ部・フッタ部・スタイルシート 【HTML出力】
- ヘッダ部・フッタ部・スタイルシートの変更は下記を設定
ヘッダ部 HTML_HEADER【ユーザー定義のヘッダ部HTMLファイル】 フッタ部 HTML_FOOTER【ユーザー定義のフッタ部HTMLファイル】 スタイルシート HTML_EXTRA_STYLESHEET【ユーザー定義の追加CSS】 (変更・追加分) - デフォルトファイルを下記で取得可
- doxygen -w html 【ヘッダ部HTMLファイル名】 【フッタ部HTMLファイル名】 【スタイルシート名】
- 関連
全体の色 【HTML出力】
- 全体の色を、下記で設定
- ウイザード：Wizard-Output-"HTML [Change color...]" (リアルタイム変更)
- 数値設定：
HTML_COLORSTYLE_HUE【色相】
HTML_COLORSTYLE_SAT【彩度】
HTML_COLORSTYLE_GAMMA【ガンマ補正】
- 関連