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

在doxygen中记录Python枚举的正确方法是什么?,python,enums,doxygen,Python,Enums,Doxygen,我使用注释而不是Python自己的docstring来记录我的Python代码。除了Enum之外,它工作得很好。我为他们中的每一个人都收到了这样的警告: warning: Documentation for undefined enum `MyEnum' found. 生成文档,没有问题。我想摆脱这个警告 我将其记录如下: ## @enum MyEnum # This is my enum. class MyEnum(Enum): 我已确保该文件包含@file标记 所有枚

我使用注释而不是Python自己的docstring来记录我的Python代码。除了Enum之外,它工作得很好。我为他们中的每一个人都收到了这样的警告:

warning: Documentation for undefined enum `MyEnum' found.
生成文档,没有问题。我想摆脱这个警告

我将其记录如下:

##   @enum    MyEnum
#    This is my enum.  
class MyEnum(Enum):
我已确保该文件包含@file标记

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

##   @enum    MyFileName::MyEnum

甚至整个链条,因为它出现在输出

##   @enum    MyFolder::MyFileName::MyEnum

但是警告仍然存在。

您试图将类记录为枚举。\enum命令用于记录枚举,而不是用于记录类。如果您使用:##这是我的类表单enums.Hmm,那么您的案例注释可能会更好。你说得对。如果我将Python枚举标记为enum,我希望Doxygen会以不同的方式对待它,但这没有什么区别。不知道这是故意还是意外。我希望它们是不同的,但Python不这么认为,Doxygen也不这么认为。谢谢。您尝试将类记录为枚举。\enum命令用于记录枚举,而不是用于记录类。如果您使用:##这是我的类表单enums.Hmm,那么您的案例注释可能会更好。你说得对。如果我将Python枚举标记为enum,我希望Doxygen会以不同的方式对待它,但这没有什么区别。不知道这是故意还是意外。我希望它们是不同的,但Python不这么认为,Doxygen也不这么认为。谢谢
##   @enum    MyFolder::MyFileName::MyEnum