Documentation/Source/eric5.Graphics.UMLDialog.html

changeset 2966
f85f686981ad
parent 2387
2d119e79ab54
child 3018
70924c0bdaf1
diff -r d133c7edd88a -r f85f686981ad Documentation/Source/eric5.Graphics.UMLDialog.html
--- a/Documentation/Source/eric5.Graphics.UMLDialog.html	Sun Sep 29 18:22:08 2013 +0200
+++ b/Documentation/Source/eric5.Graphics.UMLDialog.html	Sun Sep 29 18:23:27 2013 +0200
@@ -103,8 +103,8 @@
 </p><dl>
 <dt><i>diagramType</i></dt>
 <dd>
-type of the diagram (one of ApplicationDiagram, ClassDiagram,
-            ImportsDiagram, NoDiagram, PackageDiagram)
+type of the diagram (one of ApplicationDiagram,
+            ClassDiagram, ImportsDiagram, NoDiagram, PackageDiagram)
 </dd><dt><i>project</i></dt>
 <dd>
 reference to the project object (Project)
@@ -116,8 +116,9 @@
 parent widget of the dialog (QWidget)
 </dd><dt><i>initBuilder=</i></dt>
 <dd>
-flag indicating to initialize the diagram builder (boolean)
-</dd><dt><i>kwargs</i></dt>
+flag indicating to initialize the diagram
+            builder (boolean)
+</dd><dt><i>kwargs=</i></dt>
 <dd>
 diagram specific data
 </dd>
@@ -134,10 +135,20 @@
 </dd><dt><i>path</i></dt>
 <dd>
 file or directory path to build the diagram from (string)
-</dd><dt><i>kwargs</i></dt>
+</dd><dt><i>kwargs=</i></dt>
 <dd>
 diagram specific data
 </dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+reference to the instantiated diagram builder
+</dd>
+</dl><dl>
+<dt>Raises <b>ValueError</b>:</dt>
+<dd>
+raised to indicate an illegal diagram type
+</dd>
 </dl><a NAME="UMLDialog.__diagramTypeString" ID="UMLDialog.__diagramTypeString"></a>
 <h4>UMLDialog.__diagramTypeString</h4>
 <b>__diagramTypeString</b>(<i></i>)

eric ide

mercurial