在使用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成员不起作用;未出现结构成员在文档

回答

相关问题