Expertタブ Buildtセクション設定


※上記の広告は60日以上更新のないWIKIに表示されています。更新することで広告が下部へ移動します。


Buildtセクションでの設定内容

Buildtセクション
EXTRACT_ALL
 全て抽出
 (ソースにドキュメントがなくてもドキュメント内の要素は
 全てドキュメント生成するする場合にチェック)
EXTRACT_PRIVATE
 privateを抽出
EXTRACT_STATIC
 staticを抽出
EXTRACT_LOCAL_CLASS
 ローカルクラス(インナクラス?)を抽出
EXTRACT_LOCAL_METHOD
 ローカル関数を抽出
EXTRACT_ANON_NSPACES
 ここが設定されると、anonymous namespaceのメンバーが抽出され、
 ドキュメントに表示されます。
 デフォルトではanonymous namespaceは隠れています。
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_GROUP_NAMES
 ここがYESに設定されると、グループ名の階層をアルファベット順に
 並び替えます。
 NO(デフォルト)だと、グループ名は定義された順序で表示されます。
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
 ディレクトリを表示
 (プロジェクトのソース階層が記載する場合にチェック)
SHOW_FILES
 Filesページの生成を抑制するときは、NOにしてください。
 フォルダのツリー表示をさせるときは、YES(デフォルト)にしてください。
SHOW_NAMESPACES
 NOに設定すると、Namespacesページの生成を無効にします。
 これは、クイックIndexからNamespacesエントリとフォルダの
 ツリー表示を表示させないようにする設定です。
 デフォルトはYESです。
FILE_VERSION_FILTER
 (大抵はバージョン制御システムから)各ファイルの現バージョンを
 取得しようとするプログラムやスクリプトを指定するのに使う。
 doxygenは、command input-fileコマンドを(popen() を介して)
 実行してプログラムを起動します。
 commandはこのタグの値で、input-fileはdoxygenが提供する
 入力ファイル名です。
 プログラムが標準出力に書き込むものが、ファイルバージョンとして
 使われます。
LAYOUT_FILE
 Doxygenで出力されるファイルのレイアウトを指定するために使用します。
 doxygenのデフォルトレイアウトファイルは、[DoxygenLayout.xml]です。
 ちなみに、ファイル名を任意に指定することができます。


このページの参考にさせていただいたサイト

Doxygen関連


ツールボックス

下から選んでください:

新しいページを作成する
ヘルプ / FAQ もご覧ください。