Я использую 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 в Размещение документации после членов, и если да, то как правильно?
**изменить:**похоже, это связано с тем, что у меня нет новой строки, например здесь:
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 жалуется только на то, что ВСЕГДА
недокументировано, я хотел бы избежать вставки новых строк после каждый новый атрибут я документирую таким образом, поскольку он уничтожает значение новой строки для разделения логических блоков, таких как циклы или операторы if из окружающего кода