Documentation after members in python (with doxygen)

Question

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) is undocumented. can I document it with a comment, like the doxygen docu describes in Putting documentation after members and if so, whats the right way?

**edit:**this seems to be related to me having no 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 about ALWAYS being undocumented, I would like to avoid inserting newlines behind every new attribute I document this way since it destroys the value of newlines for separating logical blocks like loops or if statements from surrounding code

I would suggest to use Sphinx for documentation of Python projects in general — bmu
– bmu, Commented Jun 15, 2012 at 16:56
unfortunately that is currently not an option, i will give it a look for the next project — ted
– ted, Commented Jun 15, 2012 at 17:23
maybe it was a spell-check tool that complained about ALLWAYS ;) — Janusz Lenar
– Janusz Lenar, Commented Jan 31, 2013 at 9:29

Community · Accepted Answer · 2017-05-23 12:16:55Z

10

This is currently not supported in doxygen, as previously answered here. If you put the comment on the preceeding 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 that's not too late...

edited May 23, 2017 at 12:16

CommunityBot

11 silver badge

answered Sep 26, 2012 at 17:44

Duncan Macleod

1,07512 silver badges21 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

ted Over a year ago

thanks, this is somewhat helpfull. I hacked a little bit on a filter for python. It does the same thing but it screws up line numbering since it internally converts it to your format but with docstrings, thus adding lines. I will change it and try to upload it somewhere if my employer allows.

Collectives™ on Stack Overflow

Documentation after members in python (with doxygen)

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related