プロジェクトが外部ライブラリやツールに依存している場合、Doxygenを実行するたびにそれらのソースをすべて含めない方が良い理由はいくつかあります。

ディスク容量

ドキュメントによっては、Doxygenの出力ディレクトリの外、例えばウェブ上のどこかに既に存在している場合があります。ローカル出力ディレクトリにドキュメントを生成する代わりに、これらのページにリンクしたい場合があります。

コンパイル速度

外部プロジェクトは通常、自身のプロジェクトとは異なる更新頻度を持っています。何も変更がない場合でも、これらの外部プロジェクトのソースをDoxygenに何度も解析させるのはあまり意味がありません。

メモリ

非常に大きなソースツリーの場合、Doxygenにすべてのソースを解析させると、システムのメモリを使いすぎてしまうことがあります。ソースをいくつかの「パッケージ」に分割することで、1つのパッケージのソースはDoxygenで解析できますが、このパッケージが依存する他のすべてのパッケージは外部からリンクされます。これにより、メモリを大幅に節約できます。

可用性

Doxygenでドキュメント化されているプロジェクトの中には、ソースが利用できないものもあります。

著作権の問題

外部パッケージとそのドキュメントの著作権が他の誰かにある場合、プロジェクトのドキュメントにコピーを含めるのではなく、それを参照する方が良い場合や、必須の場合さえあります。著者が再配布を禁止している場合、これは必須です。著者が再配布の前提条件として特定のライセンス条件の遵守を要求しており、あなたがそれらの条件に拘束されたくない場合、彼らのドキュメントのコピーを参照することが、コピーを含めることよりも望ましいです。

上記のいずれかに該当する場合、Doxygenのタグファイルメカニズムを使用できます。タグファイルは基本的に、外部ソースで見つかったエンティティのコンパクトな表現です。Doxygenはタグファイルを生成することも、読み取ることもできます。

プロジェクトのタグファイルを生成するには、設定ファイルのGENERATE_TAGFILEオプションの後にタグファイルの名前を指定するだけです。

1つまたは複数の外部プロジェクトの出力を自身のプロジェクトと組み合わせるには、設定ファイルのTAGFILESオプションの後にタグファイルの名前を指定する必要があります。

タグファイルには通常、Doxygenが実行された時点からのドキュメントの相対的な場所のみが含まれています。そのため、他のプロジェクトにタグファイルを含める場合、外部ドキュメントがこのプロジェクトに関連してどこにあるかを指定する必要があります。これは、設定ファイルのTAGFILES設定オプションの後に指定されたタグファイルに（相対的な）場所を割り当てることで行うことができます。相対パスを使用する場合、それはプロジェクトのHTML出力が生成されるディレクトリを基準とした相対パスである必要があります。つまり、プロジェクトのHTML出力ディレクトリから、リンク先の別プロジェクトのHTML出力までの相対パスとなります。

例: projというプロジェクトがあり、ext1とext2という2つの外部プロジェクトを使用していると仮定します。ディレクトリ構造は以下のようになります。

<root>
  +- proj
  |   +- html               HTML output directory for proj
  |   +- src                sources for proj
  |   |- proj.cpp
  +- ext1
  |   +- html               HTML output directory for ext1
  |   |- ext1.tag           tag file for ext1
  +- ext2
  |   +- html               HTML output directory for ext2
  |   |- ext2.tag           tag file for ext2
  |- proj.cfg               Doxygen configuration file for proj
  |- ext1.cfg               Doxygen configuration file for ext1
  |- ext2.cfg               Doxygen configuration file for ext2

: 次に、設定ファイルの関連部分は以下のようになります。

proj.cfg

OUTPUT_DIRECTORY  = proj
INPUT             = proj/src
TAGFILES          = ext1/ext1.tag=../../ext1/html \
                    ext2/ext2.tag=../../ext2/html

ext1.cfg

OUTPUT_DIRECTORY  = ext1
GENERATE_TAGFILE  = ext1/ext1.tag

ext2.cfg

OUTPUT_DIRECTORY  = ext2
GENERATE_TAGFILE  = ext2/ext2.tag

次のセクションに進むか、インデックスに戻ります。