diff -r 3fc8dfeb6ebe -r b99e7fd55fd3 src/eric7/Documentation/Source/eric7.Graphics.UMLDiagramBuilder.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Graphics.UMLDiagramBuilder.html Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,247 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Graphics.UMLDiagramBuilder</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Graphics.UMLDiagramBuilder</h1>
+
+<p>
+Module implementing the UML diagram builder base class.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#UMLDiagramBuilder">UMLDiagramBuilder</a></td>
+<td>Class implementing the UML diagram builder base class.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="UMLDiagramBuilder" ID="UMLDiagramBuilder"></a>
+<h2>UMLDiagramBuilder</h2>
+
+<p>
+ Class implementing the UML diagram builder base class.
+</p>
+<h3>Derived from</h3>
+QObject
+<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="#UMLDiagramBuilder.__init__">UMLDiagramBuilder</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#UMLDiagramBuilder.buildDiagram">buildDiagram</a></td>
+<td>Public method to build the diagram.</td>
+</tr>
+<tr>
+<td><a href="#UMLDiagramBuilder.buildErrorMessage">buildErrorMessage</a></td>
+<td>Public method to build an error string to be included in the scene.</td>
+</tr>
+<tr>
+<td><a href="#UMLDiagramBuilder.fromDict">fromDict</a></td>
+<td>Public method to populate the class with data persisted by 'toDict()'.</td>
+</tr>
+<tr>
+<td><a href="#UMLDiagramBuilder.initialize">initialize</a></td>
+<td>Public method to initialize the object.</td>
+</tr>
+<tr>
+<td><a href="#UMLDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td>
+<td>Public method to parse persisted data.</td>
+</tr>
+<tr>
+<td><a href="#UMLDiagramBuilder.toDict">toDict</a></td>
+<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="UMLDiagramBuilder.__init__" ID="UMLDiagramBuilder.__init__"></a>
+<h4>UMLDiagramBuilder (Constructor)</h4>
+<b>UMLDiagramBuilder</b>(<i>dialog, view, project</i>)
+
+<p>
+ Constructor
+</p>
+<dl>
+
+<dt><i>dialog</i> (UMLDialog)</dt>
+<dd>
+reference to the UML dialog
+</dd>
+<dt><i>view</i> (UMLGraphicsView)</dt>
+<dd>
+reference to the view object
+</dd>
+<dt><i>project</i> (Project)</dt>
+<dd>
+reference to the project object
+</dd>
+</dl>
+<a NAME="UMLDiagramBuilder.buildDiagram" ID="UMLDiagramBuilder.buildDiagram"></a>
+<h4>UMLDiagramBuilder.buildDiagram</h4>
+<b>buildDiagram</b>(<i></i>)
+
+<p>
+ Public method to build the diagram.
+</p>
+<p>
+ This class must be implemented in subclasses.
+</p>
+<dl>
+
+<dt>Raises <b>NotImplementedError</b>:</dt>
+<dd>
+raised to indicate that this class
+ must be subclassed
+</dd>
+</dl>
+<a NAME="UMLDiagramBuilder.buildErrorMessage" ID="UMLDiagramBuilder.buildErrorMessage"></a>
+<h4>UMLDiagramBuilder.buildErrorMessage</h4>
+<b>buildErrorMessage</b>(<i>msg</i>)
+
+<p>
+ Public method to build an error string to be included in the scene.
+</p>
+<dl>
+
+<dt><i>msg</i> (str)</dt>
+<dd>
+error message
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+prepared error string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
+<a NAME="UMLDiagramBuilder.fromDict" ID="UMLDiagramBuilder.fromDict"></a>
+<h4>UMLDiagramBuilder.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>
+<dd>
+version of the data
+</dd>
+<dt><i>data</i> (dict)</dt>
+<dd>
+dictionary containing the persisted data
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple containing a flag indicating success and an info
+ message in case the diagram belongs to a different project
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
+</dd>
+</dl>
+<a NAME="UMLDiagramBuilder.initialize" ID="UMLDiagramBuilder.initialize"></a>
+<h4>UMLDiagramBuilder.initialize</h4>
+<b>initialize</b>(<i></i>)
+
+<p>
+ Public method to initialize the object.
+</p>
+<a NAME="UMLDiagramBuilder.parsePersistenceData" ID="UMLDiagramBuilder.parsePersistenceData"></a>
+<h4>UMLDiagramBuilder.parsePersistenceData</h4>
+<b>parsePersistenceData</b>(<i>version, data</i>)
+
+<p>
+ Public method to parse persisted data.
+</p>
+<dl>
+
+<dt><i>version</i> (str)</dt>
+<dd>
+version of the data
+</dd>
+<dt><i>data</i> (str)</dt>
+<dd>
+persisted data to be parsed
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<a NAME="UMLDiagramBuilder.toDict" ID="UMLDiagramBuilder.toDict"></a>
+<h4>UMLDiagramBuilder.toDict</h4>
+<b>toDict</b>(<i></i>)
+
+<p>
+ Public method to collect data to be persisted.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+dictionary containing data to be persisted
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
