在doxygen中记录Python枚举的正确方法是什么?

时间:2017-07-17 10:47:11

标签: python enums doxygen

我使用注释而不是Python自己的文档字符串来记录我的Python代码。除了枚举之外,它运作良好。我得到了每个人的警告:

warning: Documentation for undefined enum `MyEnum' found.

生成文档,没问题。我想摆脱警告。

我记录了这样:

##   @enum    MyEnum
#    This is my enum.  
class MyEnum(Enum):

我已确保该文件包含@file标记。

所有枚举都是全球性的。我甚至试过

##   @enum    MyFileName::MyEnum

##   @enum    MyFileName::MyEnum

甚至输出中出现的整个链条。

##   @enum    MyFolder::MyFileName::MyEnum

但警告仍然存在。

0 个答案:

没有答案