Helpviewer/WebPlugins/WebPluginInterface.py

branch
Py2 comp.
changeset 3057
10516539f238
parent 2538
b2642e7a4c18
parent 2962
d6c9d1ca2da4
child 3145
a9de05d4a22f
--- a/Helpviewer/WebPlugins/WebPluginInterface.py	Tue Oct 15 22:03:54 2013 +0200
+++ b/Helpviewer/WebPlugins/WebPluginInterface.py	Fri Oct 18 23:00:41 2013 +0200
@@ -19,7 +19,9 @@
         """
         Public method to create a meta plug-in object containing plug-in info.
         
-        @return meta plug-in object (QWebPluginFactory.Plugin)
+        @ireturn meta plug-in object (QWebPluginFactory.Plugin)
+        @exception NotImplementedError raised to indicate that this method
+            must be implemented by subclasses
         """
         raise NotImplementedError
     
@@ -31,18 +33,25 @@
         @param url URL for the plug-in (QUrl)
         @param argumentNames list of argument names (list of strings)
         @param argumentValues list of argument values (list of strings)
-        @return reference to the created object (QWidget)
+        @ireturn reference to the created object (QWidget)
+        @exception NotImplementedError raised to indicate that this method
+            must be implemented by subclasses
         """
         raise NotImplementedError
     
     def configure(self):
         """
         Public method to configure the plug-in.
+        
+        @exception NotImplementedError raised to indicate that this method
+            must be implemented by subclasses
         """
         raise NotImplementedError
     
     def isAnonymous(self):
         """
         Public method to indicate an anonymous plug-in.
+        
+        @return flag indicating anonymous state (boolean)
         """
         return False

eric ide

mercurial