Doxytagの使い方

Doxytagは、小さなコマンドラインツールです。 Doxytagは、タグファイルを生成できます。タグファイルは、doxygenとともに使って、外部ドキュメント(doxygenが使う入力ファイルに内包されていないドキュメント)への参照を生成できます。

タグファイルには、外部ドキュメントでドキュメント付けされているファイルやクラス、メンバーについての情報が含まれます。 DoxytagはHTMLファイルから直接この情報を抽出します。その利点は、ドキュメントが抽出された元のソースを備えなくてよいことです。

もしソースが あれば、設定ファイルで GENERATE_TAGFILEの後ろにタグファイル名を置くことで、 doxygenにタグファイルを生成させることができるのでいいでしょう。

doxytagへの入力は、HTMLファイルのセットで構成されます。

重要:: タグファイルを使えば、doxygenが生成するリンクには ダミーリンクが内包されます。 ダミーリンクを実リンクに変更するには、 installdoxスクリプトを起動しなければなりません。 詳しくは、Installdox の使い方を参照してください。ダミーリンクは冗長に見えるかもしれませんが、外部ドキュメントを別の箇所に移動したい場合、特に有用です。その際、ドキュメントは doxygenで再生成する必要はなく、 installdoxを起動するだけです。

メモ:: HTMLファイルには決まった構造が必要なため、 doxygenかQtクラス・ブラウザ・ジェネレータで生成されたHTMLファイルしか使用できません。 DoxytagはHTMLファイルを読み込むだけで、変更は加えられません。

Doxytagは、ドキュメントを構成するHTMLファイルすべてのリスト、またはすべてのHTMLファイルを内包するディレクトリを期待します。どちらもなければ、カレントディレクトリから.html拡張子の全ファイルを読み込みます。 doxytagを-tフラグを使って実行すると、タグファイルを生成します。

例 1:

下記に示すように、 examplesディレクトリにおいて、ファイル example.cppがあるパッケージに含まれていて、それに対するソースがないとしましょう。 パッケージには、doxygenで生成されたHTMLドキュメントが含まれているとしましょう。

/** A Test class.
 *  More details about this class.
 */

class Test
{
  public:
    /** An example member function.
     *  More details about this function.
     */
    void example();
};

void Test::example() {}

/** \example example_test.cpp
 * This is an example of how to use the Test class.
 * More details about this example.
 */

このとき、examplesディレクトリから次のようにすれば、パッケージのそのHTMLファイルからタグファイルを生成できます。

doxytag -t example.tag example/html

from the examples directory. このタグファイルは、次の例のように、自分のソースコードとともに使えます。

/*! A class that is inherited from the external class Test.
*/

class Tag : public Test
{
  public:
    /*! an overloaded member. */
    void example();
};

これで、doxygenは、自分のドキュメント内部に、外部パッケージへのリンクを含むことになります。タグファイルはドキュメントの在り処を示さないので、doxygenが生成するinstalldoxスクリプトを起動することで指定しなければなりません(詳しくは、Installdox の使い方を参照)。

だれかが外部ドキュメントを別のディレクトリやURLに移動した場合は、スクリプトを再度起動するだけです。HTMLファイルのリンクはすべて更新されます。

ここをクリックすれば、タグファイルとソース断片だけを使ってdoxygenで生成した、HTMLドキュメントを参照できます。

例 2:

Qtドキュメントのタグファイルを生成するには、次のようにします。

doxytag -t qt.tag $QTDIR/doc/html

次のセクションに行く / インデックスに戻る