前一个教程： 过渡指南


原作者	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.10.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.10.0

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

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

参考