diff -r 809d5d5ac2ba -r 871b40c5a77a eric6/Documentation/Source/eric6.Graphics.PackageDiagramBuilder.html
--- a/eric6/Documentation/Source/eric6.Graphics.PackageDiagramBuilder.html Tue May 04 19:30:25 2021 +0200
+++ b/eric6/Documentation/Source/eric6.Graphics.PackageDiagramBuilder.html Tue May 04 20:03:40 2021 +0200
@@ -23,7 +23,7 @@
<h1>eric6.Graphics.PackageDiagramBuilder</h1>
<p>
-Module implementing a dialog showing a UML like class diagram of a package.
+Module implementing a dialog showing an UML like class diagram of a package.
</p>
<h3>Global Attributes</h3>
@@ -136,26 +136,25 @@
</p>
<dl>
-<dt><i>dialog</i></dt>
+<dt><i>dialog</i> (UMLDialog)</dt>
<dd>
-reference to the UML dialog (UMLDialog)
+reference to the UML dialog
</dd>
-<dt><i>view</i></dt>
+<dt><i>view</i> (UMLGraphicsView)</dt>
<dd>
-reference to the view object (UMLGraphicsView)
+reference to the view object
</dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
<dd>
-reference to the project object (Project)
+reference to the project object
</dd>
-<dt><i>package</i></dt>
+<dt><i>package</i> (str)</dt>
<dd>
-name of a python package to be shown (string)
+name of a python package to be shown
</dd>
-<dt><i>noAttrs</i></dt>
+<dt><i>noAttrs</i> (bool)</dt>
<dd>
flag indicating, that no attributes should be shown
- (boolean)
</dd>
</dl>
<a NAME="PackageDiagramBuilder.__addExternalClass" ID="PackageDiagramBuilder.__addExternalClass"></a>
@@ -171,17 +170,17 @@
</p>
<dl>
-<dt><i>_class</i></dt>
+<dt><i>_class</i> (ModuleParser.Class)</dt>
<dd>
-class to be shown (string)
+class to be shown
</dd>
-<dt><i>x</i></dt>
+<dt><i>x</i> (float)</dt>
<dd>
-x-coordinate (float)
+x-coordinate
</dd>
-<dt><i>y</i></dt>
+<dt><i>y</i> (float)</dt>
<dd>
-y-coordinate (float)
+y-coordinate
</dd>
</dl>
<a NAME="PackageDiagramBuilder.__addLocalClass" ID="PackageDiagramBuilder.__addLocalClass"></a>
@@ -193,25 +192,25 @@
</p>
<dl>
-<dt><i>className</i></dt>
+<dt><i>className</i> (str)</dt>
<dd>
-name of the class to be as a dictionary key (string)
+name of the class to be as a dictionary key
</dd>
-<dt><i>_class</i></dt>
+<dt><i>_class</i> (ModuleParser.Class)</dt>
<dd>
-class to be shown (ModuleParser.Class)
+class to be shown
</dd>
-<dt><i>x</i></dt>
+<dt><i>x</i> (float)</dt>
<dd>
-x-coordinate (float)
+x-coordinate
</dd>
-<dt><i>y</i></dt>
+<dt><i>y</i> (float)</dt>
<dd>
-y-coordinate (float)
+y-coordinate
</dd>
-<dt><i>isRbModule</i></dt>
+<dt><i>isRbModule</i> (bool)</dt>
<dd>
-flag indicating a Ruby module (boolean)
+flag indicating a Ruby module
</dd>
</dl>
<a NAME="PackageDiagramBuilder.__addPackage" ID="PackageDiagramBuilder.__addPackage"></a>
@@ -223,22 +222,21 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-package name to be shown (string)
+package name to be shown
</dd>
-<dt><i>modules</i></dt>
+<dt><i>modules</i> (list of str)</dt>
<dd>
list of module names contained in the package
- (list of strings)
</dd>
-<dt><i>x</i></dt>
+<dt><i>x</i> (float)</dt>
<dd>
-x-coordinate (float)
+x-coordinate
</dd>
-<dt><i>y</i></dt>
+<dt><i>y</i> (float)</dt>
<dd>
-y-coordinate (float)
+y-coordinate
</dd>
</dl>
<a NAME="PackageDiagramBuilder.__arrangeClasses" ID="PackageDiagramBuilder.__arrangeClasses"></a>
@@ -253,18 +251,18 @@
</p>
<dl>
-<dt><i>nodes</i></dt>
+<dt><i>nodes</i> (list of str)</dt>
<dd>
list of nodes to arrange
</dd>
-<dt><i>routes</i></dt>
+<dt><i>routes</i> (list of tuple of (str, str))</dt>
<dd>
list of routes
</dd>
-<dt><i>whiteSpaceFactor</i></dt>
+<dt><i>whiteSpaceFactor</i> (float)</dt>
<dd>
factor to increase whitespace between
- items (float)
+ items
</dd>
</dl>
<a NAME="PackageDiagramBuilder.__buildModulesDict" ID="PackageDiagramBuilder.__buildModulesDict"></a>
@@ -278,7 +276,13 @@
<dl>
<dt>Return:</dt>
<dd>
-dictionary of modules contained in the package.
+dictionary of modules contained in the package
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
</dd>
</dl>
<a NAME="PackageDiagramBuilder.__buildSubpackagesDict" ID="PackageDiagramBuilder.__buildSubpackagesDict"></a>
@@ -295,6 +299,12 @@
dictionary of sub-packages contained in this package
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
<a NAME="PackageDiagramBuilder.__createAssociations" ID="PackageDiagramBuilder.__createAssociations"></a>
<h4>PackageDiagramBuilder.__createAssociations</h4>
<b>__createAssociations</b>(<i>routes</i>)
@@ -304,7 +314,7 @@
</p>
<dl>
-<dt><i>routes</i></dt>
+<dt><i>routes</i> (list of tuple of (str, str))</dt>
<dd>
list of relationsships
</dd>
@@ -318,15 +328,21 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-name of the shape (string)
+name of the shape
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-shape (QCanvasItem)
+shape
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QCanvasItem
</dd>
</dl>
<a NAME="PackageDiagramBuilder.buildDiagram" ID="PackageDiagramBuilder.buildDiagram"></a>
@@ -349,7 +365,13 @@
<dl>
<dt>Return:</dt>
<dd>
-persisted data string (string)
+persisted data string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="PackageDiagramBuilder.initialize" ID="PackageDiagramBuilder.initialize"></a>
@@ -368,19 +390,25 @@
</p>
<dl>
-<dt><i>version</i></dt>
+<dt><i>version</i> (str)</dt>
<dd>
-version of the data (string)
+version of the data
</dd>
-<dt><i>data</i></dt>
+<dt><i>data</i> (str)</dt>
<dd>
-persisted data to be parsed (string)
+persisted data to be parsed
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
