このドキュメントでは、doxyfw の makefile の使用方法とオプションについて説明します。
cd doxyfw
makeこのコマンドは以下の処理を順次実行します。
cd doxyfw
make clean生成されたドキュメント (docs/doxygen、docs-src/doxybook2、xml) を削除します。
CATEGORY オプションを使用すると、ドキュメントを大分類ごとに生成できます。これにより、同一プロジェクト内で複数種類のドキュメントを管理できます。
CATEGORYcd doxyfw
make../Doxyfile.part../docs/doxygen/../docs-src/doxybook2/../xml/ (処理後削除)cd doxyfw
make CATEGORY=api../Doxyfile.part.api../docs/doxygen/api/../docs-src/doxybook2/api/../xml/api/ (処理後削除)cd doxyfw
make CATEGORY=apiこのコマンドは Doxyfile.part.api を使用し、API 向けのドキュメントを生成します。
cd doxyfw
make CATEGORY=internalこのコマンドは Doxyfile.part.internal を使用し、内部仕様向けのドキュメントを生成します。
cd doxyfw
make CATEGORY=testこのコマンドは Doxyfile.part.test を使用し、テスト向けのドキュメントを生成します。
特定の大分類のドキュメントのみを削除できます。
cd doxyfw
make clean CATEGORY=apiこのコマンドは docs/doxygen/api/、docs-src/doxybook2/api/、xml/api/ を削除します。
さらに、親ディレクトリ (docs/doxygen/、docs-src/doxybook2/、xml/) が空になった場合は、親ディレクトリも自動的に削除されます。
CATEGORY を使用する場合、メインプロジェクトのルートディレクトリに以下の命名規則でファイルを配置します。
Doxyfile.partDoxyfile.part.{CATEGORY}main-project/
+-- doxyfw/ # doxyfw サブモジュール
+-- Doxyfile.part # デフォルト設定
+-- Doxyfile.part.api # API ドキュメント設定
+-- Doxyfile.part.internal # 内部仕様ドキュメント設定
+-- Doxyfile.part.test # テストドキュメント設定
+-- prod/ # ソースコード各大分類に応じて、異なる入力ディレクトリやプロジェクト名を指定できます。
PROJECT_NAME = "API Documentation"
INPUT = prod/calc/includePROJECT_NAME = "Internal Specification"
INPUT = prod/calc/libsrc prod/calc/include
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YESPROJECT_NAME = "Test Documentation"
INPUT = test/srcCATEGORY が指定された場合、makefile は以下の処理を自動的に行います。
Doxyfile.part.{CATEGORY} を基本 Doxyfile と結合OUTPUT_DIRECTORY と XML_OUTPUT を書き換え
OUTPUT_DIRECTORY = ../docs/doxygen/{CATEGORY}XML_OUTPUT = ../../xml/{CATEGORY}makefile にはデバッグ用の XML バックアップ機能がコメントアウトされています。この機能を有効にすると、前処理前の XML ファイルを xml_org ディレクトリにバックアップできます。
バックアップディレクトリの構造は xml と同じ階層構造になります。
xml_org/xml_org/{CATEGORY}/makefile の以下の行のコメントを解除することで有効化できます。
# rm -rf $(XML_ORG_DIR)
# mkdir -p $(XML_ORG_DIR)
# cp -rp $(XML_DIR)/* $(XML_ORG_DIR)/および
# rm -rf $(XML_ORG_DIR)CATEGORY が指定された場合、clean ターゲットは以下の処理を自動的に行います。
docs/doxygen/{CATEGORY}/docs-src/doxybook2/{CATEGORY}/xml/{CATEGORY}/docs/doxygen/docs-src/doxybook2/xml/Doxyfile.part.{CATEGORY} が存在しない場合、基本 Doxyfile のみで生成されます。意図した設定でドキュメントが生成されない場合は、ファイル名と配置場所を確認してください。
複数の大分類を生成する場合は、個別に make コマンドを実行してください。
cd doxyfw
make CATEGORY=api
make CATEGORY=internal
make CATEGORY=test各大分類を個別にクリーンアップするか、親ディレクトリから直接削除してください。
cd doxyfw
make clean CATEGORY=api
make clean CATEGORY=internal
make clean CATEGORY=testまたは
rm -rf docs/doxygen/* docs-src/doxybook2/* xml/*