python中的成员之后的文档(使用doxygen)

Question

我正在使用doxygen并具有以下代码:

def __init__(self):
    '''

    '''
    if not '_ready' in dir(self) or not self._ready:
        self._stream = sys.stderr   ##!< stream to which all output is written
        self._ready = True          ##!< @internal Flag to check initialization of singelton

由于某种原因,doxygen告诉我self._stream(Member _stream)没有记录.我可以用评论来记录它,比如doxygen docu 在成员之后的文档中描述,如果是,那么,是什么方式？

**编辑:**这似乎与我没有新线有关,例如:

class escapeMode(object):
    '''
    Enum to represent the escape mode.
    '''
    ALWAYS      = 1     ##!< Escape all values
    NECESSARY   = 2     ##!< Escape only values containing seperators or starting with quotation

Doxygen只是抱怨ALWAYS没有文档,我想避免在每个新属性后面插入换行符,因为它会破坏用于分隔逻辑块(如循环或来自周围代码的语句)的换行符的值

Answer 1

如前所述,doxygen目前不支持此功能.如果你将评论放在前一行,它将正常工作:

class escapeMode(object):
    '''
    Enum to represent the escape mode.
    '''
    ## Escape all values
    ALLWAYS     = 1
    ## Escape only values containing seperators or starting with quotation
    NECESSARY   = 2

希望还不算太晚......