Epydoc - Documenting class members?

Terry Hancock hancock at anansispaceworks.com
Thu Sep 1 00:02:04 CEST 2005


On Wednesday 31 August 2005 09:11 am, Miki Tebeka wrote:
> Is there a way to document class members in Epydoc?

Yes. See additions below:
 
> Something like:
> 
>     class Point:
	"""
	@ivar x:  This is where you document x.
	@ivar y:  This is where you document y.
	"""
>         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.

Cheers,
Terry

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




More information about the Python-list mailing list