Epydoc - Documenting class members?
Miki Tebeka
miki.tebeka at zoran.com
Thu Sep 1 04:01:55 EDT 2005
Hello Terry,
[Miki]
>> Is there a way to document class members in Epydoc?
[Terry]
> Yes. See additions below:
>
> > Something like:
> >
> > class Point:
> """
> @ivar x: This is where you document x.
> @ivar y: This is where you document y.
> """
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.
> > def __init__(self, x, y):
> > '''Create new point
> > @param x: X coord
> > @param y: Y coord
> > '''
> > self.x = x # How do I document here?
> > self.y = y # How do I document here?
> All of the fields are documented on the http://epydoc.sf.net
> website, by the way.
I know.
Thanks.
--
------------------------------------------------------------------------
Miki Tebeka <miki.tebeka at zoran.com>
http://tebeka.bizhat.com
The only difference between children and adults is the price of the toys
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 193 bytes
Desc: not available
URL: <http://mail.python.org/pipermail/python-list/attachments/20050901/ecce97bf/attachment.sig>
More information about the Python-list
mailing list