eric6/Graphics/ModuleItem.py

changeset 8289
871b40c5a77a
parent 8234
fcb6b4b96274
child 8291
3d79b1e5bf3c
--- a/eric6/Graphics/ModuleItem.py	Tue May 04 19:30:25 2021 +0200
+++ b/eric6/Graphics/ModuleItem.py	Tue May 04 20:03:40 2021 +0200
@@ -21,8 +21,10 @@
         """
         Constructor
         
-        @param name the module name (string)
-        @param classlist list of class names (list of strings)
+        @param name the module name
+        @type str
+        @param classlist list of class names
+        @type list of str
         """
         super().__init__(name)
         
@@ -32,7 +34,8 @@
         """
         Public method to add a class to the module model.
         
-        @param classname class name to be added (string)
+        @param classname class name to be added
+        @type str
         """
         self.classlist.append(classname)
     
@@ -40,7 +43,8 @@
         """
         Public method to retrieve the classes of the module.
         
-        @return list of class names (list of strings)
+        @return list of class names
+        @rtype list of str
         """
         return self.classlist[:]
 
@@ -124,7 +128,8 @@
         """
         Public method to set the module model.
         
-        @param model module model containing the module data (ModuleModel)
+        @param model module model containing the module data
+        @type ModuleModel
         """
         self.scene().removeItem(self.header)
         self.header = None
@@ -139,9 +144,12 @@
         """
         Public method to paint the item in local coordinates.
         
-        @param painter reference to the painter object (QPainter)
-        @param option style options (QStyleOptionGraphicsItem)
-        @param widget optional reference to the widget painted on (QWidget)
+        @param painter reference to the painter object
+        @type QPainter
+        @param option style options
+        @type QStyleOptionGraphicsItem
+        @param widget optional reference to the widget painted on
+        @type QWidget
         """
         pen = self.pen()
         if (
@@ -175,7 +183,8 @@
         "attribute=value" with pairs separated by ", ". value must not
         contain ", " or newlines.
         
-        @return persistence data (string)
+        @return persistence data
+        @rtype str
         """
         entries = [
             "name={0}".format(self.model.getName()),
@@ -190,9 +199,12 @@
         """
         Public method to parse the given persistence data.
         
-        @param version version of the data (string)
-        @param data persisted data to be parsed (string)
-        @return flag indicating success (boolean)
+        @param version version of the data
+        @type str
+        @param data persisted data to be parsed
+        @type str
+        @return flag indicating success
+        @rtype bool
         """
         parts = data.split(", ")
         if len(parts) < 1:

eric ide

mercurial