469,949 Members | 2,635 Online
Bytes | Developer Community
New Post

Home Posts Topics Members FAQ

Post your question to a community of 469,949 developers. It's quick & easy.

combine doxygen and doc-strings?

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) |
\-----------------------------------------------------------------------/
Nov 22 '05 #1
6 3144
You're maybe searching for epydoc: http://epydoc.sourceforge.net/
Nov 22 '05 #2
You're maybe searching for epydoc: http://epydoc.sourceforge.net/
Nov 22 '05 #3
Gabriel Zachmann wrote:
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
Nov 22 '05 #4
Gabriel Zachmann wrote:
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
Nov 22 '05 #5
Gabriel Zachmann wrote:
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
Nov 22 '05 #6
Gabriel Zachmann wrote:
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
Nov 22 '05 #7

This discussion thread is closed

Replies have been disabled for this discussion.

Similar topics

10 posts views Thread by Erwin Burgstaller | last post: by
5 posts views Thread by Konrad Mühler | last post: by
2 posts views Thread by David Dvali | last post: by
10 posts views Thread by Olaf Wasmuth | last post: by
4 posts views Thread by musicloverlch | last post: by
1 post views Thread by Jan Danielsson | last post: by
2 posts views Thread by Peter Olcott | last post: by
7 posts views Thread by PeteOlcott | last post: by
By using this site, you agree to our Privacy Policy and Terms of Use.