combine doxygen and doc-strings?

[Gabriel Zachmann]

Is there a way to combine doxygen comments, like this one


## Documentation for a function.
# @var a - variable
# More details.

def func( a ):
pass


with the doc strings, like this one


def func( a ):
""" Documentation for a function.
More details.
"""
pass


?
Obviously, one would like to write the documentaion only once.

Best regards,
Gabriel.

--
/-----------------------------------------------------------------------\
| Any intelligent fool can make things bigger, more complex, |
| or more violent. It takes a touch of genius - and a lot of courage - |
| to move in the opposite direction. (Einstein) |
\-----------------------------------------------------------------------/

 

[Daniel Evers]

You're maybe searching for epydoc: http://epydoc.sourceforge.net/

 

[Henk van Asselt]

Is there a way to combine doxygen comments, like this one


## Documentation for a function.
# @var a - variable
# More details.

def func( a ):
pass


with the doc strings, like this one


def func( a ):
""" Documentation for a function.
More details.
"""
pass


?
Obviously, one would like to write the documentaion only once.

Best regards,
Gabriel.

Gabriel,

Although it is not documented yet, doxygen understands the following:

def func( a ):
"""! @brief Documentation for a function.
@var a This is a variable
@return Nothing

More details.
"""

I found this information in a mailing list (of which I don't know it's
name anymore)

Good luck, Henk

 

[Diez B. Roggisch]

Is there a way to combine doxygen comments, like this one

If you are not tied to doxygen, you might consider epydoc - it uses the
docstrings, and restructured text which is friendly to the eye.

Regards,

Diez