combine doxygen and doc-strings?
Henk van Asselt
Henk at PA3BTL.demon.nl
Sun Nov 20 06:14:45 EST 2005
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
More information about the Python-list
mailing list