上一教程： 迁移指南


原作者	Sebastian Höffner
兼容性	OpenCV >= 3.3.0

交叉引用OpenCV

Doxygen 是一款用于生成文档的工具，例如您正在阅读的OpenCV文档。许多软件项目都使用它，如果您也用它来生成自己的文档，并且在项目中使用了OpenCV，那么本简短教程将对您有所帮助。

想象一下您的文档代码中的这个警告

/**
* @warning 此函数返回一个 cv::Mat。
 */

在生成的文档中，此警告看起来大致如下

而在OpenCV文档中，cv::Mat 会被渲染成一个链接

要在您的项目中生成指向OpenCV文档的链接，您只需要执行两个简单的步骤。首先下载文件 opencv.tag（右键单击并选择“另存为…”）并将其放置在项目目录中的某个位置，例如 docs/doxygen-tags/opencv.tag。

使用您喜欢的文本编辑器打开您的Doxyfile，并搜索关键字TAGFILES。将其更改如下：

TAGFILES = ./docs/doxygen-tags/opencv.tag=https://docs.opencv.ac.cn/4.11.0

如果您已经有其他定义，可以使用\追加该行：

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

./docs/doxygen-tags/opencv.tag=https://docs.opencv.ac.cn/4.11.0

现在，Doxygen可以使用标签文件中的信息链接到OpenCV文档。立即重建您的文档！

注意: 为了允许其他人也使用 *.tag 文件链接到您的文档，请设置 GENERATE_TAGFILE = html/your_project.tag。您的文档现在将在其根目录中包含一个 your_project.tag 文件。

参考