Graphics/UMLDialog.py

changeset 2953
703452a2876f
parent 2401
4f428de32b69
child 2992
dbdf27746da5
diff -r 94fc661a54a2 -r 703452a2876f Graphics/UMLDialog.py
--- a/Graphics/UMLDialog.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/Graphics/UMLDialog.py	Sat Sep 28 19:06:25 2013 +0200
@@ -29,18 +29,19 @@
     
     FileVersions = ["1.0"]
     
-    def __init__(self, diagramType, project, path="", parent=None, initBuilder=True,
-                 **kwargs):
+    def __init__(self, diagramType, project, path="", parent=None,
+                 initBuilder=True, **kwargs):
         """
         Constructor
         
-        @param diagramType type of the diagram (one of ApplicationDiagram, ClassDiagram,
-            ImportsDiagram, NoDiagram, PackageDiagram)
+        @param diagramType type of the diagram (one of ApplicationDiagram,
+            ClassDiagram, ImportsDiagram, NoDiagram, PackageDiagram)
         @param project reference to the project object (Project)
         @param path file or directory path to build the diagram from (string)
         @param parent parent widget of the dialog (QWidget)
-        @keyparam initBuilder flag indicating to initialize the diagram builder (boolean)
-        @param kwargs diagram specific data
+        @keyparam initBuilder flag indicating to initialize the diagram
+            builder (boolean)
+        @keyparam kwargs diagram specific data
         """
         super().__init__(parent)
         self.setObjectName("UMLDialog")
@@ -155,7 +156,9 @@
         @param diagramType type of the diagram
             (one of ApplicationDiagram, ClassDiagram, ImportsDiagram, PackageDiagram)
         @param path file or directory path to build the diagram from (string)
-        @param kwargs diagram specific data
+        @keyparam kwargs diagram specific data
+        @return reference to the instantiated diagram builder
+        @exception ValueError raised to indicate an illegal diagram type
         """
         if diagramType == UMLDialog.ClassDiagram:
             from .UMLClassDiagramBuilder import UMLClassDiagramBuilder

eric ide

mercurial