当const在另一行时,Doxygen解析const成员函数

时间:2015-05-08 09:02:50

标签: c++ coding-style doxygen

我尝试在官方网站上搜索stackoverflow和users mailing list,但没有找到对我的问题有用的东西,有很多结果无关......

我使用的Doxygen是版本1.8.5。

我更喜欢像这样设置我的成员函数声明,让我们调用它 另一种风格。

ReturnType
FunctionName()
const;

我知道大多数人只使用全线同样的风格,

ReturnType FunctionName() const;

或只是返回类型在另一种线型

ReturnType
FunctionName() const;

对于all-in-same-line风格和return-type-at-another-line风格,doxygen 可以正确解析。

然而,const-at-another-line样式的文档会产生一个成员数据 名为“const”,type为ReturnType。

class Signal : public Interface {
    bool
    HasSignal()
    const;
};

文档显示类Signal具有公共属性

bool const

会员数据文档中的详细文档显示

bool Signal::const

我也试过这些案例,纯虚函数:

bool
HasSignal()
const =0;

结果

bool Signal::const =0

和C ++ 11 final / override关键字: (我不期待Doxygen完全支持C ++ 11语法,仅用于比较)

bool
HasSignal()
const
override;

导致公共属性

bool const override

哪个“const”链接到类Interface

中的成员数据文档
virtual bool Interface::const = 0

和“覆盖”指向课程Signal

中的成员资料文档的链接
bool const Signal::override

我的问题是: Doxygen中是否有一些配置我错过了可以帮助解析/文档 const成员函数正确使用const-at-another-line样式? 或者我只能修改样式以适合Doxygen用于文档目的?

1 个答案:

答案 0 :(得分:1)

在1.8.6及更高版本中看起来已修复此问题(请注意,版本1.8.5已于2013年8月发布,因此它相当陈旧)。撰写时的最新版本是1.8.9.1。