[prev in list] [next in list] [prev in thread] [next in thread] 

List:       pykde
Subject:    [PyQt] Re: Documenting signals
From:       Georg Altmann <george () george-net ! de>
Date:       2008-09-19 11:06:22
Message-ID: gb015t$hbm$1 () ger ! gmane ! org
[Download RAW message or body]

Detlev Offenbach schrieb:
> On Mittwoch, 17. September 2008, Georg Altmann wrote:
>> Hi,
>>
>> I'm new to PyQt(4) and python in general. Is there a good way to
>> document signals of a class in the doc string?
>>
>> Something like this:
>>
>> class MyClass(QObject):
>>      """My nifty class.
>>
>>      @signal myNiftySignal() This signal will be emitted when the object
>>      did something nifty."""
>>
> 
> The above kind of source code documentation is supported by the eric4-doc.py 
> script, which is part of the eric4 IDE. It extracts the classes doc string 
> and generates HTML documentation out of it.

Yes, I just tried it and was suprised, that the doc script parsed it... 
nice! :-)
I guess this is specific to to eric and no official doc string format?

Regards
Georg

_______________________________________________
PyQt mailing list    PyQt@riverbankcomputing.com
http://www.riverbankcomputing.com/mailman/listinfo/pyqt
[prev in list] [next in list] [prev in thread] [next in thread]