他のDoxygenプロジェクトからOpenCVを相互参照する

前のチュートリアル: 移行ガイド

原著者	Sebastian Höffner
互換性	OpenCV >= 3.3.0

警告

このチュートリアルには古い情報が含まれている可能性がある。

OpenCVへの相互参照（クロスリファレンス）

Doxygen は、今読んでいるOpenCVドキュメントのようなドキュメントを生成するツールである。さまざまなソフトウェアプロジェクトで使われており、もしあなたが自身のドキュメント生成にこれを使っていて、かつプロジェクト内でOpenCVを使っているなら、この短いチュートリアルが役に立つ。

ドキュメントコード内に次のような警告があると想像してほしい:

/**
 * @warning This functions returns a cv::Mat.
 */

生成されたドキュメント内では、この警告はおおよそ次のように表示される:

警告

この関数は cv::Mat を返す。

一方、OpenCVドキュメント内では cv::Mat はリンクとしてレンダリングされる:

警告

この関数は cv::Mat を返す。

プロジェクト内でOpenCVドキュメントへのリンクを生成するには、2つの簡単な手順を実行するだけでよい。まず opencv.tag ファイルをダウンロードし（右クリックして「名前を付けて保存...」を選択する）、プロジェクトディレクトリのどこか、たとえば docs/doxygen-tags/opencv.tag として配置する。

好みのテキストエディタでDoxyfileを開き、キー TAGFILES を検索する。次のように変更する:

TAGFILES = ./docs/doxygen-tags/opencv.tag=http://docs.opencv.org/4.13.0

すでに他の定義があった場合は、\ を使って行を追加できる:

TAGFILES = ./docs/doxygen-tags/libstdc++.tag=https://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen \
           ./docs/doxygen-tags/opencv.tag=http://docs.opencv.org/4.13.0

これでDoxygenはタグファイルの情報を使ってOpenCVドキュメントへリンクできるようになる。今すぐドキュメントを再ビルドしよう！

覚え書き

他の人も *.tag ファイルを使ってあなたのドキュメントへリンクできるようにするには、GENERATE_TAGFILE = html/your_project.tag を設定する。これでドキュメントのルートディレクトリに your_project.tag ファイルが含まれるようになる。

参考文献

• Doxygen: 外部ドキュメントへのリンク
• opencv.tag