「Doxywizard 設定」の編集履歴（バックアップ）一覧に戻る
Doxywizard 設定 - (2009/01/19 (月) 13:58:52) のソース
***Doxywizardの設定
このページでは、Doxywizardのタグの設定を説明します。
// 今後の予定
// 1. そのまま転載になっているものの修正
// 2. まだ翻訳出来ていない所の翻訳
***Wizardタグの設定
#region(Project タブ)
Project タブ
Project name
プロジェクト名
Project version or id
バージョン情報
Source code directory
ソースコードが含まれるディレクトリ
Scan recursively
再帰的にスキャンするかどうかの設定
Destination directory
出力先のディレクトリ
#endregion
#region(Mode タブ)
Mode タブ
Select the desired extraction mode
解析範囲を設定します。
Documented entities only :
ドキュメント化された対象ファイルのみ
All entities :
全ての対象ファイル
Include cross-referenced source code in the output :
相互参照を含むソースコードを出力に含める
Select programming language to optimize the result for
対象言語を設定します。
Optimize for C++ output
C++出力用に最適化
Optimize for C++/CLI output
C++ 出力用に最適化
Optimize for Java or C# output
Java出力用に最適化
Optimize for C or PHP output
C出力用に最適化
Optimize for Fortran output
出力用に最適化
Optimize for VHDL output
出力用に最適化
#endregion
#region(Output タブ)
Output タブ
HTML
HTMLを出力します。
plain HTML
普通(?)のHTML
with frames and a navigation tree
フレームでナビゲーションツリーを表示する。
prepare for complessed HTML (.chm)
complessed HTML(.chm)の準備
(以下任意)
With search function (requires PHP enabled web server)
検索機能を有効にする (PHPのWebサーバーが必要)
LaTeX
LaTeX形式で出力します。
as intermediate format for hyperlinked PDF
中間形式としてハイパーリンクPDFファイルを生成する。
as intermediate format for PDF
中間形式としてPDFファイルを生成する。
as intermediate format for PostScript
中間形式としてポストスクリプトを生成する。
Man pages
Unixのmanコマンド用ドキュメントの作成
Rich Text Format(RTF)
リッチテキスト形式で出力します。
XML
XML形式で出力します。
#endregion
#region(Diagrams タブ)
Diagrams タブ
No diagrams
何も出しません
Use built-in class diagram generator
内蔵の図解ジェネレータを使用します。
Use dot tool from the GraphViz package to generate
GraphVizを使用します
Class diagrams
クラス図
Collaboration diagrams
コラボレーション図
Include dependency graphs
インクルード依存関係グラフ
Include by dependency graphs
インクルード依存関係グラフが含まれる
Overall Class
全体のクラス
Call graphs
呼び出しグラフ
Called by graphs
グラフによって呼び出される
#endregion
***Expertボタンでの設定内容
#region(Project タブ)
Project タブ
PROJECT_NAME
プロジェクト名を指定
(生成されるページのタイトルとしても使われる)
PROJECT_NUMBER
バージョン情報
(プロジェクト番号やリビジョン番号を指定)
OUTPUT_DIRECTORY
出力先
(出力先の基底となる場所を指定)
CREATE_SUBDIRS
サブディレクトリを作成し生成したドキュメントを
分配して配置
サブディレクトリを作成しない場合、
全ファイルが同じディレクトリに配置されます。
これは大量のソースファイルをドキュメント化したい場合に
ファイルシステムのパフォーマンスに問題を起こす可能性がある
OUTPUT_LANGUAGE
生成するドキュメントの記述言語を指定
(JapaneseとJapanese-enの違いは項目名が
英字かどうかの違い)
USE_WINDOWS_ENCODING
Windowsのエンコードを使用する場合にチェック
BRIEF_MEMBER_DESC
ファイルやクラスの説明中に、メンバ一覧の後に
簡易説明を置きます記載する場合にチェック
REPEAT_BRIEF
メンバやメソッドの簡易記述を
詳細記述の前にも置く場合にチェック
ABBREVIATE_BRIEF
いろいろなリストでテキストを整形するために使う、
ある程度識別力のある、 簡潔文略語化機能
ALWAYS_DETAILED_SEC
ALWAYS_DETAILED_SEC タグと REPEAT_BRIEF タグの
両方が[ YES ]に設定された場合、
簡易記述しかない場合においても
詳細記述セクションを生成する。
INLINE_INHERITED_MEMB
クラスのドキュメントにおいて、そのクラスの継承メンバー全部を、
正規のクラスメンバーのように見せる。
基底クラスのコンストラクタ、デストラクタ、代入演算子は表示されない。
FULL_PATH_NAMES
ファイルをフルパスファイルで表示する
STRIP_FROM_PATH
STRIP_FROM_PATH タグを定義することによって、
フルパスの一部を省くことができます。
省かれるのは、パスの先頭部分が定義された
(複数の)文字列の一つにマッチした場合だけです。
STRIP_FROM_INC_PATH
STRIP_FROM_INC_PATH タグは、クラスのドキュメントに記載された
パスの一部をユーザ定義で省くのに使える。
これによって、クラスを使う人がインクルードすべき
ヘッダファイルを伝えられる。
空白であれば、クラス定義を含むヘッダファイルの名前だけが使われる。
SHORT_NAMES
かなり短めの(あまり読み易くない)名前のファイルを作成します。
これは、DOS・Mac・CD-ROMといった、長い名前をサポートしていない
ファイルシステムを使用する場合に有用
JAVADOC_AUTOBRIEF
JavaDocスタイルのコメントの先頭行を簡易記述と解釈する場合にチェック
MULTILINE_CPP_IS_BRIEF
チェックすると、複数行 C++ 特別コメントブロック
(//! や /// コメントのブロック)を簡潔文として扱う。
(旧ver仕様になる?)
チェックしなければ、現行の
[複数行の C++ コメントブロックを詳細文として扱う]仕様になる
旧verが良ければこのタグをチェックしておく。
ただし、rational rose コメントは認識しなくなる。
DETAILS_AT_TOP
先頭付近にJavaDoc風の詳細な説明を記載する場合にチェック
INHERIT_DOCS
ドキュメントがないメンバーがあればそれが再実装するメンバーから
ドキュメントを引き継ぐ。
DISTRIBUTE_GROUP_DOC
メンバーのグループ化がドキュメント内で使われており、
タグがチェックされている場合、
doxygen は、グループ内の最初のメンバーのドキュメント(もしあれば)を、
そのグループの他のメンバーに対して再利用する。
デフォルトでは、グループ内のすべてのメンバーは、
明示的にドキュメント付られている必要がある。
TAB_SIZE
タブの幅
ALIASES
ドキュメント内でコマンドとして振る舞うような、
いくつかの別名を記述するのに使用される。
別名は、次の形式をしている。
名前=値
たとえば、次の行を追加すると、
"sideeffect=\par Side Effects:\n"
ドキュメント内で\sideeffect (or @sideeffect)というコマンドが
使えるようになる。
このコマンドは、結果として、"Side Effects:"という見出しを持つ
ユーザ定義のパラグラフを生成する。
別名の値のところに \n を置くと改行が挿入される。
OPTIMIZE_OUTPUT_FOR_C
プロジェクトが C のソースだけからなっている場合は、
このタグをチェックする。
doxygen は、より C に適合した出力を生成する。
たとえば、使用される名前のいくつかが異なっていたり、
全メンバーのリストが省略される、など。
OPTIMIZE_OUTPUT_FOR_JAVA
JavaやPythonのソースだけでプロジェクトを構成している場合は、
このタグをチェックする。
すると、その言語により合った出力が生成されます。
たとえば、名前空間はパッケージとして提示され、
修飾スコープは別の形で提示されるなど。
SUBGROUPING
同じタイプのクラスメンバーグループ(public関数群など)が、
そのタイプのサブグループ(Public関数セクションなど)として扱われる。
サブグループ化を避けるには NO にしてください。
\nosubgrouping コマンドでも避けられる。
#endregion
#region(Buildt タブ)
Buildt タブ
EXTRACT_ALL
全て抽出
(ソースにドキュメントがなくてもドキュメント内の要素は
全てドキュメント生成するする場合にチェック)
EXTRACT_PRIVATE
privateを抽出
EXTRACT_STATIC
staticを抽出
EXTRACT_LOCAL_CLASS
ローカルクラス(インナクラス?)を抽出
EXTRACT_LOCAL_METHOD
ローカル関数を抽出
HIDE_UNDOC_MEMBERS
ドキュメント化されていないメンバを隠す
HIDE_UNDOC_CLASSES
ドキュメント化されていないクラスを隠す
HIDE_FRIEND_COMPOUNDS
このタグを設定すれば、friend
(クラス、構造体、共用体)宣言はすべて隠される。
デフォルトであれば、これら宣言は文書に出力されます。
HIDE_IN_BODY_DOCS
このタグが設定してあると、関数本体の内部で見つかった文書ブロックは
すべて隠されます。
デフォルトであれば、これらブロックは関数の詳細文書ブロックに追加する。
INTERNAL_DOCS
このタグは、\internalコマンドに続く文書を出力するか否かを決定する。
デフォルトであれば、文書は除外される。
internal 文書を出力するのであれば、設定してする。
CASE_SCENE_NAMES
大文字・小文字の区別をしてドキュメントを生成
HIDE_SCOPE_NAMES
スコープ名を隠す
(クラスと名前空間のスコープをドキュメントに記載しない場合にチェック)
SHOW_INCLUDE_FILES
インクルードファイルを表示する
INLINE_INFO
インライン情報
SORT_MEMBER_DOCS
メンバをソートする
SORT_BRIEF_DOCS
クラスのメンバをアルファベット順にソートして記載する場合にチェック
SORT_BY_SCOPE_NAME
スコープ名でソート
GENERATE_TODOLIST
ToDoリストを作成
(やることリストを記載する場合にチェック)
GENERATE_TESTLIST
テストリストを作成
GENERATE_BUGLIST
バグリストを作成
GENERATE_DEPRECATEDLIST
推奨されないリストを記載する場合にチェック
ENABLE_SECTIONS
???
MAX_INITALIZER_LINE
変数やdefineの初期値がとれる最大の行数を決定する。
初期化子の行数が指定行数より多いと、出力されない。
初期化子を完全に隠すには、このタグを 0 にする。
変数や define の個々の値の出力は、\showinitializer コマンドや、
\hideinitializer コマンドを文書に使うことで制御できる。
SHOW_USE_FILE
利用しているファイルを表示
(クラスのドキュメントにおいて
元ととなったソースファイルを記載する場合にチェック)
SHOW_DIRECTORES
ディレクトリを表示
(プロジェクトのソース階層が記載する場合にチェック)
FILE_VERSION_FILTER
(大抵はバージョン制御システムから)各ファイルの現バージョンを
取得しようとするプログラムやスクリプトを指定するのに使う。
doxygenは、command input-fileコマンドを(popen() を介して)
実行してプログラムを起動します。
commandはこのタグの値で、input-fileはdoxygenが
提供する入力ファイル名です。
プログラムが標準出力に書き込むものが、ファイルバージョンとして使われます。
#endregion
#region(Message タブ)
Message タブ
QUIET
Doxygenからの生成時のメッセージを表示しない場合にチェック
WARNINGS
警告
WARN_IN_UNDOCUMENTED
ドキュメント化されていない場合の警告
WARN_IN_DOC_ERROR
ドキュメント化のエラー
WARN_NO_PARAMDOC
パラメタのないドキュメント
WARN_FORMAT
警告表示のフォーマット
WARN_LOGFILE
ログファイル
#endregion
#region(Input タブ)
Input タブ
INPUT
ソースファイルもしくはソースファイルが格納されている
ディレクトリの場所を指定
INPUT_ENCODING
ソースファイルのエンコードを指定
(EUC-JP, SHIFT_JIS, UTF-8等
(ここでSJISを指定すると日本語で表示ができる))
FILE_PATTERNS
INPUTで指定されたディレクトリの中から
ソースファイルとして利用する拡張子等パターンを指定
RECURSIVE
INPUTで指定されたディレクトリのサブディレクトにも
ソースファイルがある場合にチェック
EXCLUDE_SYMLINKS
シンボリックリンク(unixファイルシステムの特徴)
であるファイルやディレクトリを、
入力から除外するか否かを選ぶのに使います。
EXCLUDE_PATTERNS
???
EXSAMPLE_PATH
サンプルソースの検索パス
EXAMPLE_PATTERNS
サンプルソースのパターン
EXAMPLE_RECURSIVE
サンプルソースを再起的に検索
IMAGE_PATH
イメージファイルの検索パス
INPUT_FILTER
???
FILTER_PATTERNS
???
FILTER_SOURCE_FILES
???
#endregion
#region(Source Browser タブ)
Source Browser タブ
SOURCE_BROWSER
ソースブラウザ利用
(ソースファイルのリスト)
INLINE_BROWSER
インラインブラウザを利用
(クラス・メソッドなどの説明において該当ソース
そのものを記載する場合にチェック)
STRIP_CODE_COMMENT
???
REFERENCED_BY_RELATION
参照元の一覧を記載する場合にチェック
REFERENCES_RELATION
参照先の一覧を記載する場合にチェック
REFERENCES_LINK_SOURCE
参照先・参照元の一覧からソースコードにリンクする場合にチェック
VERBATIM_HEADERS
???
#endregion
#region(Index タブ)
Index タブ
ALPHABETICAL_INDEX
アルファベット順インデックスを生成する場合にチェック
COLS_IN_ALPHA_INDEX
???
IGNORE_PREFIX
???
#endregion
#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]]より
----
