2012-02-01 72 views
19

我已經加入這個類評論:Doxygen的@link到URL不生成鏈接是否正確

@link http://www.google.com Google @endlink 

然而,當我使用的doxygen生成文檔,鏈接文本確實是「谷歌」,但這個鏈接是:

文件:///media/portable/Examples/Doxygen/link/html/classClass1.html

誰能解釋什麼錯誤?

回答

29

我認爲您錯誤地使用了\link。從doxygen documentation,\link被用來引用類似文件,類或成員的對象,並將其中的一個作爲其第一個參數。例如,如果我想引用一個類的方法func在類myClass,我會用

\link myClass::func link text ... \endlink 

與所有被認爲是一個鏈接文本餘下的參數。我認爲你的問題是你沒有傳遞一個有效的對象作爲第一個參數。我猜想classClass1是您試圖包含鏈接的文件中的下一個對象,這是\link命令引用的內容。

鏈接到網址

的Doxygen會自動生成URL鏈接,所以沒有必要圍繞與\link\endlink或任何其他命令的鏈接。所以刪除這些,看看是否解決了這個問題。

要手動指定鏈接文本,使用HTML的一個標籤:

<a href="linkURL">link text</a> 

有關的doxygen如何處理自動鏈接see this文檔頁的詳細信息。

+0

我明白了,謝謝克里斯! – 2012-02-01 16:51:11