--- a/src/eric7/Documentation/Source/eric7.Graphics.UMLClassDiagramBuilder.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Graphics.UMLClassDiagramBuilder.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,50 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Graphics.UMLClassDiagramBuilder</h1>
-
<p>
Module implementing a dialog showing a UML like class diagram.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#UMLClassDiagramBuilder">UMLClassDiagramBuilder</a></td>
<td>Class implementing a builder for UML like class diagrams.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="UMLClassDiagramBuilder" ID="UMLClassDiagramBuilder"></a>
<h2>UMLClassDiagramBuilder</h2>
-
<p>
Class implementing a builder for UML like class diagrams.
</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="#UMLClassDiagramBuilder.__init__">UMLClassDiagramBuilder</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="UMLClassDiagramBuilder.__init__" ID="UMLClassDiagramBuilder.__init__"></a>
<h4>UMLClassDiagramBuilder (Constructor)</h4>
<b>UMLClassDiagramBuilder</b>(<i>dialog, view, project, file, noAttrs=False</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>dialog</i> (UMLDialog)</dt>
@@ -138,7 +136,6 @@
<a NAME="UMLClassDiagramBuilder.__addExternalClass" ID="UMLClassDiagramBuilder.__addExternalClass"></a>
<h4>UMLClassDiagramBuilder.__addExternalClass</h4>
<b>__addExternalClass</b>(<i>_class, x, y</i>)
-
<p>
Private method to add a class defined outside the module.
</p>
@@ -146,6 +143,7 @@
If the canvas is too small to take the shape, it
is enlarged.
</p>
+
<dl>
<dt><i>_class</i> (ModuleParser.Class)</dt>
@@ -164,10 +162,10 @@
<a NAME="UMLClassDiagramBuilder.__addLocalClass" ID="UMLClassDiagramBuilder.__addLocalClass"></a>
<h4>UMLClassDiagramBuilder.__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>
@@ -194,13 +192,13 @@
<a NAME="UMLClassDiagramBuilder.__arrangeClasses" ID="UMLClassDiagramBuilder.__arrangeClasses"></a>
<h4>UMLClassDiagramBuilder.__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>
@@ -220,10 +218,10 @@
<a NAME="UMLClassDiagramBuilder.__createAssociations" ID="UMLClassDiagramBuilder.__createAssociations"></a>
<h4>UMLClassDiagramBuilder.__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>
@@ -234,10 +232,10 @@
<a NAME="UMLClassDiagramBuilder.__getCurrentShape" ID="UMLClassDiagramBuilder.__getCurrentShape"></a>
<h4>UMLClassDiagramBuilder.__getCurrentShape</h4>
<b>__getCurrentShape</b>(<i>name</i>)
-
<p>
Private method to get the named shape.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -260,20 +258,20 @@
<a NAME="UMLClassDiagramBuilder.buildDiagram" ID="UMLClassDiagramBuilder.buildDiagram"></a>
<h4>UMLClassDiagramBuilder.buildDiagram</h4>
<b>buildDiagram</b>(<i></i>)
-
<p>
Public method to build the class shapes of the class diagram.
</p>
<p>
The algorithm is borrowed from Boa Constructor.
</p>
+
<a NAME="UMLClassDiagramBuilder.fromDict" ID="UMLClassDiagramBuilder.fromDict"></a>
<h4>UMLClassDiagramBuilder.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>
@@ -301,17 +299,17 @@
<a NAME="UMLClassDiagramBuilder.initialize" ID="UMLClassDiagramBuilder.initialize"></a>
<h4>UMLClassDiagramBuilder.initialize</h4>
<b>initialize</b>(<i></i>)
-
<p>
Public method to initialize the object.
</p>
+
<a NAME="UMLClassDiagramBuilder.parsePersistenceData" ID="UMLClassDiagramBuilder.parsePersistenceData"></a>
<h4>UMLClassDiagramBuilder.parsePersistenceData</h4>
<b>parsePersistenceData</b>(<i>version, data</i>)
-
<p>
Public method to parse persisted data.
</p>
+
<dl>
<dt><i>version</i> (str)</dt>
@@ -338,10 +336,10 @@
<a NAME="UMLClassDiagramBuilder.toDict" ID="UMLClassDiagramBuilder.toDict"></a>
<h4>UMLClassDiagramBuilder.toDict</h4>
<b>toDict</b>(<i></i>)
-
<p>
Public method to collect data to be persisted.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -356,4 +354,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
