在使用doxygen的文檔中引用struct成員不起作用;未出現結構成員在文檔

運行的doxygen爲在使用doxygen的文檔中引用struct成員不起作用;未出現結構成員在文檔

namespace BV 
{ 
namespace Data 
{ 
typedef struct Station { 
    uint offsetId;    //! The ID of a station is generated by adding an offset to a base (example: 1000) 
    uint id;     //! The ID of the station (see {@link Station.offsetId} for more details) 
    QString name;    //! Name of the station 
    QStringList lineSwitches; //! A list of available lines the passanger can switch to from the station 
} Station; 


... 
} 
}

返回警告

/home/USER/Projects/HelloWorld/src/csvparser.h:16：警告：無法解析鏈接`Station.offsetId」的\鏈接命令

起初我只用了的Station.offsetId但網上看後offsetId，而不是我看到一堆的例子（包括這裏SO）是WER e描述這是方式。除此之外，我還想在頭文件的其他部分引用此成員。

我不僅從上面得到警告，但我只是拍了一下我的結構生成的HTML文檔和我吃驚的是它甚至不是有：

公共屬性

UINT ID

The ID of a station is generated by adding an offset to a base (example: 1000)

的QString 名個

The ID of the station (see **Station.offsetId** for more details)

QStringList中lineSwitches

Name of the station.

的Station.offsetId只是一個破碎的鏈接。

來源

2017-10-19 rbaleksandar

。請查看文檔中的「將文檔放在成員之後」並將其更改爲/！！並將其報告回來。爲什麼使用構造{@link Station.offsetId}（您嘗試解釋某些內容，可能需要修改有點前面的評論之後），而不僅僅是Station.offsetId或\裁判Station.offsetId或#offsetId或\裁判offsetId？ – albert

啊，拍攝。我完全忘了''。至於'{@link ...}' - 我從開始使用doxygen開始就習慣了。然後我有很長的差距，現在我又開始了。我會研究你的兩個建議。 – rbaleksandar

它就像一個魅力。你可以發表你的評論作爲答案，以便我可以批准它。同樣，對於doxygen文檔，{@command ...}並不常見，即使對於@ @ link也是如此。我想這是創建某種範圍的花括號。否則，預計會有'@ endlink'。但我會嘗試使用'@ ref'來代替。 – rbaleksandar

如問題陳述的文檔使用//!爲註釋內容，這是爲成員之前使用。當會員使用//!<後有文件。另請參閱「將文檔放在成員之後」放在doxygen手冊中。

作爲第二個部分是沒有必要使用：{@link Station.offsetId}（其實\link也應該有一個\endlink更好的是使用\ref或#如\ref Station.offsetId或#offsetId或\ref offsetId或（這種情況下）只是Station.offsetId

來源

2017-10-20 17:07:42 albert

在使用doxygen的文檔中引用struct成員不起作用;未出現結構成員在文檔

回答

相關問題