--- a/src/eric7/Documentation/Source/eric7.Graphics.PackageDiagramBuilder.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Graphics.PackageDiagramBuilder.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Graphics.PackageDiagramBuilder</h1>
-
<p>
Module implementing a dialog showing an UML like class diagram of a package.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#PackageDiagramBuilder">PackageDiagramBuilder</a></td>
<td>Class implementing a builder for UML like class diagrams of a package.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="PackageDiagramBuilder" ID="PackageDiagramBuilder"></a>
<h2>PackageDiagramBuilder</h2>
-
<p>
Class implementing a builder for UML like class diagrams of a package.
</p>
+
<h3>Derived from</h3>
UMLDiagramBuilder
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#PackageDiagramBuilder.__init__">PackageDiagramBuilder</a></td>
<td>Constructor</td>
@@ -111,19 +108,20 @@
<td>Public method to collect data to be persisted.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="PackageDiagramBuilder.__init__" ID="PackageDiagramBuilder.__init__"></a>
<h4>PackageDiagramBuilder (Constructor)</h4>
<b>PackageDiagramBuilder</b>(<i>dialog, view, project, package, noAttrs=False</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>dialog</i> (UMLDialog)</dt>
@@ -150,7 +148,6 @@
<a NAME="PackageDiagramBuilder.__addExternalClass" ID="PackageDiagramBuilder.__addExternalClass"></a>
<h4>PackageDiagramBuilder.__addExternalClass</h4>
<b>__addExternalClass</b>(<i>_class, x, y</i>)
-
<p>
Private method to add a class defined outside the module.
</p>
@@ -158,6 +155,7 @@
If the canvas is too small to take the shape, it
is enlarged.
</p>
+
<dl>
<dt><i>_class</i> (ModuleParser.Class)</dt>
@@ -176,10 +174,10 @@
<a NAME="PackageDiagramBuilder.__addLocalClass" ID="PackageDiagramBuilder.__addLocalClass"></a>
<h4>PackageDiagramBuilder.__addLocalClass</h4>
<b>__addLocalClass</b>(<i>className, _class, x, y, isRbModule=False</i>)
-
<p>
Private method to add a class defined in the module.
</p>
+
<dl>
<dt><i>className</i> (str)</dt>
@@ -206,10 +204,10 @@
<a NAME="PackageDiagramBuilder.__addPackage" ID="PackageDiagramBuilder.__addPackage"></a>
<h4>PackageDiagramBuilder.__addPackage</h4>
<b>__addPackage</b>(<i>name, modules, x, y</i>)
-
<p>
Private method to add a package to the diagram.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -232,13 +230,13 @@
<a NAME="PackageDiagramBuilder.__arrangeClasses" ID="PackageDiagramBuilder.__arrangeClasses"></a>
<h4>PackageDiagramBuilder.__arrangeClasses</h4>
<b>__arrangeClasses</b>(<i>nodes, routes, whiteSpaceFactor=1.2</i>)
-
<p>
Private method to arrange the shapes on the canvas.
</p>
<p>
The algorithm is borrowed from Boa Constructor.
</p>
+
<dl>
<dt><i>nodes</i> (list of str)</dt>
@@ -258,11 +256,11 @@
<a NAME="PackageDiagramBuilder.__buildModulesDict" ID="PackageDiagramBuilder.__buildModulesDict"></a>
<h4>PackageDiagramBuilder.__buildModulesDict</h4>
<b>__buildModulesDict</b>(<i></i>)
-
<p>
Private method to build a dictionary of modules contained in the
package.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -278,11 +276,11 @@
<a NAME="PackageDiagramBuilder.__buildSubpackagesDict" ID="PackageDiagramBuilder.__buildSubpackagesDict"></a>
<h4>PackageDiagramBuilder.__buildSubpackagesDict</h4>
<b>__buildSubpackagesDict</b>(<i></i>)
-
<p>
Private method to build a dictionary of sub-packages contained in this
package.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -298,10 +296,10 @@
<a NAME="PackageDiagramBuilder.__createAssociations" ID="PackageDiagramBuilder.__createAssociations"></a>
<h4>PackageDiagramBuilder.__createAssociations</h4>
<b>__createAssociations</b>(<i>routes</i>)
-
<p>
Private method to generate the associations between the class shapes.
</p>
+
<dl>
<dt><i>routes</i> (list of tuple of (str, str))</dt>
@@ -312,10 +310,10 @@
<a NAME="PackageDiagramBuilder.__getCurrentShape" ID="PackageDiagramBuilder.__getCurrentShape"></a>
<h4>PackageDiagramBuilder.__getCurrentShape</h4>
<b>__getCurrentShape</b>(<i>name</i>)
-
<p>
Private method to get the named shape.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -338,20 +336,20 @@
<a NAME="PackageDiagramBuilder.buildDiagram" ID="PackageDiagramBuilder.buildDiagram"></a>
<h4>PackageDiagramBuilder.buildDiagram</h4>
<b>buildDiagram</b>(<i></i>)
-
<p>
Public method to build the class shapes of the package diagram.
</p>
<p>
The algorithm is borrowed from Boa Constructor.
</p>
+
<a NAME="PackageDiagramBuilder.fromDict" ID="PackageDiagramBuilder.fromDict"></a>
<h4>PackageDiagramBuilder.fromDict</h4>
<b>fromDict</b>(<i>version, data</i>)
-
<p>
Public method to populate the class with data persisted by 'toDict()'.
</p>
+
<dl>
<dt><i>version</i> (str)</dt>
@@ -379,17 +377,17 @@
<a NAME="PackageDiagramBuilder.initialize" ID="PackageDiagramBuilder.initialize"></a>
<h4>PackageDiagramBuilder.initialize</h4>
<b>initialize</b>(<i></i>)
-
<p>
Public method to initialize the object.
</p>
+
<a NAME="PackageDiagramBuilder.parsePersistenceData" ID="PackageDiagramBuilder.parsePersistenceData"></a>
<h4>PackageDiagramBuilder.parsePersistenceData</h4>
<b>parsePersistenceData</b>(<i>version, data</i>)
-
<p>
Public method to parse persisted data.
</p>
+
<dl>
<dt><i>version</i> (str)</dt>
@@ -416,10 +414,10 @@
<a NAME="PackageDiagramBuilder.toDict" ID="PackageDiagramBuilder.toDict"></a>
<h4>PackageDiagramBuilder.toDict</h4>
<b>toDict</b>(<i></i>)
-
<p>
Public method to collect data to be persisted.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -434,4 +432,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
