「Doxywizard 設定」の編集履歴（バックアップ）一覧に戻る
Doxywizard 設定 - (2009/01/19 (月) 17:18:37) のソース
***Doxywizardの設定
このページでは、Doxywizardの各タブの設定を説明します。
// 今後の予定
// 1. そのまま転載になっているものの修正
// 2. まだ翻訳出来ていない所の翻訳
***Wizardタブの設定
[[こちら>Doxywizard Wizardタブ設定]]のページにて、Wizardタブの設定を説明します。
***Expertタブでの設定内容
//#image(Doxywizard 2-1.PNG)
Projectセクションの設定は[[こちら>Expertタブ Projectセクション設定]]です。
Buildtセクションの設定は[[こちら>Expertタブ Buildtセクション設定]]です。
Inputセクションの設定は[[こちら>Expertタブ Inputセクション設定]]です。
Source Browserセクションの設定は[[こちら>Expertタブ Source Browserセクション設定]]です。
Indexセクションの設定は[[こちら>Expertタブ Indexセクション設定]]です。
HTMLセクションの設定は[[こちら>Expertタブ HTMLセクション設定]]です。
#region(HTML タブ)
HTML タブ
GENERATE_HTML
HTML形式のドキュメントを生成する
OUTPUT_HTML
HTML形式のドキュメントを生成する出力パスを指定
HTML_FILE_EXTENSION
HTMLファイルの拡張子を指定
HTML_HEADER
HTMLファイルが利用するヘッダ部分をファイルで指定
HTML_FOOTER
HTMLファイルが利用するフッタ部分をファイルで指定
HTML_STYLESHEET
HTMLファイルが利用するスタイルシートをファイルで指定
HTML_ALIGN_MEMBERS
HTMLファイルが利用するヘッダ部分をファイルで指定
GENERATE_HTMLHELP
HTMLヘルプを作成
CHM_FILE
chmファイルのパス
HHC_LOCATION
hhc.exeのパス
GENERATE_CHI
???
BINARY_TOC
???
TOC_EXPAND
???
DISABLE_INDEX
ページ上部のインデックスを作成しない場合に指定
ENUM_VALUES_PRE_LINE
???
GENERATE_TREEVIEW
左サイドにドキュメントのツリービューを生成する場合に指定
TREEVIEW_WIDTH
ツリービューの幅
#endregion
#region(LaTeX タブ)
LaTeX タブ
GENERATE_LATEX
LaTeXのドキュメントを生成
LATEX_OUTPUT
出力先
LATEX_CMD_NAME
LaTeXのコマンド名
MAKEINDEX_CMD_NAME
インデックス作成コマンド名
COMPACT_LATEX
???
PAPER_TYPE
???
EXTRA_PACKAGES
???
LATEX_HEADER
???
PDF_HYPERLINKS
???
USE_PDFLATEX
???
LATEX_BATCHMODE
???
LATEX_HIDE_INDICES
???
#endregion
#region(RTF タブ)
RTF タブ
GENERATE RTF
RTFを作成
RTF_OUTPUT
出力先
COMPACT_RTF
???
RTF_HYPERLINK
???
RTF_STYLESHEET_FILE
???
RTF_EXTENSIONS_FILE
???
#endregion
#region(Man タブ)
Man タブ
GENERATE_MAN
Unixのmanコマンド用ドキュメントの作成
MAN_OUTPUT
出力先
MAN_EXTENSION
???
MAN_LINKS
???
#endregion
#region(XML タブ)
XML タブ
GENERATE_XML
XMLを出力
XML_OUTPUT
出力先
XML_SCHEMA
スキーマ
XML_DTD
DTD
XML_PROGRAMLISTING
???
#endregion
#region(DEF タブ)
DEF タブ
GENERATE_AUTOGEN_DEF
DEFを出力
#endregion
#region(PerlMod タブ)
PerlMod タブ
GENERATE_PERLMOD
???
PERLMOD_LATEX
???
PERLMOD_PRETY
???
PERLMOD_MAKEVER_PREFIX
???
#endregion
#region(Preprocessor タブ)
Preprocessor タブ
ENABLE_PREPROCESSING
このタグが設定されると、Doxygenはすべてのドキュメンテーションを含む
コードの構築物を占領するPerlモジュールファイルを生み出します。
ちなみに、現時点ではまだ実験的で不完全であることに注意してください。
MACRO_EXPANSION
このタグを設定すると、ソースコード内のすべてのマクロの名前を
拡大する設定をします。
設定しない場合(デフォルト)は、条件つきの編集だけは実行されます。
マクロ展開の制御方法でEXPAND_ONLY_PREDEFを設定することによって
行うことができます。
EXPAND_ONLY_PREDEF
EXPAND_ONLY_PREDEFとMACRO_EXPANSIONタグ両方が
設定されているならば、
マクロ拡大は、PREDEFINEDとEXPAND_AS_DEFINEDタグで指定される
マクロに限定されています。
SEARCH_INCLUDE
このタグがYES(デフォルト)に設定された場合、
ソースコードの中で#includeを発見するたびに、
INCLUDE_PATHタグ(下記参照)に指定されたディレクトリから
ファイルが捜されます。
INCLUDE_PATH
INCLUDE_PATHには、インクルードファイルを検索するディレクトリを
1つ以上指定することができます。
INCLUDE_FILE_PATTERN
インクルードファイルのパターン
PREDEFINE
???
EXPAND_AS_DEFINED
???
SKIP_FUNCTION_MACROS
???
#endregion
#region(External タブ)
External タブ
TAG_FILES
TAGFILESタグを使用して、1つまたはそれ以上のタグファイルを
指定することができる。
外部ドキュメントの初期位置は、各タグファイルに対して、
随意に付加することができる。
この位置を持たないタグファイルのフォーマットは次のとおり:
TAGFILES = file1 file2 ...
タグファイルに位置を付加するやり方は、次のとおり:
TAGFILES = file1=loc1 "file2 = loc2" ...
ここで、loc1とloc2は、相対パス、絶対パス、またはURLです。
各タグに対して位置が存在している場合、
リンクを正しいものにするためにinstalldoxツールを
実行する必要はありません。
GENERATE_TAGFILE
GENERATE_TAGFILEの後にファイル名が指定された場合、
doxygenは、読み込む入力ファイルに基づいてタグファイルを生成する。
ALLEXTERNALS
YES に設定された場合、
すべての外部クラスがクラスインデックスにリストされる。
NO の場合は、継承された外部クラスだけがリストされる。
EXTERNAL_GROUPS
YES であれば、
外部のグループはすべてモジュールインデックスにリストされる。
NO であれば、現行プロジェクトのグループだけがリストされる。
PERL_PATH
perlインタプリタの絶対パス名
#endregion
#region(Dot タブ)
Dot タブ
CLASS_DIAGRAMS
クラス図を生成する場合にチェック
MSCGEN_PATH
mscgenツールが存在するディレクトリの指定が出来る。
msc命令を使っているdoxygenコメントの範囲内で、
メッセージシーケンスチャートを定めることができます。
それからDoxygenは、msgenツールを走らせ、チャートを生み、
それをドキュメントに挿入します。
空のままにするならば、ツールはデフォルト検索パスで見つかるとされる。
HIDE_UNDOC_RELATIONS
ドキュメント化されていない関連は隠す
HAVE_DOT
doxygen は、コマンドパスから dot ツールを起動できると想定します。
このツールは、AT&T および Lucent Bell 研の
グラフ可視化ツールキットである、Graphviz の一部です。
このセクションで説明される他のオプションは、
このオプションが NO (デフォルト) に設定された場合は無効となります。
DOT_FONTNAME
使っているフォント名を指定することができます。
DOT_FONTSIZE
フォントのサイズをセットするのに用いります。
デフォルトのサイズは10ptです。
DOT_FONTPATH
デフォルトのフォント以外を使用する場合は、
このタグを使用してパスを設定することができます。
DOT_FONTNAMEを使用して指定します。
CLASS_GRAPH
クラス図に関して継承関係を生成する場合にチェック
COLLABORATION_GRAPH
コラボレーショングラフ
(クラス図に関して実装依存関係(継承、所有、クラス参照変数)を
生成する場合にチェック)
GROUP_GRAPHS
グループグラフ
UML_LOOK
継承・コラボレーション図をUMLスタイルで生成する場合にチェック
TEMPLATE_RELATION
doxygen は、テンプレートとそのインスタンスの間の関係を表示します。
INCLUDE_GRAPH
インクルードグラフ
INCLUDED_BY_GRAPH
インクルードしたグラフ
CALL_GRAPH
呼び出しグラフ
(参照先関係図を生成する場合にチェック)
CALLER_GRAPH
参照元関係図を生成する場合にチェック
GRAPHICAL_HIRARCY
グラフ化された全クラス階層図を生成する場合にチェック
DIRECTORY_GRAPH
ディレクトリグラフ
DOT_IMAGE_FORMAT
画像フォーマット
DOT_PATH
Graphvizの存在するパスを指定
DOT_FILE_DIRS
DOTファイルのディレクトリ
DOT_GRAPH_MAX_NODES
グラフに示されるノードの最大数をセットするのに用いられます。
グラフ内のノードの数がこの値より大きくなった場合、
doxygenはグラフの頭を切って短くします。
そして、それはノードを赤い箱として描写することによって視覚化されます。
また、グラフのサイズがMAX_DOT_GRAPH_DEPTHによって
さらに制限されることができる点に注意してください。
MAX_DOT_GRAPH_DEPTH
グラフの最大深さをセットするのに用いられます。
また、グラフのサイズがDOT_GRAPH_MAX_NODESによって
さらに制限されることができる点に注意してください。
例:
3と設定した場合は、ルートのフォルダから3階層まで指定できる
1または、2の場合は計算時間を大いに減らすことができます。
0を設定した場合は、デフォルトの深さ制限をしない設定になります。
DOT_TRANSPARENT
背景が透明の画像を生成する場合にチェック
DOT_MULTI_TARGET
一回の実行(コマンドラインで複数の -o,-T オプションを使って)で
複数の画像ファイルを生成する場合にチェック
MAX_DOT_GRAPH_WIDTH
最大幅
MAX_DOT_GRAPH_HEIGHT
最大高さ
GENERATE_LEGEND
凡例を生成する場合にチェック
DOT_CLEANUP
doxygen は様々な図を生成するのに使う、
dot の中間ファイルを削除します。
#endregion
#region(Search タブ)
Search タブ
SEARCHENGINE
HTMLドキュメントに検索機能をつける場合にチェック
(この機能を使うには、バージョン4.1.0以上のPHPを使っている
Webサーバを介して文書を見なければならない。)
#endregion
----
***このページの参考にさせていただいたサイト
Doxygen関連
-[[Doxygen>http://www.stack.nl/~dimitri/doxygen/]]の本家サイト(英語)
-[[takagi.in - 高木信尚ホームページ>http://takagi.in/]]様コンテンツ内[[Doxygen翻訳サイト>http://www.doxygen.jp/]]より
-[[Project D.E.V,AQUASPACE,そのたもろもろ 総合入り口>http://www.geocities.co.jp/project_dev/]]様コンテンツ内プログラムメモ内の[[doxygenのメモ >http://hp.vector.co.jp/authors/VA014436/prg_memo/index.html]]より
-[[uhaku @Wiki>http://www13.atwiki.jp/uhaku/]]様コンテンツ内[[Doxygen+Graphviz>http://www13.atwiki.jp/uhaku/pages/36.html]]より
----
