473,408 Members | 1,874 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,408 software developers and data experts.

Epydoc - Documenting class members?

Hello,

Is there a way to document class members in Epydoc?

Something like:

class Point:
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?

Thanks.
--
------------------------------------------------------------------------
Miki Tebeka <mi*********@zoran.com>
http://tebeka.bizhat.com
The only difference between children and adults is the price of the toys

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (Cygwin)

iD8DBQFDFbp68jAdENsUuJsRApcWAJ9a7AiTL8H5BkQFYZq6pn X7p+v9GQCgwPEH
NBce/iOr+Xo5AAsaUjvY6Vs=
=0Mez
-----END PGP SIGNATURE-----

Aug 31 '05 #1
1 2397
This should help:

http://epydoc.sourceforge.net/fields.html

Kay

Aug 31 '05 #2

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

0
by: simon | last post by:
Hi, We have a requirement for latex math (eg. $\sum_i x_i$) in our documentation, and i'm looking at patching epydoc to handle this. We have been using the python doc system (also used by...
0
by: Laszlo Zsolt Nagy | last post by:
Hello, I would like to create documentation for my lib using EpyDoc. I do not see how to report bugs on the EpyDoc home page. When I try to create documentation, I get this error: Internal...
2
by: Neil Benn | last post by:
Hello, I can;t find a epyDoc specific mailing list, so I'll try here - if you know of a epyDoc mailing list then please let me know (google is not my friend, I can only find an announce, devel...
0
by: Michele Petrazzo | last post by:
I found a "problem" on epydoc. If I specify an encoding, epydoc not find my global variables, and if I remove it, it work well. code.py: #!/usr/bin/env python # -*- coding: utf-8 -*- MY_VAR...
2
by: programmer.py | last post by:
Hi everyone! I'm documenting some functions that return XML strings. I'd like to have `sample' xml show up in my epydoc generated documentation. However, epydoc does not like the indentation of...
8
by: Spleenwort | last post by:
With regard to XML comments in c#. I think that #regions should be self-documenting relative to XML comments or that a <region> tag should be defined and auto-inserted when you type #region...
0
by: Edward Loper | last post by:
Epydoc 3.0 beta is now available for download from SourceForge. Epydoc is a tool for generating API documentation for Python modules, based on their docstrings. - The epydoc homepage....
0
by: tom | last post by:
I would like to use Epydoc (3.0beta1) to document my wxPython (2.6.10) application. The problem is that I can't seem to instruct Epydoc to not also generate partial documentation of wxPython,...
0
by: davels | last post by:
I'm trying to use epydoc (3.0beta1) to generate documentation for some packages I've installed as eggs. When I run the epydoc command "epydoc.py -v -o sqlalchemy sqlalchemy" in completes without...
0
by: emmanuelkatto | last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud. Please let me know. Thanks! Emmanuel
1
by: nemocccc | last post by:
hello, everyone, I want to develop a software for my android phone for daily needs, any suggestions?
1
by: Sonnysonu | last post by:
This is the data of csv file 1 2 3 1 2 3 1 2 3 1 2 3 2 3 2 3 3 the lengths should be different i have to store the data by column-wise with in the specific length. suppose the i have to...
0
by: Hystou | last post by:
There are some requirements for setting up RAID: 1. The motherboard and BIOS support RAID configuration. 2. The motherboard has 2 or more available SATA protocol SSD/HDD slots (including MSATA, M.2...
0
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
0
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers,...
0
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each...
0
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing,...
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.