使用Doxygen记录不存在的成员

Question

我正在尝试使用Doxygen来记录python类.该类通过d-bus公开一组属性,但这些属性在python类中没有相应的公共getter/setter.相反,它们是通过d-bus属性接口(Set/Get/GetAll/Introspect)实现的.

我想要做的是能够使用以下内容记录这些属性:

## @property package::Class::Name description

整个包:: Class工作(相同的方法查找函数,因此它找到正确的类).

运行doxygen时出现以下错误:

warning: documented function ``package::Class::Name' was not declared or defined.

我可以接受警告,但不幸的是,该属性未能出现在为该类生成的文档中,因此它不仅是一个警告,而且也是静音.

所以,我的问题是,如果可以的话,我如何让不存在的属性成员出现在生成的文档中？

Answer 1

定义块内的属性if 0:：

## @class X
## @brief this is useless
class X:
    if 0:
        ## @brief whatevs is a property that doesn't exist in spacetime
        ##
        ## It is designed to make bunny cry.
        whatevs = property

这将导致它存在于文档中（使用doxygen 1.8.1.2-1on进行测试debian-squeeze）。该属性永远不会在运行时存在，事实上，Python 字节码优化器似乎完全消除了 if 语句及其主体。