src/eric7/Documentation/Source/eric7.Graphics.UMLDiagramBuilder.html

branch
eric7
changeset 10259
b51dfacef37f
parent 10070
9f5758c0fec1
child 10479
856476537696
diff -r e7764f992a01 -r b51dfacef37f src/eric7/Documentation/Source/eric7.Graphics.UMLDiagramBuilder.html
--- a/src/eric7/Documentation/Source/eric7.Graphics.UMLDiagramBuilder.html	Fri Oct 27 14:07:03 2023 +0200
+++ b/src/eric7/Documentation/Source/eric7.Graphics.UMLDiagramBuilder.html	Fri Oct 27 14:09:40 2023 +0200
@@ -68,7 +68,7 @@
 </tr>
 <tr>
 <td><a href="#UMLDiagramBuilder.fromDict">fromDict</a></td>
-<td></td>
+<td>Public method to populate the class with data persisted by 'toDict()'.</td>
 </tr>
 <tr>
 <td><a href="#UMLDiagramBuilder.initialize">initialize</a></td>
@@ -76,7 +76,7 @@
 </tr>
 <tr>
 <td><a href="#UMLDiagramBuilder.parsePersistenceData">parsePersistenceData</a></td>
-<td></td>
+<td>Public method to parse persisted data.</td>
 </tr>
 <tr>
 <td><a href="#UMLDiagramBuilder.toDict">toDict</a></td>
@@ -159,6 +159,33 @@
 <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>)
@@ -170,6 +197,32 @@
 <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>)

eric ide

mercurial