Re: combine doxygen and doc-strings?

2005-11-20 Thread Henk van Asselt
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
-- 
http://mail.python.org/mailman/listinfo/python-list


Re: combine doxygen and doc-strings?

2005-11-20 Thread Diez B. Roggisch
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
-- 
http://mail.python.org/mailman/listinfo/python-list