簡體   English   中英

C++ 函數的自定義 Doxygen 永久鏈接

[英]Custom Doxygen permalinks to c++ functions

我們使用 Doxygen 來記錄我們的 C++ 代碼,並使用 Breathe 插件將 Doxygen 結果包含在我們的 Sphinx HTML 文檔中。 我們想使用 HTML 鏈接中的命名錨直接跳轉到 HTML 文檔中的函數,如下所示:

http://path/MyClassDocumentation.html#myFunction(params)

這個想法是使用它們的簽名自動跳轉到我們可以在運行時動態檢索的函數。 我們如何在 C++ Doxygen 注釋中創建這些命名錨點? Breathe 創建 HTML 元素,這些元素使用它們的簽名和 md5 總和來處理函數。 示例:

<span id="my_class_my_function_1a21be2544e55395e0218006fca87a2a82"></span>

這沒有幫助,因為我們無法在運行時使用函數簽名跳轉到這些 id。 因此,我們要添加我們自己的命名錨點,它應該如下所示:

MyClass::MyFunc(paramList)

我嘗試在我們的評論中使用 "\\anchor",但似乎它們被忽略了。 有沒有辦法獲得我們可以在 C++ 代碼注釋中定義的命名錨點? 還是有另一種方法可以實現這一目標?

編輯:我認為我們需要的是定義自定義 html 永久鏈接,以從 Doxygen 注釋中解決我們的 C++ 代碼中的函數。

我有一個類似的問題,想從 docbook 文檔鏈接到 C 的 doxygen 文檔。

解決方案是使用 GENERATE_TAGFILE 配置參數從 doxygen 生成標記文件。

然后我使用一些自定義腳本解析標記文件以提取每個函數的錨值。

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM