--- a/src/eric7/Documentation/Source/eric7.Graphics.ImportsDiagramBuilder.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Graphics.ImportsDiagramBuilder.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,34 +7,32 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Graphics.ImportsDiagramBuilder</h1>
-
<p>
Module implementing a dialog showing an imports diagram of a package.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#ImportsDiagramBuilder">ImportsDiagramBuilder</a></td>
<td>Class implementing a builder for imports diagrams of a package.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="ImportsDiagramBuilder" ID="ImportsDiagramBuilder"></a>
<h2>ImportsDiagramBuilder</h2>
-
<p>
Class implementing a builder for imports diagrams of a package.
</p>
@@ -42,22 +40,21 @@
Note: Only package internal imports are shown in order to maintain
some readability.
</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="#ImportsDiagramBuilder.__init__">ImportsDiagramBuilder</a></td>
<td>Constructor</td>
@@ -99,19 +96,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="ImportsDiagramBuilder.__init__" ID="ImportsDiagramBuilder.__init__"></a>
<h4>ImportsDiagramBuilder (Constructor)</h4>
<b>ImportsDiagramBuilder</b>(<i>dialog, view, project, package, showExternalImports=False</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>dialog</i> (UMLDialog)</dt>
@@ -140,10 +138,10 @@
<a NAME="ImportsDiagramBuilder.__addModule" ID="ImportsDiagramBuilder.__addModule"></a>
<h4>ImportsDiagramBuilder.__addModule</h4>
<b>__addModule</b>(<i>name, classes, x, y</i>)
-
<p>
Private method to add a module to the diagram.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -178,13 +176,13 @@
<a NAME="ImportsDiagramBuilder.__arrangeNodes" ID="ImportsDiagramBuilder.__arrangeNodes"></a>
<h4>ImportsDiagramBuilder.__arrangeNodes</h4>
<b>__arrangeNodes</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>
@@ -204,11 +202,11 @@
<a NAME="ImportsDiagramBuilder.__buildModulesDict" ID="ImportsDiagramBuilder.__buildModulesDict"></a>
<h4>ImportsDiagramBuilder.__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>
@@ -224,10 +222,10 @@
<a NAME="ImportsDiagramBuilder.__createAssociations" ID="ImportsDiagramBuilder.__createAssociations"></a>
<h4>ImportsDiagramBuilder.__createAssociations</h4>
<b>__createAssociations</b>(<i>routes</i>)
-
<p>
Private method to generate the associations between the module shapes.
</p>
+
<dl>
<dt><i>routes</i> (list of tuple of (str, str))</dt>
@@ -238,17 +236,17 @@
<a NAME="ImportsDiagramBuilder.buildDiagram" ID="ImportsDiagramBuilder.buildDiagram"></a>
<h4>ImportsDiagramBuilder.buildDiagram</h4>
<b>buildDiagram</b>(<i></i>)
-
<p>
Public method to build the modules shapes of the diagram.
</p>
+
<a NAME="ImportsDiagramBuilder.fromDict" ID="ImportsDiagramBuilder.fromDict"></a>
<h4>ImportsDiagramBuilder.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>
@@ -276,17 +274,17 @@
<a NAME="ImportsDiagramBuilder.initialize" ID="ImportsDiagramBuilder.initialize"></a>
<h4>ImportsDiagramBuilder.initialize</h4>
<b>initialize</b>(<i></i>)
-
<p>
Public method to initialize the object.
</p>
+
<a NAME="ImportsDiagramBuilder.parsePersistenceData" ID="ImportsDiagramBuilder.parsePersistenceData"></a>
<h4>ImportsDiagramBuilder.parsePersistenceData</h4>
<b>parsePersistenceData</b>(<i>version, data</i>)
-
<p>
Public method to parse persisted data.
</p>
+
<dl>
<dt><i>version</i> (str)</dt>
@@ -313,10 +311,10 @@
<a NAME="ImportsDiagramBuilder.toDict" ID="ImportsDiagramBuilder.toDict"></a>
<h4>ImportsDiagramBuilder.toDict</h4>
<b>toDict</b>(<i></i>)
-
<p>
Public method to collect data to be persisted.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -331,4 +329,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
