diff -r 62ae22eae123 -r 30eb7bc13d63 eric6/Graphics/ImportsDiagramBuilder.py
--- a/eric6/Graphics/ImportsDiagramBuilder.py Mon May 03 19:42:27 2021 +0200
+++ b/eric6/Graphics/ImportsDiagramBuilder.py Mon May 03 19:58:28 2021 +0200
@@ -32,13 +32,18 @@
"""
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 package name of a python package to show the import
- relationships (string)
+ relationships
+ @type str
@param showExternalImports flag indicating to show exports from
- outside the package (boolean)
+ outside the package
+ @type bool
"""
super().__init__(dialog, view, project)
self.setObjectName("ImportsDiagram")
@@ -74,7 +79,8 @@
Private method to build a dictionary of modules contained in the
package.
- @return dictionary of modules contained in the package.
+ @return dictionary of modules contained in the package
+ @rtype dict
"""
import Utilities.ModuleParser
extensions = (
@@ -202,12 +208,16 @@
"""
Private method to add a module to the diagram.
- @param name module name to be shown (string)
+ @param name module name to be shown
+ @type str
@param classes list of class names contained in the module
- (list of strings)
- @param x x-coordinate (float)
- @param y y-coordinate (float)
- @return reference to the imports item (ModuleItem)
+ @type list of str
+ @param x x-coordinate
+ @type float
+ @param y y-coordinate
+ @type float
+ @return reference to the imports item
+ @rtype ModuleItem
"""
from .ModuleItem import ModuleItem, ModuleModel
classes.sort()
@@ -316,7 +326,8 @@
"""
Public method to get a string for data to be persisted.
- @return persisted data string (string)
+ @return persisted data string
+ @rtype str
"""
return "package={0}, show_external={1}".format(
self.packagePath, self.showExternalImports)
@@ -325,9 +336,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 (
