Epydoc - Documenting class members?

Terry Hancock hancock at anansispaceworks.com
Fri Sep 2 05:38:03 CEST 2005


On Thursday 01 September 2005 03:01 am, Miki Tebeka wrote:
> [Miki]
> >> Is there a way to document class members in Epydoc?
> 
> [Terry]
> > Yes. See additions below:

> I don't like this, I want to document where I declare the variable below.
> Doxygen (www.doxygen.org), for one example, knows how to do this.

Then use Doxygen if it's a superior product. I presume
it knows how to handle Python code, then?

You asked how to do this in epydoc. Which I use. So I told you.
It works fine for me just like it is.

If you feel it ought to be smarter, you could of course

1) Submit a patch to the author.

2) At least place a feature request on the SF tracker for
   the project.

Epydoc is based on pydoc, and does not interpret comments at all.
Happydoc does (or did), but it did not provide any means to document
class or instance attributes that I could find. It is also regrettably
not being maintained anymore, AFIACT, which is why I switched
to epydoc (although epydoc seems to be a very nice product itself).


--
Terry Hancock ( hancock at anansispaceworks.com )
Anansi Spaceworks  http://www.anansispaceworks.com




More information about the Python-list mailing list