上一個教程: 過渡指南


原始作者	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.tw/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.tw/4.12.0

Doxygen 現在可以使用標籤檔案中的資訊來連結到 OpenCV 文件。立即重新構建您的文件！

注意: 要允許其他人也使用 *.tag 檔案來連結到您的文件，請設定 GENERATE_TAGFILE = html/your_project.tag。您的文件現在將在其根目錄中包含一個 your_project.tag 檔案。