上一个教程: 过渡指南


原始作者	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.12.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.12.0

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

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