[PyQt] Re: Documenting signals

Georg Altmann george at george-net.de
Fri Sep 19 12:06:22 BST 2008

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?


More information about the PyQt mailing list