doxygen

2007-03-04 Thread Jan Danielsson 
Hello all,

   I guess I should really be asking in some doxygen mailing list, but
since I believe that I found doxygen through this group, I assume that
there are some people here who can answer.

   When I run doxygen on my python files, it does document classes, but
not standalone functions. I.e.:

---
## Foobar class
#
# This is a test class!
class Foobar:

   ## Init
   #
   # This is the init function.
   def __init__(self):
  pass
---

   ... is included, but:

---
## Test
#
# This is a test function
def TestFunction(foo=None):
   pass
---

   ..is not.

   Is this by design? Is it possible to get doxygen to include
standalone functions?


-- 
Kind regards,
Jan Danielsson
-- 
http://mail.python.org/mailman/listinfo/python-list

Re: doxygen

2007-03-04 Thread Mike Kent 
On Mar 4, 1:15 pm, Jan Danielsson [EMAIL PROTECTED] wrote:

When I run doxygen on my python files, it does document classes, but
 not standalone functions.

Look in the doxygen config file for your python project, named
'Doxyfile', for the config setting
'EXTRACT_ALL', and read the comments there.

-- 
http://mail.python.org/mailman/listinfo/python-list

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