gpt4 book ai didi

python - 用 Doxygen 记录一个不存在的成员

转载 作者:太空狗 更新时间:2023-10-29 19:27:52 29 4
gpt4 key购买 nike

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

我想做的是能够使用如下方式记录这些属性:

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

整个 package::Class 工作(相同的方法找到函数,所以它找到正确的类)。

运行 doxygen 时出现以下错误:

警告:记录的函数“package::Class::Name”未声明或定义。

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

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

最佳答案

if 0: block 中定义属性:

## @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

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

关于python - 用 Doxygen 记录一个不存在的成员,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/13119066/

29 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com