Documentation after items in python (with doxygen)

I am using doxygen and have the following code:

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 

For some reason, doxygen tells me that self._stream ( Member _stream ) has no documents. Can I document it using a comment, as described in the doxygen documentation in the "Posting documentation after the participants" section , and if so, how right?

** edit: ** it looks like I don't have a new line, for example here:

 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 only complains that ALWAYS undocumented, I would like to avoid inserting new lines after every new attribute that I document this way, since it destroys the value of new lines to separate logical blocks such as loops, or if statements from the surrounding code .

+7
source share
1 answer

This is currently not supported in doxygen, as previously stated here . If you put a comment in the previous line, it will work fine:

 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 

Hope it's not too late ...

+7
source

Source: https://habr.com/ru/post/918206/


All Articles