Mercurial Repositories > eric / file diff

--- a/eric6/Documentation/Source/eric6.Graphics.UMLClassDiagramBuilder.html	Tue May 04 19:30:25 2021 +0200
+++ b/eric6/Documentation/Source/eric6.Graphics.UMLClassDiagramBuilder.html	Tue May 04 20:03:40 2021 +0200
@@ -124,26 +124,25 @@
 </p>
 <dl>
 
-<dt><i>dialog</i></dt>
+<dt><i>dialog</i> (UMLDialog)</dt>
 <dd>
-reference to the UML dialog (UMLDialog)
+reference to the UML dialog
 </dd>
-<dt><i>view</i></dt>
+<dt><i>view</i> (UMLGraphicsView)</dt>
 <dd>
-reference to the view object (UMLGraphicsView)
+reference to the view object
 </dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
 <dd>
-reference to the project object (Project)
+reference to the project object
 </dd>
-<dt><i>file</i></dt>
+<dt><i>file</i> (str)</dt>
 <dd>
-file name of a python module to be shown (string)
+file name of a python module to be shown
 </dd>
-<dt><i>noAttrs</i></dt>
+<dt><i>noAttrs</i> (bool)</dt>
 <dd>
 flag indicating, that no attributes should be shown
-            (boolean)
 </dd>
 </dl>
 <a NAME="UMLClassDiagramBuilder.__addExternalClass" ID="UMLClassDiagramBuilder.__addExternalClass"></a>
@@ -159,17 +158,17 @@
 </p>
 <dl>
 
-<dt><i>_class</i></dt>
+<dt><i>_class</i> (ModuleParser.Class)</dt>
 <dd>
-class to be shown (string)
+class to be shown
 </dd>
-<dt><i>x</i></dt>
+<dt><i>x</i> (float)</dt>
 <dd>
-x-coordinate (float)
+x-coordinate
 </dd>
-<dt><i>y</i></dt>
+<dt><i>y</i> (float)</dt>
 <dd>
-y-coordinate (float)
+y-coordinate
 </dd>
 </dl>
 <a NAME="UMLClassDiagramBuilder.__addLocalClass" ID="UMLClassDiagramBuilder.__addLocalClass"></a>
@@ -181,25 +180,25 @@
 </p>
 <dl>
 
-<dt><i>className</i></dt>
+<dt><i>className</i> (str)</dt>
 <dd>
-name of the class to be as a dictionary key (string)
+name of the class to be as a dictionary key
 </dd>
-<dt><i>_class</i></dt>
+<dt><i>_class</i> (ModuleParser.Class)</dt>
 <dd>
-class to be shown (ModuleParser.Class)
+class to be shown
 </dd>
-<dt><i>x</i></dt>
+<dt><i>x</i> (float)</dt>
 <dd>
-x-coordinate (float)
+x-coordinate
 </dd>
-<dt><i>y</i></dt>
+<dt><i>y</i> (float)</dt>
 <dd>
-y-coordinate (float)
+y-coordinate
 </dd>
-<dt><i>isRbModule</i></dt>
+<dt><i>isRbModule</i> (bool)</dt>
 <dd>
-flag indicating a Ruby module (boolean)
+flag indicating a Ruby module
 </dd>
 </dl>
 <a NAME="UMLClassDiagramBuilder.__arrangeClasses" ID="UMLClassDiagramBuilder.__arrangeClasses"></a>
@@ -214,18 +213,18 @@
 </p>
 <dl>
 
-<dt><i>nodes</i></dt>
+<dt><i>nodes</i> (list of str)</dt>
 <dd>
 list of nodes to arrange
 </dd>
-<dt><i>routes</i></dt>
+<dt><i>routes</i> (list of tuple of (str, str))</dt>
 <dd>
 list of routes
 </dd>
-<dt><i>whiteSpaceFactor</i></dt>
+<dt><i>whiteSpaceFactor</i> (float)</dt>
 <dd>
 factor to increase whitespace between
-            items (float)
+            items
 </dd>
 </dl>
 <a NAME="UMLClassDiagramBuilder.__createAssociations" ID="UMLClassDiagramBuilder.__createAssociations"></a>
@@ -237,7 +236,7 @@
 </p>
 <dl>
 
-<dt><i>routes</i></dt>
+<dt><i>routes</i> (list of tuple of (str, str))</dt>
 <dd>
 list of relationsships
 </dd>
@@ -251,15 +250,21 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the shape (string)
+name of the shape
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-shape (QGraphicsItem)
+shape
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+QGraphicsItem
 </dd>
 </dl>
 <a NAME="UMLClassDiagramBuilder.buildDiagram" ID="UMLClassDiagramBuilder.buildDiagram"></a>
@@ -282,7 +287,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-persisted data string (string)
+persisted data string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="UMLClassDiagramBuilder.initialize" ID="UMLClassDiagramBuilder.initialize"></a>
@@ -301,19 +312,25 @@
 </p>
 <dl>
 
-<dt><i>version</i></dt>
+<dt><i>version</i> (str)</dt>
 <dd>
-version of the data (string)
+version of the data
 </dd>
-<dt><i>data</i></dt>
+<dt><i>data</i> (str)</dt>
 <dd>
-persisted data to be parsed (string)
+persisted data to be parsed
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating success (boolean)
+flag indicating success
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>