Projectセクションでの設定内容
Project セクション
DOXYFILE_ENCODING
このタグは、以下の設定ファイル内全ての文字の使用を指定します。
デフォルトは、全てのテキストの為に、UTF-8になっています。
Doxygenは、トランスコーディングのために
libiconv(またはlibcに組み入れられるiconv)を使います。
全てのエンコーディングの一覧については
http://www.gnu.org/software/libiconv を参照してください。
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 コマンドでも避けられる。
TYPEDEF_HIDES_STRUCT
調査中
SYMBOL_CACHE_SIZE
メモリ内にシンボルの内部キャッシュのサイズを決定します。
このページの参考にさせていただいたサイト
Doxygen関連
最終更新：2009年01月27日 18:24
