Re: [Epydoc-devel] How to document properties?

[Daniele V. <pi...@de...>]

> The "enum problem" mentioned below is a different topic and still unsolved:
>> As you can read here:
>> http://kogs-www.informatik.uni-hamburg.de/~meine/software/figpy/#api-docume
>>ntation I don't like the large list of "variables" either, which are in
>> fact
>> constants and some kind of enum. (Please tell me a better Python API for
>> such constants if you know one.)

You may group such constants using group markers. See
http://epydoc.sourceforge.net/epydoc.html#grouping-and-sorting:

    #{ polygon types
    ptPolyline    = 1
    ptBox         = 2
    ptPolygon     = 3
    ptArcBox      = 4
    ptPictureBBox = 5

    #{ ellipse types
    etEllipseRadii    = 1
    etEllipseDiameter = 2
    etCircleRadius    = 3
    etCircleDiameter  = 4  ...

There is no such thing as an enum in Python, neither there are constants. Be
explicit with how variables are expected to be used: call your groups
"polygon types constants", for example.

-- 
Daniele Varrazzo - Develer S.r.l.
http://www.develer.com