eric6/Graphics/ApplicationDiagramBuilder.py

changeset 8287
30eb7bc13d63
parent 8286
62ae22eae123
child 8291
3d79b1e5bf3c
--- a/eric6/Graphics/ApplicationDiagramBuilder.py	Mon May 03 19:42:27 2021 +0200
+++ b/eric6/Graphics/ApplicationDiagramBuilder.py	Mon May 03 19:58:28 2021 +0200
@@ -29,11 +29,15 @@
         """
         Constructor
         
-        @param dialog reference to the UML dialog (UMLDialog)
-        @param view reference to the view object (UMLGraphicsView)
-        @param project reference to the project object (Project)
+        @param dialog reference to the UML dialog
+        @type UMLDialog
+        @param view reference to the view object
+        @type UMLGraphicsView
+        @param project reference to the project object
+        @type Project
         @param noModules flag indicating, that no module names should be
-            shown (boolean)
+            shown
+        @type bool
         """
         super().__init__(dialog, view, project)
         self.setObjectName("ApplicationDiagram")
@@ -49,7 +53,8 @@
         Private method to build a dictionary of modules contained in the
         application.
         
-        @return dictionary of modules contained in the application.
+        @return dictionary of modules contained in the application
+        @rtype dict
         """
         import Utilities.ModuleParser
         extensions = (
@@ -269,12 +274,16 @@
         """
         Private method to add a package to the diagram.
         
-        @param name package name to be shown (string)
+        @param name package name to be shown
+        @type str
         @param modules list of module names contained in the package
-            (list of strings)
-        @param x x-coordinate (float)
-        @param y y-coordinate (float)
-        @return reference to the package item (PackageItem)
+        @type list of str
+        @param x x-coordinate
+        @type float
+        @param y y-coordinate
+        @type float
+        @return reference to the package item
+        @rtype PackageItem
         """
         from .PackageItem import PackageItem, PackageModel
         modules.sort()
@@ -383,7 +392,8 @@
         """
         Public method to get a string for data to be persisted.
         
-        @return persisted data string (string)
+        @return persisted data string
+        @rtype str
         """
         return "project={0}, no_modules={1}".format(
             self.project.getProjectFile(), self.noModules)
@@ -392,9 +402,12 @@
         """
         Public method to parse persisted 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 (

eric ide

mercurial