Question

为

运行doxygen

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：警告：无法为\ link命令解析指向“Station.offsetId”的链接

最初我只有offsetId而不是Station.offsetId，但在网上看到后，我看到了一堆示例（包括SO），这些都是描述这一点的方式。此外，我还想在我的标题的其他部分引用这个成员。

我不仅从上面得到警告，而且我只看了一下我的结构生成的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 只是一个断开的链接。

Answer 1

问题中所述的文档使用//!作为注释字符串，这是为了在成员之前使用。在成员之后获得文档时，应使用//!<。另请参阅doxygen手册中的“在成员之后放置文档”。

作为第二部分，没有必要使用：{@link Station.offsetId}（实际上\link也应该有\endlink。更好的是使用\ref或{{1}例如#或\ref Station.offsetId或#offsetId或（仅此情况下）\ref offsetId。

使用doxygen工作时在文档中引用struct成员; struct成员没有出现在文档中

1 个答案: