[PyQt] Documenting signals

Detlev Offenbach detlev at die-offenbachs.de
Wed Sep 17 17:42:41 BST 2008

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.


> Or can I add dummy methods and document them as signals?
> Regards
> Georg
> _______________________________________________
> PyQt mailing list    PyQt at riverbankcomputing.com
> http://www.riverbankcomputing.com/mailman/listinfo/pyqt

Detlev Offenbach
detlev at die-offenbachs.de

More information about the PyQt mailing list