Mercurial Repositories > eric / changeset
changeset
Changed some source docu string to the new style.
Tue, 04 May 2021 20:03:40 +0200
- author
- Detlev Offenbach <detlev@die-offenbachs.de>
- date
- Tue, 04 May 2021 20:03:40 +0200
- changeset 8289
- 871b40c5a77a
- parent 8288
- 809d5d5ac2ba
- child 8290
- 6970128e3d71
Changed some source docu string to the new style.
--- a/eric6/Documentation/Help/source.qhp Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Help/source.qhp Tue May 04 20:03:40 2021 +0200 @@ -17964,6 +17964,7 @@ <keyword name="getGraphics" id="getGraphics" ref="eric6.Preferences.__init__.html#getGraphics" /> <keyword name="getHelp" id="getHelp" ref="eric6.Preferences.__init__.html#getHelp" /> <keyword name="getHexEditor" id="getHexEditor" ref="eric6.Preferences.__init__.html#getHexEditor" /> + <keyword name="getHgExecutable" id="getHgExecutable" ref="eric6.Plugins.VcsPlugins.vcsMercurial.HgUtilities.html#getHgExecutable" /> <keyword name="getHomeDir" id="getHomeDir" ref="eric6.Utilities.__init__.html#getHomeDir" /> <keyword name="getHtmlPage" id="getHtmlPage" ref="eric6.WebBrowser.Tools.WebBrowserTools.html#getHtmlPage" /> <keyword name="getIcon" id="getIcon" ref="eric6.UI.PixmapCache.html#getIcon" />
--- a/eric6/Documentation/Source/eric6.Graphics.ApplicationDiagramBuilder.html Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.ApplicationDiagramBuilder.html Tue May 04 20:03:40 2021 +0200 @@ -120,22 +120,22 @@ </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>noModules</i></dt> +<dt><i>noModules</i> (bool)</dt> <dd> flag indicating, that no module names should be - shown (boolean) + shown </dd> </dl> <a NAME="ApplicationDiagramBuilder.__addPackage" ID="ApplicationDiagramBuilder.__addPackage"></a> @@ -147,28 +147,33 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -package name to be shown (string) +package name to be shown </dd> -<dt><i>modules</i></dt> +<dt><i>modules</i> (list of str)</dt> <dd> list of module names contained in the package - (list of strings) </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> <dl> <dt>Return:</dt> <dd> -reference to the package item (PackageItem) +reference to the package item +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +PackageItem </dd> </dl> <a NAME="ApplicationDiagramBuilder.__arrangeNodes" ID="ApplicationDiagramBuilder.__arrangeNodes"></a> @@ -208,7 +213,13 @@ <dl> <dt>Return:</dt> <dd> -dictionary of modules contained in the application. +dictionary of modules contained in the application +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict </dd> </dl> <a NAME="ApplicationDiagramBuilder.__createAssociations" ID="ApplicationDiagramBuilder.__createAssociations"></a> @@ -261,7 +272,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="ApplicationDiagramBuilder.parsePersistenceData" ID="ApplicationDiagramBuilder.parsePersistenceData"></a> @@ -273,19 +290,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>
--- a/eric6/Documentation/Source/eric6.Graphics.AssociationItem.html Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.AssociationItem.html Tue May 04 20:03:40 2021 +0200 @@ -110,7 +110,7 @@ </tr> <tr> <td><a href="#AssociationItem.__findRectIntersectionPoint">__findRectIntersectionPoint</a></td> -<td>Private method to find the intersetion point of a line with a rectangle.</td> +<td>Private method to find the intersection point of a line with a rectangle.</td> </tr> <tr> <td><a href="#AssociationItem.__mapRectFromItem">__mapRectFromItem</a></td> @@ -148,9 +148,9 @@ </p> <dl> -<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> @@ -158,7 +158,13 @@ <dd> tuple with the IDs of the source and destination items, the association type and a flag indicating to associate from top - to bottom (integer, integer, integer, boolean) + to bottom +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, int, int, bool) </dd> </dl> <a NAME="AssociationItem.__init__" ID="AssociationItem.__init__"></a> @@ -293,27 +299,33 @@ </p> <dl> -<dt><i>p1</i></dt> +<dt><i>p1</i> (QPointF)</dt> <dd> -first point of first line (QPointF) +first point of first line </dd> -<dt><i>p2</i></dt> +<dt><i>p2</i> (QPointF)</dt> <dd> -second point of first line (QPointF) +second point of first line </dd> -<dt><i>p3</i></dt> +<dt><i>p3</i> (QPointF)</dt> <dd> -first point of second line (QPointF) +first point of second line </dd> -<dt><i>p4</i></dt> +<dt><i>p4</i> (QPointF)</dt> <dd> -second point of second line (QPointF) +second point of second line </dd> </dl> <dl> <dt>Return:</dt> <dd> -the intersection point (QPointF) +the intersection point +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QPointF </dd> </dl> <a NAME="AssociationItem.__findPointRegion" ID="AssociationItem.__findPointRegion"></a> @@ -326,17 +338,17 @@ </p> <dl> -<dt><i>rect</i></dt> +<dt><i>rect</i> (QRectF)</dt> <dd> -rectangle to calculate the region for (QRectF) +rectangle to calculate the region for </dd> -<dt><i>posX</i></dt> +<dt><i>posX</i> (float)</dt> <dd> -x position of point (float) +x position of point </dd> -<dt><i>posY</i></dt> +<dt><i>posY</i> (float)</dt> <dd> -y position of point (float) +y position of point </dd> </dl> <dl> @@ -354,33 +366,45 @@ Center = On diagonal 1 and On diagonal 2 (the center)<br /> </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +AssociationPointRegion +</dd> +</dl> <a NAME="AssociationItem.__findRectIntersectionPoint" ID="AssociationItem.__findRectIntersectionPoint"></a> <h4>AssociationItem.__findRectIntersectionPoint</h4> <b>__findRectIntersectionPoint</b>(<i>item, p1, p2</i>) <p> - Private method to find the intersetion point of a line with a + Private method to find the intersection point of a line with a rectangle. </p> <dl> -<dt><i>item</i></dt> +<dt><i>item</i> (UMLItem)</dt> <dd> item to check against </dd> -<dt><i>p1</i></dt> +<dt><i>p1</i> (QPointF)</dt> <dd> -first point of the line (QPointF) +first point of the line </dd> -<dt><i>p2</i></dt> +<dt><i>p2</i> (QPointF)</dt> <dd> -second point of the line (QPointF) +second point of the line </dd> </dl> <dl> <dt>Return:</dt> <dd> -the intersection point (QPointF) +the intersection point +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QPointF </dd> </dl> <a NAME="AssociationItem.__mapRectFromItem" ID="AssociationItem.__mapRectFromItem"></a> @@ -393,15 +417,21 @@ </p> <dl> -<dt><i>item</i></dt> +<dt><i>item</i> (QGraphicsRectItem)</dt> <dd> -reference to the item to be mapped (QGraphicsRectItem) +reference to the item to be mapped </dd> </dl> <dl> <dt>Return:</dt> <dd> -item's rectangle in local coordinates (QRectF) +item's rectangle in local coordinates +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QRectF </dd> </dl> <a NAME="AssociationItem.__updateEndPoint" ID="AssociationItem.__updateEndPoint"></a> @@ -413,13 +443,13 @@ </p> <dl> -<dt><i>region</i></dt> +<dt><i>region</i> (AssociationPointRegion)</dt> <dd> -the region for the endpoint (integer) +the region for the endpoint </dd> -<dt><i>isWidgetA</i></dt> +<dt><i>isWidgetA</i> (bool)</dt> <dd> -flag indicating update for itemA is done (boolean) +flag indicating update for itemA is done </dd> </dl> <a NAME="AssociationItem.buildAssociationItemDataString" ID="AssociationItem.buildAssociationItemDataString"></a> @@ -436,7 +466,13 @@ <dl> <dt>Return:</dt> <dd> -persistence data (string) +persistence data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="AssociationItem.unassociate" ID="AssociationItem.unassociate"></a>
--- a/eric6/Documentation/Source/eric6.Graphics.ClassItem.html Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.ClassItem.html Tue May 04 20:03:40 2021 +0200 @@ -186,7 +186,13 @@ <dl> <dt>Return:</dt> <dd> -persistence data (string) +persistence data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="ClassItem.isExternal" ID="ClassItem.isExternal"></a> @@ -199,7 +205,13 @@ <dl> <dt>Return:</dt> <dd> -external state (boolean) +external state +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="ClassItem.paint" ID="ClassItem.paint"></a> @@ -211,17 +223,17 @@ </p> <dl> -<dt><i>painter</i></dt> +<dt><i>painter</i> (QPainter)</dt> <dd> -reference to the painter object (QPainter) +reference to the painter object </dd> -<dt><i>option</i></dt> +<dt><i>option</i> (QStyleOptionGraphicsItem)</dt> <dd> -style options (QStyleOptionGraphicsItem) +style options </dd> -<dt><i>widget</i></dt> +<dt><i>widget</i> (QWidget)</dt> <dd> -optional reference to the widget painted on (QWidget) +optional reference to the widget painted on </dd> </dl> <a NAME="ClassItem.parseItemDataString" ID="ClassItem.parseItemDataString"></a> @@ -233,19 +245,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> <a NAME="ClassItem.setModel" ID="ClassItem.setModel"></a> @@ -257,9 +275,9 @@ </p> <dl> -<dt><i>model</i></dt> +<dt><i>model</i> (ClassModel)</dt> <dd> -class model containing the class data (ClassModel) +class model containing the class data </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/eric6/Documentation/Source/eric6.Graphics.GraphicsUtilities.html Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.GraphicsUtilities.html Tue May 04 20:03:40 2021 +0200 @@ -98,7 +98,7 @@ </p> <dl> -<dt><i>routes</i></dt> +<dt><i>routes</i> (list of tuple of (str, str))</dt> <dd> list of routes between nodes </dd> @@ -109,6 +109,12 @@ dictionary of child and dictionary of parent relationships </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (dict, dict) +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -128,15 +134,15 @@ </p> <dl> -<dt><i>nodes</i></dt> +<dt><i>nodes</i> (str)</dt> <dd> list of nodes to be sorted </dd> -<dt><i>routes</i></dt> +<dt><i>routes</i> (list of tuple of (str, str))</dt> <dd> list of routes between the nodes </dd> -<dt><i>noRecursion</i></dt> +<dt><i>noRecursion</i> (bool)</dt> <dd> flag indicating, if recursion errors should be raised </dd> @@ -148,6 +154,12 @@ </dd> </dl> <dl> +<dt>Return Type:</dt> +<dd> +list of lists of str +</dd> +</dl> +<dl> <dt>Raises <b>RecursionError</b>:</dt> <dd>
--- a/eric6/Documentation/Source/eric6.Graphics.ImportsDiagramBuilder.html Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.ImportsDiagramBuilder.html Tue May 04 20:03:40 2021 +0200 @@ -124,27 +124,27 @@ </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>package</i></dt> +<dt><i>package</i> (str)</dt> <dd> name of a python package to show the import - relationships (string) + relationships </dd> -<dt><i>showExternalImports</i></dt> +<dt><i>showExternalImports</i> (bool)</dt> <dd> flag indicating to show exports from - outside the package (boolean) + outside the package </dd> </dl> <a NAME="ImportsDiagramBuilder.__addModule" ID="ImportsDiagramBuilder.__addModule"></a> @@ -156,28 +156,33 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -module name to be shown (string) +module name to be shown </dd> -<dt><i>classes</i></dt> +<dt><i>classes</i> (list of str)</dt> <dd> list of class names contained in the module - (list of strings) </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> <dl> <dt>Return:</dt> <dd> -reference to the imports item (ModuleItem) +reference to the imports item +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +ModuleItem </dd> </dl> <a NAME="ImportsDiagramBuilder.__arrangeNodes" ID="ImportsDiagramBuilder.__arrangeNodes"></a> @@ -217,7 +222,13 @@ <dl> <dt>Return:</dt> <dd> -dictionary of modules contained in the package. +dictionary of modules contained in the package +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict </dd> </dl> <a NAME="ImportsDiagramBuilder.__createAssociations" ID="ImportsDiagramBuilder.__createAssociations"></a> @@ -251,7 +262,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="ImportsDiagramBuilder.initialize" ID="ImportsDiagramBuilder.initialize"></a> @@ -270,19 +287,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>
--- a/eric6/Documentation/Source/eric6.Graphics.ModuleItem.html Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.ModuleItem.html Tue May 04 20:03:40 2021 +0200 @@ -174,7 +174,13 @@ <dl> <dt>Return:</dt> <dd> -persistence data (string) +persistence data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="ModuleItem.paint" ID="ModuleItem.paint"></a> @@ -186,17 +192,17 @@ </p> <dl> -<dt><i>painter</i></dt> +<dt><i>painter</i> (QPainter)</dt> <dd> -reference to the painter object (QPainter) +reference to the painter object </dd> -<dt><i>option</i></dt> +<dt><i>option</i> (QStyleOptionGraphicsItem)</dt> <dd> -style options (QStyleOptionGraphicsItem) +style options </dd> -<dt><i>widget</i></dt> +<dt><i>widget</i> (QWidget)</dt> <dd> -optional reference to the widget painted on (QWidget) +optional reference to the widget painted on </dd> </dl> <a NAME="ModuleItem.parseItemDataString" ID="ModuleItem.parseItemDataString"></a> @@ -208,19 +214,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> <a NAME="ModuleItem.setModel" ID="ModuleItem.setModel"></a> @@ -232,9 +244,9 @@ </p> <dl> -<dt><i>model</i></dt> +<dt><i>model</i> (ModuleModel)</dt> <dd> -module model containing the module data (ModuleModel) +module model containing the module data </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -290,13 +302,13 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -the module name (string) +the module name </dd> -<dt><i>classlist</i></dt> +<dt><i>classlist</i> (list of str)</dt> <dd> -list of class names (list of strings) +list of class names </dd> </dl> <a NAME="ModuleModel.addClass" ID="ModuleModel.addClass"></a> @@ -308,9 +320,9 @@ </p> <dl> -<dt><i>classname</i></dt> +<dt><i>classname</i> (str)</dt> <dd> -class name to be added (string) +class name to be added </dd> </dl> <a NAME="ModuleModel.getClasses" ID="ModuleModel.getClasses"></a> @@ -323,7 +335,13 @@ <dl> <dt>Return:</dt> <dd> -list of class names (list of strings) +list of class names +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/eric6/Documentation/Source/eric6.Graphics.PackageDiagramBuilder.html Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.PackageDiagramBuilder.html Tue May 04 20:03:40 2021 +0200 @@ -23,7 +23,7 @@ <h1>eric6.Graphics.PackageDiagramBuilder</h1> <p> -Module implementing a dialog showing a UML like class diagram of a package. +Module implementing a dialog showing an UML like class diagram of a package. </p> <h3>Global Attributes</h3> @@ -136,26 +136,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>package</i></dt> +<dt><i>package</i> (str)</dt> <dd> -name of a python package to be shown (string) +name of a python package 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="PackageDiagramBuilder.__addExternalClass" ID="PackageDiagramBuilder.__addExternalClass"></a> @@ -171,17 +170,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="PackageDiagramBuilder.__addLocalClass" ID="PackageDiagramBuilder.__addLocalClass"></a> @@ -193,25 +192,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="PackageDiagramBuilder.__addPackage" ID="PackageDiagramBuilder.__addPackage"></a> @@ -223,22 +222,21 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -package name to be shown (string) +package name to be shown </dd> -<dt><i>modules</i></dt> +<dt><i>modules</i> (list of str)</dt> <dd> list of module names contained in the package - (list of strings) </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="PackageDiagramBuilder.__arrangeClasses" ID="PackageDiagramBuilder.__arrangeClasses"></a> @@ -253,18 +251,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="PackageDiagramBuilder.__buildModulesDict" ID="PackageDiagramBuilder.__buildModulesDict"></a> @@ -278,7 +276,13 @@ <dl> <dt>Return:</dt> <dd> -dictionary of modules contained in the package. +dictionary of modules contained in the package +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict </dd> </dl> <a NAME="PackageDiagramBuilder.__buildSubpackagesDict" ID="PackageDiagramBuilder.__buildSubpackagesDict"></a> @@ -295,6 +299,12 @@ dictionary of sub-packages contained in this package </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> <a NAME="PackageDiagramBuilder.__createAssociations" ID="PackageDiagramBuilder.__createAssociations"></a> <h4>PackageDiagramBuilder.__createAssociations</h4> <b>__createAssociations</b>(<i>routes</i>) @@ -304,7 +314,7 @@ </p> <dl> -<dt><i>routes</i></dt> +<dt><i>routes</i> (list of tuple of (str, str))</dt> <dd> list of relationsships </dd> @@ -318,15 +328,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 (QCanvasItem) +shape +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QCanvasItem </dd> </dl> <a NAME="PackageDiagramBuilder.buildDiagram" ID="PackageDiagramBuilder.buildDiagram"></a> @@ -349,7 +365,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="PackageDiagramBuilder.initialize" ID="PackageDiagramBuilder.initialize"></a> @@ -368,19 +390,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>
--- a/eric6/Documentation/Source/eric6.Graphics.PackageItem.html Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.PackageItem.html Tue May 04 20:03:40 2021 +0200 @@ -179,7 +179,13 @@ <dl> <dt>Return:</dt> <dd> -persistence data (string) +persistence data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="PackageItem.paint" ID="PackageItem.paint"></a> @@ -191,17 +197,17 @@ </p> <dl> -<dt><i>painter</i></dt> +<dt><i>painter</i> (QPainter)</dt> <dd> -reference to the painter object (QPainter) +reference to the painter object </dd> -<dt><i>option</i></dt> +<dt><i>option</i> (QStyleOptionGraphicsItem)</dt> <dd> -style options (QStyleOptionGraphicsItem) +style options </dd> -<dt><i>widget</i></dt> +<dt><i>widget</i> (QWidget)</dt> <dd> -optional reference to the widget painted on (QWidget) +optional reference to the widget painted on </dd> </dl> <a NAME="PackageItem.parseItemDataString" ID="PackageItem.parseItemDataString"></a> @@ -213,19 +219,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> <a NAME="PackageItem.setModel" ID="PackageItem.setModel"></a> @@ -237,9 +249,9 @@ </p> <dl> -<dt><i>model</i></dt> +<dt><i>model</i> (PackageModel)</dt> <dd> -package model containing the package data (PackageModel) +package model containing the package data </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -295,13 +307,13 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -package name (string) +package name </dd> -<dt><i>moduleslist</i></dt> +<dt><i>moduleslist</i> (list of str)</dt> <dd> -list of module names (list of strings) +list of module names </dd> </dl> <a NAME="PackageModel.addModule" ID="PackageModel.addModule"></a> @@ -313,9 +325,9 @@ </p> <dl> -<dt><i>modulename</i></dt> +<dt><i>modulename</i> (str)</dt> <dd> -module name to be added (string) +module name to be added </dd> </dl> <a NAME="PackageModel.getModules" ID="PackageModel.getModules"></a> @@ -328,7 +340,13 @@ <dl> <dt>Return:</dt> <dd> -list of module names (list of strings) +list of module names +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/eric6/Documentation/Source/eric6.Graphics.PixmapDiagram.html Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.PixmapDiagram.html Tue May 04 20:03:40 2021 +0200 @@ -168,17 +168,17 @@ </p> <dl> -<dt><i>pixmap</i></dt> +<dt><i>pixmap</i> (str)</dt> <dd> -filename of a graphics file to show (string) +filename of a graphics file to show </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget of the view (QWidget) +parent widget of the view </dd> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name of the view widget (string) +name of the view widget </dd> </dl> <a NAME="PixmapDiagram.__adjustScrollBar" ID="PixmapDiagram.__adjustScrollBar"></a> @@ -190,13 +190,13 @@ </p> <dl> -<dt><i>scrollBar</i></dt> +<dt><i>scrollBar</i> (QScrollBar)</dt> <dd> -reference to the scrollbar object (QScrollBar) +reference to the scrollbar object </dd> -<dt><i>factor</i></dt> +<dt><i>factor</i> (float)</dt> <dd> -factor to adjust by (float) +factor to adjust by </dd> </dl> <a NAME="PixmapDiagram.__doZoom" ID="PixmapDiagram.__doZoom"></a> @@ -208,9 +208,9 @@ </p> <dl> -<dt><i>value</i></dt> +<dt><i>value</i> (int)</dt> <dd> -zoom value in percent (integer) +zoom value in percent </dd> </dl> <a NAME="PixmapDiagram.__initActions" ID="PixmapDiagram.__initActions"></a> @@ -243,15 +243,21 @@ </p> <dl> -<dt><i>zoom</i></dt> +<dt><i>zoom</i> (int)</dt> <dd> -zoom factor (integer) +zoom factor </dd> </dl> <dl> <dt>Return:</dt> <dd> -index of zoom factor (integer) +index of zoom factor +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="PixmapDiagram.__print" ID="PixmapDiagram.__print"></a> @@ -263,9 +269,9 @@ </p> <dl> -<dt><i>printer</i></dt> +<dt><i>printer</i> (QPrinter)</dt> <dd> -reference to the printer object (QPrinter) +reference to the printer object </dd> </dl> <a NAME="PixmapDiagram.__printDiagram" ID="PixmapDiagram.__printDiagram"></a> @@ -291,9 +297,9 @@ </p> <dl> -<dt><i>coord</i></dt> +<dt><i>coord</i> (QPoint)</dt> <dd> -the position of the mouse pointer (QPoint) +the position of the mouse pointer </dd> </dl> <a NAME="PixmapDiagram.__showPixmap" ID="PixmapDiagram.__showPixmap"></a> @@ -305,15 +311,21 @@ </p> <dl> -<dt><i>filename</i></dt> +<dt><i>filename</i> (str)</dt> <dd> -name of the file to be shown (string) +name of the file to be shown </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> <a NAME="PixmapDiagram.__zoom" ID="PixmapDiagram.__zoom"></a> @@ -326,7 +338,13 @@ <dl> <dt>Return:</dt> <dd> -current zoom factor in percent (integer) +current zoom factor in percent +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="PixmapDiagram.__zoomIn" ID="PixmapDiagram.__zoomIn"></a> @@ -359,15 +377,21 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QEvent)</dt> <dd> -reference to the event (QEvent) +reference to the event </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, if the event was handled (boolean) +flag indicating, if the event was handled +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="PixmapDiagram.gestureEvent" ID="PixmapDiagram.gestureEvent"></a> @@ -379,9 +403,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QGestureEvent)</dt> <dd> -reference to the gesture event (QGestureEvent +reference to the gesture event </dd> </dl> <a NAME="PixmapDiagram.getDiagramName" ID="PixmapDiagram.getDiagramName"></a> @@ -397,6 +421,12 @@ name for the diagram </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> <a NAME="PixmapDiagram.getStatus" ID="PixmapDiagram.getStatus"></a> <h4>PixmapDiagram.getStatus</h4> <b>getStatus</b>(<i></i>) @@ -407,7 +437,13 @@ <dl> <dt>Return:</dt> <dd> -flag indicating a successful pixmap loading (boolean) +flag indicating a successful pixmap loading +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="PixmapDiagram.wheelEvent" ID="PixmapDiagram.wheelEvent"></a> @@ -419,9 +455,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QWheelEvent)</dt> <dd> -reference to the wheel event (QWheelEvent) +reference to the wheel event </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/eric6/Documentation/Source/eric6.Graphics.SvgDiagram.html Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.SvgDiagram.html Tue May 04 20:03:40 2021 +0200 @@ -160,17 +160,17 @@ </p> <dl> -<dt><i>svgFile</i></dt> +<dt><i>svgFile</i> (str)</dt> <dd> -filename of a SVG graphics file to show (string) +filename of a SVG graphics file to show </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget of the view (QWidget) +parent widget of the view </dd> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name of the view widget (string) +name of the view widget </dd> </dl> <a NAME="SvgDiagram.__adjustScrollBar" ID="SvgDiagram.__adjustScrollBar"></a> @@ -182,13 +182,13 @@ </p> <dl> -<dt><i>scrollBar</i></dt> +<dt><i>scrollBar</i> (QScrollBar)</dt> <dd> -reference to the scrollbar object (QScrollBar) +reference to the scrollbar object </dd> -<dt><i>factor</i></dt> +<dt><i>factor</i> (float)</dt> <dd> -factor to adjust by (float) +factor to adjust by </dd> </dl> <a NAME="SvgDiagram.__doZoom" ID="SvgDiagram.__doZoom"></a> @@ -200,9 +200,9 @@ </p> <dl> -<dt><i>value</i></dt> +<dt><i>value</i> (int)</dt> <dd> -zoom value in percent (integer) +zoom value in percent </dd> </dl> <a NAME="SvgDiagram.__initActions" ID="SvgDiagram.__initActions"></a> @@ -235,15 +235,21 @@ </p> <dl> -<dt><i>zoom</i></dt> +<dt><i>zoom</i> (int)</dt> <dd> -zoom factor (integer) +zoom factor </dd> </dl> <dl> <dt>Return:</dt> <dd> -index of zoom factor (integer) +index of zoom factor +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="SvgDiagram.__print" ID="SvgDiagram.__print"></a> @@ -255,9 +261,9 @@ </p> <dl> -<dt><i>printer</i></dt> +<dt><i>printer</i> (QPrinter)</dt> <dd> -reference to the printer object (QPrinter) +reference to the printer object </dd> </dl> <a NAME="SvgDiagram.__printDiagram" ID="SvgDiagram.__printDiagram"></a> @@ -283,9 +289,9 @@ </p> <dl> -<dt><i>coord</i></dt> +<dt><i>coord</i> (QPoint)</dt> <dd> -the position of the mouse pointer (QPoint) +the position of the mouse pointer </dd> </dl> <a NAME="SvgDiagram.__zoom" ID="SvgDiagram.__zoom"></a> @@ -298,7 +304,13 @@ <dl> <dt>Return:</dt> <dd> -current zoom factor in percent (integer) +current zoom factor in percent +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="SvgDiagram.__zoomIn" ID="SvgDiagram.__zoomIn"></a> @@ -331,15 +343,21 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QEvent)</dt> <dd> -reference to the event (QEvent) +reference to the event </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, if the event was handled (boolean) +flag indicating, if the event was handled +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="SvgDiagram.gestureEvent" ID="SvgDiagram.gestureEvent"></a> @@ -351,9 +369,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QGestureEvent)</dt> <dd> -reference to the gesture event (QGestureEvent +reference to the gesture event </dd> </dl> <a NAME="SvgDiagram.getDiagramName" ID="SvgDiagram.getDiagramName"></a> @@ -369,6 +387,12 @@ name for the diagram </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +str +</dd> +</dl> <a NAME="SvgDiagram.wheelEvent" ID="SvgDiagram.wheelEvent"></a> <h4>SvgDiagram.wheelEvent</h4> <b>wheelEvent</b>(<i>evt</i>) @@ -378,9 +402,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QWheelEvent)</dt> <dd> -reference to the wheel event (QWheelEvent) +reference to the wheel event </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- 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>
--- a/eric6/Documentation/Source/eric6.Graphics.UMLDiagramBuilder.html Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.UMLDiagramBuilder.html Tue May 04 20:03:40 2021 +0200 @@ -104,17 +104,17 @@ </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> </dl> <a NAME="UMLDiagramBuilder.buildDiagram" ID="UMLDiagramBuilder.buildDiagram"></a> @@ -145,7 +145,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="UMLDiagramBuilder.initialize" ID="UMLDiagramBuilder.initialize"></a> @@ -164,19 +170,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>
--- a/eric6/Documentation/Source/eric6.Graphics.UMLDialog.html Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.UMLDialog.html Tue May 04 20:03:40 2021 +0200 @@ -90,7 +90,7 @@ </tr> <tr> <td><a href="#UMLDialog.__relayout">__relayout</a></td> -<td>Private method to relayout the diagram.</td> +<td>Private method to re-layout the diagram.</td> </tr> <tr> <td><a href="#UMLDialog.__save">__save</a></td> @@ -207,7 +207,7 @@ <b>__relayout</b>(<i></i>) <p> - Private method to relayout the diagram. + Private method to re-layout the diagram. </p> <a NAME="UMLDialog.__save" ID="UMLDialog.__save"></a> <h4>UMLDialog.__save</h4> @@ -225,9 +225,9 @@ </p> <dl> -<dt><i>filename</i></dt> +<dt><i>filename</i> (str)</dt> <dd> -name of the file to write to (string) +name of the file to write to </dd> </dl> <a NAME="UMLDialog.__showInvalidDataMessage" ID="UMLDialog.__showInvalidDataMessage"></a> @@ -239,13 +239,13 @@ </p> <dl> -<dt><i>filename</i></dt> +<dt><i>filename</i> (str)</dt> <dd> -name of the file containing the invalid data (string) +name of the file containing the invalid data </dd> -<dt><i>linenum</i></dt> +<dt><i>linenum</i> (int)</dt> <dd> -number of the invalid line (integer) +number of the invalid line </dd> </dl> <a NAME="UMLDialog.load" ID="UMLDialog.load"></a> @@ -283,10 +283,10 @@ </p> <dl> -<dt><i>fromFile</i></dt> +<dt><i>fromFile</i> (bool)</dt> <dd> flag indicating, that the diagram was loaded - from file (boolean) + from file </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/eric6/Documentation/Source/eric6.Graphics.UMLGraphicsView.html Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.UMLGraphicsView.html Tue May 04 20:03:40 2021 +0200 @@ -225,13 +225,13 @@ </p> <dl> -<dt><i>scene</i></dt> +<dt><i>scene</i> (QGraphicsScene)</dt> <dd> -reference to the scene object (QGraphicsScene) +reference to the scene object </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget of the view (QWidget) +parent widget of the view </dd> </dl> <a NAME="UMLGraphicsView.__alignShapes" ID="UMLGraphicsView.__alignShapes"></a> @@ -243,9 +243,9 @@ </p> <dl> -<dt><i>alignment</i></dt> +<dt><i>alignment</i> (Qt.AlignmentFlag)</dt> <dd> -alignment type (Qt.AlignmentFlag) +alignment type </dd> </dl> <a NAME="UMLGraphicsView.__checkSizeActions" ID="UMLGraphicsView.__checkSizeActions"></a> @@ -306,15 +306,21 @@ </p> <dl> -<dt><i>items</i></dt> +<dt><i>items</i> (list of UMLItem)</dt> <dd> -list of items to operate on (list of UMLItem) +list of items to operate on </dd> </dl> <dl> <dt>Return:</dt> <dd> -bounding rectangle (QRectF) +bounding rectangle +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QRectF </dd> </dl> <a NAME="UMLGraphicsView.__printPreviewPrint" ID="UMLGraphicsView.__printPreviewPrint"></a> @@ -326,9 +332,9 @@ </p> <dl> -<dt><i>printer</i></dt> +<dt><i>printer</i> (QPrinter)</dt> <dd> -reference to the printer object (QPrinter) +reference to the printer object </dd> </dl> <a NAME="UMLGraphicsView.__relayout" ID="UMLGraphicsView.__relayout"></a> @@ -354,9 +360,9 @@ </p> <dl> -<dt><i>areas</i></dt> +<dt><i>areas</i> (list of QRectF)</dt> <dd> -list of rectangles that contain changes (list of QRectF) +list of rectangles that contain changes </dd> </dl> <a NAME="UMLGraphicsView.__setSize" ID="UMLGraphicsView.__setSize"></a> @@ -375,10 +381,10 @@ </p> <dl> -<dt><i>limit</i></dt> +<dt><i>limit</i> (bool)</dt> <dd> flag indicating to limit the scene to the - initial size (boolean) + initial size </dd> </dl> <a NAME="UMLGraphicsView.event" ID="UMLGraphicsView.event"></a> @@ -390,15 +396,21 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QEvent)</dt> <dd> -reference to the event (QEvent) +reference to the event </dd> </dl> <dl> <dt>Return:</dt> <dd> -flag indicating, if the event was handled (boolean) +flag indicating, if the event was handled +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool </dd> </dl> <a NAME="UMLGraphicsView.filteredItems" ID="UMLGraphicsView.filteredItems"></a> @@ -410,20 +422,25 @@ </p> <dl> -<dt><i>items</i></dt> +<dt><i>items</i> (QGraphicsItem)</dt> <dd> list of items as returned by the scene object - (QGraphicsItem) </dd> -<dt><i>itemType</i></dt> +<dt><i>itemType</i> (class)</dt> <dd> -type to be filtered (class) +type to be filtered </dd> </dl> <dl> <dt>Return:</dt> <dd> -list of interesting collision items (QGraphicsItem) +list of interesting collision items +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QGraphicsItem </dd> </dl> <a NAME="UMLGraphicsView.findItem" ID="UMLGraphicsView.findItem"></a> @@ -435,15 +452,21 @@ </p> <dl> -<dt><i>itemId</i></dt> +<dt><i>itemId</i> (int)</dt> <dd> -of the item to search for (integer) +of the item to search for </dd> </dl> <dl> <dt>Return:</dt> <dd> -item found (UMLItem) or None +item found or None +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +UMLItem </dd> </dl> <a NAME="UMLGraphicsView.findItemByName" ID="UMLGraphicsView.findItemByName"></a> @@ -455,15 +478,21 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name to look for (string) +name to look for </dd> </dl> <dl> <dt>Return:</dt> <dd> -item found (UMLItem) or None +item found or None +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +UMLItem </dd> </dl> <a NAME="UMLGraphicsView.gestureEvent" ID="UMLGraphicsView.gestureEvent"></a> @@ -475,9 +504,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QGestureEvent)</dt> <dd> -reference to the gesture event (QGestureEvent +reference to the gesture event </dd> </dl> <a NAME="UMLGraphicsView.getItemId" ID="UMLGraphicsView.getItemId"></a> @@ -490,7 +519,13 @@ <dl> <dt>Return:</dt> <dd> -item ID (integer) +item ID +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="UMLGraphicsView.getPersistenceData" ID="UMLGraphicsView.getPersistenceData"></a> @@ -503,7 +538,13 @@ <dl> <dt>Return:</dt> <dd> -list of data to be persisted (list of strings) +list of data to be persisted +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str </dd> </dl> <a NAME="UMLGraphicsView.initToolBar" ID="UMLGraphicsView.initToolBar"></a> @@ -516,7 +557,13 @@ <dl> <dt>Return:</dt> <dd> -the populated toolBar (QToolBar) +the populated toolBar +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +QToolBar </dd> </dl> <a NAME="UMLGraphicsView.keyPressEvent" ID="UMLGraphicsView.keyPressEvent"></a> @@ -528,9 +575,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QKeyEvent)</dt> <dd> -reference to the key event (QKeyEvent) +reference to the key event </dd> </dl> <a NAME="UMLGraphicsView.parsePersistenceData" ID="UMLGraphicsView.parsePersistenceData"></a> @@ -542,20 +589,26 @@ </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> (list of str)</dt> <dd> -persisted data to be parsed (list of string) +persisted data to be parsed </dd> </dl> <dl> <dt>Return:</dt> <dd> tuple of flag indicating success (boolean) and faulty line - number (integer) + number +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="UMLGraphicsView.printDiagram" ID="UMLGraphicsView.printDiagram"></a> @@ -588,9 +641,9 @@ </p> <dl> -<dt><i>item</i></dt> +<dt><i>item</i> (QGraphicsItemItem)</dt> <dd> -item to be selected (QGraphicsItemItem) +item to be selected </dd> </dl> <a NAME="UMLGraphicsView.selectItems" ID="UMLGraphicsView.selectItems"></a> @@ -602,9 +655,9 @@ </p> <dl> -<dt><i>items</i></dt> +<dt><i>items</i> (list of QGraphicsItemItem)</dt> <dd> -list of items to be selected (list of QGraphicsItemItem) +list of items to be selected </dd> </dl> <a NAME="UMLGraphicsView.setDiagramName" ID="UMLGraphicsView.setDiagramName"></a> @@ -616,9 +669,9 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -diagram name (string) +diagram name </dd> </dl> <a NAME="UMLGraphicsView.wheelEvent" ID="UMLGraphicsView.wheelEvent"></a> @@ -630,9 +683,9 @@ </p> <dl> -<dt><i>evt</i></dt> +<dt><i>evt</i> (QWheelEvent)</dt> <dd> -reference to the wheel event (QWheelEvent) +reference to the wheel event </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/eric6/Documentation/Source/eric6.Graphics.UMLItem.html Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.UMLItem.html Tue May 04 20:03:40 2021 +0200 @@ -186,9 +186,9 @@ </p> <dl> -<dt><i>assoc</i></dt> +<dt><i>assoc</i> (AssociationWidget)</dt> <dd> -association to be added (AssociationWidget) +association to be added </dd> </dl> <a NAME="UMLItem.adjustAssociations" ID="UMLItem.adjustAssociations"></a> @@ -213,7 +213,13 @@ <dl> <dt>Return:</dt> <dd> -persistence data (string) +persistence data +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="UMLItem.getId" ID="UMLItem.getId"></a> @@ -226,7 +232,13 @@ <dl> <dt>Return:</dt> <dd> -ID of the item (integer) +ID of the item +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +int </dd> </dl> <a NAME="UMLItem.getItemType" ID="UMLItem.getItemType"></a> @@ -239,7 +251,13 @@ <dl> <dt>Return:</dt> <dd> -item type (string) +item type +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="UMLItem.getName" ID="UMLItem.getName"></a> @@ -252,7 +270,13 @@ <dl> <dt>Return:</dt> <dd> -item name (string) +item name +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="UMLItem.itemChange" ID="UMLItem.itemChange"></a> @@ -264,9 +288,9 @@ </p> <dl> -<dt><i>change</i></dt> +<dt><i>change</i> (QGraphicsItem.GraphicsItemChange)</dt> <dd> -the item's change (QGraphicsItem.GraphicsItemChange) +the item's change </dd> <dt><i>value</i></dt> <dd> @@ -288,13 +312,13 @@ </p> <dl> -<dt><i>dx</i></dt> +<dt><i>dx</i> (float)</dt> <dd> -relative movement in x-direction (float) +relative movement in x-direction </dd> -<dt><i>dy</i></dt> +<dt><i>dy</i> (float)</dt> <dd> -relative movement in y-direction (float) +relative movement in y-direction </dd> </dl> <a NAME="UMLItem.paint" ID="UMLItem.paint"></a> @@ -306,17 +330,17 @@ </p> <dl> -<dt><i>painter</i></dt> +<dt><i>painter</i> (QPainter)</dt> <dd> -reference to the painter object (QPainter) +reference to the painter object </dd> -<dt><i>option</i></dt> +<dt><i>option</i> (QStyleOptionGraphicsItem)</dt> <dd> -style options (QStyleOptionGraphicsItem) +style options </dd> -<dt><i>widget</i></dt> +<dt><i>widget</i> (QWidget)</dt> <dd> -optional reference to the widget painted on (QWidget) +optional reference to the widget painted on </dd> </dl> <a NAME="UMLItem.parseItemDataString" ID="UMLItem.parseItemDataString"></a> @@ -328,19 +352,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> <a NAME="UMLItem.removeAssociation" ID="UMLItem.removeAssociation"></a> @@ -352,9 +382,9 @@ </p> <dl> -<dt><i>assoc</i></dt> +<dt><i>assoc</i> (AssociationWidget)</dt> <dd> -association to be removed (AssociationWidget) +association to be removed </dd> </dl> <a NAME="UMLItem.removeAssociations" ID="UMLItem.removeAssociations"></a> @@ -373,9 +403,9 @@ </p> <dl> -<dt><i>itemId</i></dt> +<dt><i>itemId</i> (int)</dt> <dd> -assigned ID (integer) +assigned ID </dd> </dl> <a NAME="UMLItem.setPos" ID="UMLItem.setPos"></a> @@ -387,13 +417,13 @@ </p> <dl> -<dt><i>x</i></dt> +<dt><i>x</i> (float)</dt> <dd> -absolute x-position (float) +absolute x-position </dd> -<dt><i>y</i></dt> +<dt><i>y</i> (float)</dt> <dd> -absolute y-position (float) +absolute y-position </dd> </dl> <a NAME="UMLItem.setSize" ID="UMLItem.setSize"></a> @@ -405,13 +435,13 @@ </p> <dl> -<dt><i>width</i></dt> +<dt><i>width</i> (float)</dt> <dd> -width of the rectangle (float) +width of the rectangle </dd> -<dt><i>height</i></dt> +<dt><i>height</i> (float)</dt> <dd> -height of the rectangle (float) +height of the rectangle </dd> </dl> <div align="right"><a href="#top">Up</a></div> @@ -463,9 +493,9 @@ </p> <dl> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -package name (string) +package name </dd> </dl> <a NAME="UMLModel.getName" ID="UMLModel.getName"></a> @@ -478,7 +508,13 @@ <dl> <dt>Return:</dt> <dd> -model name (string) +model name +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/eric6/Documentation/Source/eric6.Graphics.UMLSceneSizeDialog.html Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Source/eric6.Graphics.UMLSceneSizeDialog.html Tue May 04 20:03:40 2021 +0200 @@ -92,29 +92,29 @@ </p> <dl> -<dt><i>w</i></dt> +<dt><i>w</i> (int)</dt> <dd> -current width of scene (integer) +current width of scene </dd> -<dt><i>h</i></dt> +<dt><i>h</i> (int)</dt> <dd> -current height of scene (integer) +current height of scene </dd> -<dt><i>minW</i></dt> +<dt><i>minW</i> (int)</dt> <dd> -minimum width allowed (integer) +minimum width allowed </dd> -<dt><i>minH</i></dt> +<dt><i>minH</i> (int)</dt> <dd> -minimum height allowed (integer) +minimum height allowed </dd> -<dt><i>parent</i></dt> +<dt><i>parent</i> (QWidget)</dt> <dd> -parent widget of this dialog (QWidget) +parent widget of this dialog </dd> -<dt><i>name</i></dt> +<dt><i>name</i> (str)</dt> <dd> -name of this widget (string) +name of this widget </dd> </dl> <a NAME="UMLSceneSizeDialog.getData" ID="UMLSceneSizeDialog.getData"></a> @@ -128,7 +128,12 @@ <dt>Return:</dt> <dd> tuple giving the selected width and height - (integer, integer) +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (int, int) </dd> </dl> <div align="right"><a href="#top">Up</a></div>
--- a/eric6/Documentation/Source/index-eric6.Graphics.html Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Documentation/Source/index-eric6.Graphics.html Tue May 04 20:03:40 2021 +0200 @@ -58,7 +58,7 @@ </tr> <tr> <td><a href="eric6.Graphics.PackageDiagramBuilder.html">PackageDiagramBuilder</a></td> -<td>Module implementing a dialog showing a UML like class diagram of a package.</td> +<td>Module implementing a dialog showing an UML like class diagram of a package.</td> </tr> <tr> <td><a href="eric6.Graphics.PackageItem.html">PackageItem</a></td>
--- a/eric6/Graphics/ModuleItem.py Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Graphics/ModuleItem.py Tue May 04 20:03:40 2021 +0200 @@ -21,8 +21,10 @@ """ Constructor - @param name the module name (string) - @param classlist list of class names (list of strings) + @param name the module name + @type str + @param classlist list of class names + @type list of str """ super().__init__(name) @@ -32,7 +34,8 @@ """ Public method to add a class to the module model. - @param classname class name to be added (string) + @param classname class name to be added + @type str """ self.classlist.append(classname) @@ -40,7 +43,8 @@ """ Public method to retrieve the classes of the module. - @return list of class names (list of strings) + @return list of class names + @rtype list of str """ return self.classlist[:] @@ -124,7 +128,8 @@ """ Public method to set the module model. - @param model module model containing the module data (ModuleModel) + @param model module model containing the module data + @type ModuleModel """ self.scene().removeItem(self.header) self.header = None @@ -139,9 +144,12 @@ """ Public method to paint the item in local coordinates. - @param painter reference to the painter object (QPainter) - @param option style options (QStyleOptionGraphicsItem) - @param widget optional reference to the widget painted on (QWidget) + @param painter reference to the painter object + @type QPainter + @param option style options + @type QStyleOptionGraphicsItem + @param widget optional reference to the widget painted on + @type QWidget """ pen = self.pen() if ( @@ -175,7 +183,8 @@ "attribute=value" with pairs separated by ", ". value must not contain ", " or newlines. - @return persistence data (string) + @return persistence data + @rtype str """ entries = [ "name={0}".format(self.model.getName()), @@ -190,9 +199,12 @@ """ Public method to parse the given persistence data. - @param version version of the data (string) - @param data persisted data to be parsed (string) - @return flag indicating success (boolean) + @param version version of the data + @type str + @param data persisted data to be parsed + @type str + @return flag indicating success + @rtype bool """ parts = data.split(", ") if len(parts) < 1:
--- a/eric6/Graphics/PackageDiagramBuilder.py Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Graphics/PackageDiagramBuilder.py Tue May 04 20:03:40 2021 +0200 @@ -4,7 +4,7 @@ # """ -Module implementing a dialog showing a UML like class diagram of a package. +Module implementing a dialog showing an UML like class diagram of a package. """ import glob @@ -29,12 +29,16 @@ """ Constructor - @param dialog reference to the UML dialog (UMLDialog) - @param view reference to the view object (UMLGraphicsView) - @param project reference to the project object (Project) - @param package name of a python package to be shown (string) + @param dialog reference to the UML dialog + @type UMLDialog + @param view reference to the view object + @type UMLGraphicsView + @param project reference to the project object + @type Project + @param package name of a python package to be shown + @type str @param noAttrs flag indicating, that no attributes should be shown - (boolean) + @type bool """ super().__init__(dialog, view, project) self.setObjectName("PackageDiagram") @@ -59,8 +63,10 @@ """ Private method to get the named shape. - @param name name of the shape (string) - @return shape (QCanvasItem) + @param name name of the shape + @type str + @return shape + @rtype QCanvasItem """ return self.allClasses.get(name) @@ -69,7 +75,8 @@ Private method to build a dictionary of modules contained in the package. - @return dictionary of modules contained in the package. + @return dictionary of modules contained in the package + @rtype dict """ import Utilities.ModuleParser @@ -121,6 +128,7 @@ package. @return dictionary of sub-packages contained in this package + @rtype dict """ import Utilities.ModuleParser @@ -298,9 +306,12 @@ The algorithm is borrowed from Boa Constructor. @param nodes list of nodes to arrange + @type list of str @param routes list of routes + @type list of tuple of (str, str) @param whiteSpaceFactor factor to increase whitespace between - items (float) + items + @type float """ from . import GraphicsUtilities generations = GraphicsUtilities.sort(nodes, routes) @@ -371,11 +382,16 @@ """ Private method to add a class defined in the module. - @param className name of the class to be as a dictionary key (string) - @param _class class to be shown (ModuleParser.Class) - @param x x-coordinate (float) - @param y y-coordinate (float) - @param isRbModule flag indicating a Ruby module (boolean) + @param className name of the class to be as a dictionary key + @type str + @param _class class to be shown + @type ModuleParser.Class + @param x x-coordinate + @type float + @param y y-coordinate + @type float + @param isRbModule flag indicating a Ruby module + @type bool """ from .ClassItem import ClassItem, ClassModel name = _class.name @@ -399,9 +415,12 @@ If the canvas is too small to take the shape, it is enlarged. - @param _class class to be shown (string) - @param x x-coordinate (float) - @param y y-coordinate (float) + @param _class class to be shown + @type ModuleParser.Class + @param x x-coordinate + @type float + @param y y-coordinate + @type float """ from .ClassItem import ClassItem, ClassModel cl = ClassModel(_class) @@ -414,11 +433,14 @@ """ Private method to add a package to the diagram. - @param name package name to be shown (string) + @param name package name to be shown + @type str @param modules list of module names contained in the package - (list of strings) - @param x x-coordinate (float) - @param y y-coordinate (float) + @type list of str + @param x x-coordinate + @type float + @param y y-coordinate + @type float """ from .PackageItem import PackageItem, PackageModel pm = PackageModel(name, modules) @@ -432,6 +454,7 @@ Private method to generate the associations between the class shapes. @param routes list of relationsships + @type list of tuple of (str, str) """ from .AssociationItem import AssociationItem, AssociationType for route in routes: @@ -448,7 +471,8 @@ """ Public method to get a string for data to be persisted. - @return persisted data string (string) + @return persisted data string + @rtype str """ return "package={0}, no_attributes={1}".format( self.package, self.noAttrs) @@ -457,9 +481,12 @@ """ Public method to parse persisted data. - @param version version of the data (string) - @param data persisted data to be parsed (string) - @return flag indicating success (boolean) + @param version version of the data + @type str + @param data persisted data to be parsed + @type str + @return flag indicating success + @rtype bool """ parts = data.split(", ") if (
--- a/eric6/Graphics/PackageItem.py Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Graphics/PackageItem.py Tue May 04 20:03:40 2021 +0200 @@ -23,8 +23,10 @@ """ Constructor - @param name package name (string) - @param moduleslist list of module names (list of strings) + @param name package name + @type str + @param moduleslist list of module names + @type list of str """ super().__init__(name) @@ -34,7 +36,8 @@ """ Public method to add a module to the package model. - @param modulename module name to be added (string) + @param modulename module name to be added + @type str """ self.moduleslist.append(modulename) @@ -42,7 +45,8 @@ """ Public method to retrieve the modules of the package. - @return list of module names (list of strings) + @return list of module names + @rtype list of str """ return self.moduleslist[:] @@ -147,7 +151,8 @@ """ Public method to set the package model. - @param model package model containing the package data (PackageModel) + @param model package model containing the package data + @type PackageModel """ self.scene().removeItem(self.header) self.header = None @@ -162,9 +167,12 @@ """ Public method to paint the item in local coordinates. - @param painter reference to the painter object (QPainter) - @param option style options (QStyleOptionGraphicsItem) - @param widget optional reference to the widget painted on (QWidget) + @param painter reference to the painter object + @type QPainter + @param option style options + @type QStyleOptionGraphicsItem + @param widget optional reference to the widget painted on + @type QWidget """ pen = self.pen() if ( @@ -201,7 +209,8 @@ "attribute=value" with pairs separated by ", ". value must not contain ", " or newlines. - @return persistence data (string) + @return persistence data + @rtype str """ entries = [ "no_modules={0}".format(self.noModules), @@ -217,9 +226,12 @@ """ Public method to parse the given persistence data. - @param version version of the data (string) - @param data persisted data to be parsed (string) - @return flag indicating success (boolean) + @param version version of the data + @type str + @param data persisted data to be parsed + @type str + @return flag indicating success + @rtype bool """ parts = data.split(", ") if len(parts) < 2:
--- a/eric6/Graphics/PixmapDiagram.py Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Graphics/PixmapDiagram.py Tue May 04 20:03:40 2021 +0200 @@ -40,9 +40,12 @@ """ Constructor - @param pixmap filename of a graphics file to show (string) - @param parent parent widget of the view (QWidget) - @param name name of the view widget (string) + @param pixmap filename of a graphics file to show + @type str + @param parent parent widget of the view + @type QWidget + @param name name of the view widget + @type str """ super().__init__(parent) if name: @@ -122,7 +125,8 @@ """ Private slot to show the context menu of the listview. - @param coord the position of the mouse pointer (QPoint) + @param coord the position of the mouse pointer + @type QPoint """ self.__menu.popup(self.mapToGlobal(coord)) @@ -146,8 +150,10 @@ """ Private method to show a file. - @param filename name of the file to be shown (string) - @return flag indicating success (boolean) + @param filename name of the file to be shown + @type str + @return flag indicating success + @rtype bool """ image = QImage(filename) if image.isNull(): @@ -168,6 +174,7 @@ Public method to retrieve a name for the diagram. @return name for the diagram + @rtype str """ return self.pixmapfile @@ -175,7 +182,8 @@ """ Public method to retrieve the status of the canvas. - @return flag indicating a successful pixmap loading (boolean) + @return flag indicating a successful pixmap loading + @rtype bool """ return self.status @@ -183,7 +191,8 @@ """ Protected method to handle wheel events. - @param evt reference to the wheel event (QWheelEvent) + @param evt reference to the wheel event + @type QWheelEvent """ if evt.modifiers() & Qt.KeyboardModifier.ControlModifier: delta = evt.angleDelta().y() @@ -200,8 +209,10 @@ """ Public method handling events. - @param evt reference to the event (QEvent) - @return flag indicating, if the event was handled (boolean) + @param evt reference to the event + @type QEvent + @return flag indicating, if the event was handled + @rtype bool """ if evt.type() == QEvent.Type.Gesture: self.gestureEvent(evt) @@ -213,7 +224,8 @@ """ Protected method handling gesture events. - @param evt reference to the gesture event (QGestureEvent + @param evt reference to the gesture event + @type QGestureEvent """ pinch = evt.gesture(Qt.GestureType.PinchGesture) if pinch: @@ -231,8 +243,10 @@ """ Private method to adjust a scrollbar by a certain factor. - @param scrollBar reference to the scrollbar object (QScrollBar) - @param factor factor to adjust by (float) + @param scrollBar reference to the scrollbar object + @type QScrollBar + @param factor factor to adjust by + @type float """ scrollBar.setValue(int(factor * scrollBar.value() + ((factor - 1) * scrollBar.pageStep() / 2))) @@ -241,8 +255,10 @@ """ Private method determining the zoom level index given a zoom factor. - @param zoom zoom factor (integer) - @return index of zoom factor (integer) + @param zoom zoom factor + @type int + @return index of zoom factor + @rtype int """ try: index = PixmapDiagram.ZoomLevels.index(zoom) @@ -256,7 +272,8 @@ """ Private method to set the zoom value in percent. - @param value zoom value in percent (integer) + @param value zoom value in percent + @type int """ oldValue = self.__zoom() if value != oldValue: @@ -297,7 +314,8 @@ """ Private method to get the current zoom factor in percent. - @return current zoom factor in percent (integer) + @return current zoom factor in percent + @rtype int """ return int(self.pixmapLabel.width() / self.pixmapLabel.pixmap().width() * 100.0) @@ -355,7 +373,8 @@ """ Private slot to the actual printing. - @param printer reference to the printer object (QPrinter) + @param printer reference to the printer object + @type QPrinter """ painter = QPainter() painter.begin(printer)
--- a/eric6/Graphics/SvgDiagram.py Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Graphics/SvgDiagram.py Tue May 04 20:03:40 2021 +0200 @@ -38,9 +38,12 @@ """ Constructor - @param svgFile filename of a SVG graphics file to show (string) - @param parent parent widget of the view (QWidget) - @param name name of the view widget (string) + @param svgFile filename of a SVG graphics file to show + @type str + @param parent parent widget of the view + @type QWidget + @param name name of the view widget + @type str """ super().__init__(parent) if name: @@ -121,7 +124,8 @@ """ Private slot to show the context menu of the listview. - @param coord the position of the mouse pointer (QPoint) + @param coord the position of the mouse pointer + @type QPoint """ self.__menu.popup(self.mapToGlobal(coord)) @@ -146,6 +150,7 @@ Public method to retrieve a name for the diagram. @return name for the diagram + @rtype str """ return self.svgFile @@ -153,7 +158,8 @@ """ Protected method to handle wheel events. - @param evt reference to the wheel event (QWheelEvent) + @param evt reference to the wheel event + @type QWheelEvent """ if evt.modifiers() & Qt.KeyboardModifier.ControlModifier: delta = evt.angleDelta().y() @@ -170,8 +176,10 @@ """ Public method handling events. - @param evt reference to the event (QEvent) - @return flag indicating, if the event was handled (boolean) + @param evt reference to the event + @type QEvent + @return flag indicating, if the event was handled + @rtype bool """ if evt.type() == QEvent.Type.Gesture: self.gestureEvent(evt) @@ -183,7 +191,8 @@ """ Protected method handling gesture events. - @param evt reference to the gesture event (QGestureEvent + @param evt reference to the gesture event + @type QGestureEvent """ pinch = evt.gesture(Qt.GestureType.PinchGesture) if pinch: @@ -201,8 +210,10 @@ """ Private method to adjust a scrollbar by a certain factor. - @param scrollBar reference to the scrollbar object (QScrollBar) - @param factor factor to adjust by (float) + @param scrollBar reference to the scrollbar object + @type QScrollBar + @param factor factor to adjust by + @type float """ scrollBar.setValue( int(factor * scrollBar.value() + @@ -212,8 +223,10 @@ """ Private method determining the zoom level index given a zoom factor. - @param zoom zoom factor (integer) - @return index of zoom factor (integer) + @param zoom zoom factor + @type int + @return index of zoom factor + @rtype int """ try: index = SvgDiagram.ZoomLevels.index(zoom) @@ -227,7 +240,8 @@ """ Private method to set the zoom value in percent. - @param value zoom value in percent (integer) + @param value zoom value in percent + @type int """ oldValue = self.__zoom() if value != oldValue: @@ -265,7 +279,8 @@ """ Private method to get the current zoom factor in percent. - @return current zoom factor in percent (integer) + @return current zoom factor in percent + @rtype int """ return int(self.svgWidget.width() / self.svgWidget.sizeHint().width() * 100.0) @@ -327,7 +342,8 @@ """ Private slot to the actual printing. - @param printer reference to the printer object (QPrinter) + @param printer reference to the printer object + @type QPrinter """ painter = QPainter() painter.begin(printer)
--- a/eric6/Graphics/UMLClassDiagramBuilder.py Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Graphics/UMLClassDiagramBuilder.py Tue May 04 20:03:40 2021 +0200 @@ -25,12 +25,16 @@ """ Constructor - @param dialog reference to the UML dialog (UMLDialog) - @param view reference to the view object (UMLGraphicsView) - @param project reference to the project object (Project) - @param file file name of a python module to be shown (string) + @param dialog reference to the UML dialog + @type UMLDialog + @param view reference to the view object + @type UMLGraphicsView + @param project reference to the project object + @type Project + @param file file name of a python module to be shown + @type str @param noAttrs flag indicating, that no attributes should be shown - (boolean) + @type bool """ super().__init__(dialog, view, project) self.setObjectName("UMLClassDiagramBuilder") @@ -55,8 +59,10 @@ """ Private method to get the named shape. - @param name name of the shape (string) - @return shape (QGraphicsItem) + @param name name of the shape + @type str + @return shape + @rtype QGraphicsItem """ return self.allClasses.get(name) @@ -154,9 +160,12 @@ The algorithm is borrowed from Boa Constructor. @param nodes list of nodes to arrange + @type list of str @param routes list of routes + @type list of tuple of (str, str) @param whiteSpaceFactor factor to increase whitespace between - items (float) + items + @type float """ from . import GraphicsUtilities generations = GraphicsUtilities.sort(nodes, routes) @@ -227,11 +236,16 @@ """ Private method to add a class defined in the module. - @param className name of the class to be as a dictionary key (string) - @param _class class to be shown (ModuleParser.Class) - @param x x-coordinate (float) - @param y y-coordinate (float) - @param isRbModule flag indicating a Ruby module (boolean) + @param className name of the class to be as a dictionary key + @type str + @param _class class to be shown + @type ModuleParser.Class + @param x x-coordinate + @type float + @param y y-coordinate + @type float + @param isRbModule flag indicating a Ruby module + @type bool """ from .ClassItem import ClassItem, ClassModel name = _class.name @@ -257,9 +271,12 @@ If the canvas is too small to take the shape, it is enlarged. - @param _class class to be shown (string) - @param x x-coordinate (float) - @param y y-coordinate (float) + @param _class class to be shown + @type ModuleParser.Class + @param x x-coordinate + @type float + @param y y-coordinate + @type float """ from .ClassItem import ClassItem, ClassModel cl = ClassModel(_class) @@ -275,6 +292,7 @@ Private method to generate the associations between the class shapes. @param routes list of relationsships + @type list of tuple of (str, str) """ from .AssociationItem import AssociationItem, AssociationType for route in routes: @@ -291,7 +309,8 @@ """ Public method to get a string for data to be persisted. - @return persisted data string (string) + @return persisted data string + @rtype str """ return "file={0}, no_attributes={1}".format(self.file, self.noAttrs) @@ -299,9 +318,12 @@ """ Public method to parse persisted data. - @param version version of the data (string) - @param data persisted data to be parsed (string) - @return flag indicating success (boolean) + @param version version of the data + @type str + @param data persisted data to be parsed + @type str + @return flag indicating success + @rtype bool """ parts = data.split(", ") if (
--- a/eric6/Graphics/UMLDiagramBuilder.py Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Graphics/UMLDiagramBuilder.py Tue May 04 20:03:40 2021 +0200 @@ -18,9 +18,12 @@ """ Constructor - @param dialog reference to the UML dialog (UMLDialog) - @param view reference to the view object (UMLGraphicsView) - @param project reference to the project object (Project) + @param dialog reference to the UML dialog + @type UMLDialog + @param view reference to the view object + @type UMLGraphicsView + @param project reference to the project object + @type Project """ super().__init__(dialog) @@ -50,7 +53,8 @@ """ Public method to get a string for data to be persisted. - @return persisted data string (string) + @return persisted data string + @rtype str """ return "" @@ -58,8 +62,11 @@ """ Public method to parse persisted data. - @param version version of the data (string) - @param data persisted data to be parsed (string) - @return flag indicating success (boolean) + @param version version of the data + @type str + @param data persisted data to be parsed + @type str + @return flag indicating success + @rtype bool """ return True
--- a/eric6/Graphics/UMLDialog.py Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Graphics/UMLDialog.py Tue May 04 20:03:40 2021 +0200 @@ -156,7 +156,8 @@ Public method to show the dialog. @param fromFile flag indicating, that the diagram was loaded - from file (boolean) + from file + @type bool """ if not fromFile and self.builder: self.builder.buildDiagram() @@ -164,7 +165,7 @@ def __relayout(self): """ - Private method to relayout the diagram. + Private method to re-layout the diagram. """ if self.builder: self.builder.buildDiagram() @@ -213,7 +214,8 @@ """ Private slot to save the diagram. - @param filename name of the file to write to (string) + @param filename name of the file to write to + @type str """ if not filename: fname, selectedFilter = E5FileDialog.getSaveFileNameAndFilter( @@ -285,7 +287,7 @@ "", self.tr("Eric Graphics File (*.e5g);;All Files (*)")) if not filename: - # Cancelled by user + # Canceled by user return False try: @@ -380,8 +382,10 @@ """ Private slot to show a message dialog indicating an invalid data file. - @param filename name of the file containing the invalid data (string) - @param linenum number of the invalid line (integer) + @param filename name of the file containing the invalid data + @type str + @param linenum number of the invalid line + @type int """ msg = ( self.tr("""<p>The file <b>{0}</b> does not contain"""
--- a/eric6/Graphics/UMLGraphicsView.py Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Graphics/UMLGraphicsView.py Tue May 04 20:03:40 2021 +0200 @@ -39,8 +39,10 @@ """ Constructor - @param scene reference to the scene object (QGraphicsScene) - @param parent parent widget of the view (QWidget) + @param scene reference to the scene object + @type QGraphicsScene + @param parent parent widget of the view + @type QWidget """ E5GraphicsView.__init__(self, scene, parent) self.setObjectName("UMLGraphicsView") @@ -189,7 +191,8 @@ """ Private slot called when the scene changes. - @param areas list of rectangles that contain changes (list of QRectF) + @param areas list of rectangles that contain changes + @type list of QRectF """ if len(self.scene().selectedItems()) > 0: self.deleteShapeAct.setEnabled(True) @@ -214,7 +217,8 @@ """ Public method to populate a toolbar with our actions. - @return the populated toolBar (QToolBar) + @return the populated toolBar + @rtype QToolBar """ toolBar = QToolBar(self.tr("Graphics"), self) toolBar.setIconSize(UI.Config.ToolBarIconSize) @@ -243,9 +247,11 @@ Public method to filter a list of items. @param items list of items as returned by the scene object - (QGraphicsItem) - @param itemType type to be filtered (class) - @return list of interesting collision items (QGraphicsItem) + @type QGraphicsItem + @param itemType type to be filtered + @type class + @return list of interesting collision items + @rtype QGraphicsItem """ return [itm for itm in items if isinstance(itm, itemType)] @@ -253,7 +259,8 @@ """ Public method to select the given items. - @param items list of items to be selected (list of QGraphicsItemItem) + @param items list of items to be selected + @type list of QGraphicsItemItem """ # step 1: deselect all items self.unselectItems() @@ -267,7 +274,8 @@ """ Public method to select an item. - @param item item to be selected (QGraphicsItemItem) + @param item item to be selected + @type QGraphicsItemItem """ if isinstance(item, UMLItem): item.setSelected(not item.isSelected()) @@ -329,7 +337,8 @@ Public method to adjust the scene size to the diagram size. @param limit flag indicating to limit the scene to the - initial size (boolean) + initial size + @type bool """ super().autoAdjustSceneSize(limit=limit) self.__checkSizeActions() @@ -472,7 +481,8 @@ """ Private slot to generate a print preview. - @param printer reference to the printer object (QPrinter) + @param printer reference to the printer object + @type QPrinter """ super().printDiagram(printer, self.diagramName) @@ -480,7 +490,8 @@ """ Public slot to set the diagram name. - @param name diagram name (string) + @param name diagram name + @type str """ self.diagramName = name @@ -488,7 +499,8 @@ """ Private slot to align the selected shapes. - @param alignment alignment type (Qt.AlignmentFlag) + @param alignment alignment type + @type Qt.AlignmentFlag """ # step 1: get all selected items items = self.scene().selectedItems() @@ -564,8 +576,10 @@ """ Private method to calculate the bounding rectangle of the given items. - @param items list of items to operate on (list of UMLItem) - @return bounding rectangle (QRectF) + @param items list of items to operate on + @type list of UMLItem + @return bounding rectangle + @rtype QRectF """ rect = self.scene().sceneRect() right = rect.left() @@ -584,7 +598,8 @@ """ Protected method handling key press events. - @param evt reference to the key event (QKeyEvent) + @param evt reference to the key event + @type QKeyEvent """ key = evt.key() if key in [Qt.Key.Key_Up, Qt.Key.Key_Down, Qt.Key.Key_Left, @@ -618,7 +633,8 @@ """ Protected method to handle wheel events. - @param evt reference to the wheel event (QWheelEvent) + @param evt reference to the wheel event + @type QWheelEvent """ if evt.modifiers() & Qt.KeyboardModifier.ControlModifier: delta = evt.angleDelta().y() @@ -635,8 +651,10 @@ """ Public method handling events. - @param evt reference to the event (QEvent) - @return flag indicating, if the event was handled (boolean) + @param evt reference to the event + @type QEvent + @return flag indicating, if the event was handled + @rtype bool """ if evt.type() == QEvent.Type.Gesture: self.gestureEvent(evt) @@ -648,7 +666,8 @@ """ Protected method handling gesture events. - @param evt reference to the gesture event (QGestureEvent + @param evt reference to the gesture event + @type QGestureEvent """ pinch = evt.gesture(Qt.GestureType.PinchGesture) if pinch: @@ -662,7 +681,8 @@ """ Public method to get the ID to be assigned to an item. - @return item ID (integer) + @return item ID + @rtype int """ self.__itemId += 1 return self.__itemId @@ -671,8 +691,10 @@ """ Public method to find an UML item based on the ID. - @param itemId of the item to search for (integer) - @return item found (UMLItem) or None + @param itemId of the item to search for + @type int + @return item found or None + @rtype UMLItem """ for item in self.scene().items(): try: @@ -687,8 +709,10 @@ """ Public method to find an UML item based on its name. - @param name name to look for (string) - @return item found (UMLItem) or None + @param name name to look for + @type str + @return item found or None + @rtype UMLItem """ for item in self.scene().items(): try: @@ -703,7 +727,8 @@ """ Public method to get a list of data to be persisted. - @return list of data to be persisted (list of strings) + @return list of data to be persisted + @rtype list of str """ lines = [ "diagram_name: {0}".format(self.diagramName), @@ -725,10 +750,13 @@ """ Public method to parse persisted data. - @param version version of the data (string) - @param data persisted data to be parsed (list of string) + @param version version of the data + @type str + @param data persisted data to be parsed + @type list of str @return tuple of flag indicating success (boolean) and faulty line - number (integer) + number + @rtype int """ umlItems = {}
--- a/eric6/Graphics/UMLItem.py Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Graphics/UMLItem.py Tue May 04 20:03:40 2021 +0200 @@ -22,7 +22,8 @@ """ Constructor - @param name package name (string) + @param name package name + @type str """ self.name = name @@ -30,7 +31,8 @@ """ Public method to retrieve the model name. - @return model name (string) + @return model name + @rtype str """ return self.name @@ -91,7 +93,8 @@ """ Public method to retrieve the item name. - @return item name (string) + @return item name + @rtype str """ if self.model: return self.model.name @@ -102,8 +105,10 @@ """ Public method to set the rectangles size. - @param width width of the rectangle (float) - @param height height of the rectangle (float) + @param width width of the rectangle + @type float + @param height height of the rectangle + @type float """ rect = self.rect() rect.setSize(QSizeF(width, height)) @@ -113,7 +118,8 @@ """ Public method to add an association to this widget. - @param assoc association to be added (AssociationWidget) + @param assoc association to be added + @type AssociationWidget """ if assoc and assoc not in self.associations: self.associations.append(assoc) @@ -122,7 +128,8 @@ """ Public method to remove an association to this widget. - @param assoc association to be removed (AssociationWidget) + @param assoc association to be removed + @type AssociationWidget """ if assoc and assoc in self.associations: self.associations.remove(assoc) @@ -149,8 +156,10 @@ """ Public overriden method to move the widget relative. - @param dx relative movement in x-direction (float) - @param dy relative movement in y-direction (float) + @param dx relative movement in x-direction + @type float + @param dy relative movement in y-direction + @type float """ super().moveBy(dx, dy) self.adjustAssociations() @@ -159,8 +168,10 @@ """ Public overriden method to set the items position. - @param x absolute x-position (float) - @param y absolute y-position (float) + @param x absolute x-position + @type float + @param y absolute y-position + @type float """ super().setPos(x, y) self.adjustAssociations() @@ -169,7 +180,8 @@ """ Public method called when an items state changes. - @param change the item's change (QGraphicsItem.GraphicsItemChange) + @param change the item's change + @type QGraphicsItem.GraphicsItemChange @param value the value of the change @return adjusted values """ @@ -191,9 +203,12 @@ """ Public method to paint the item in local coordinates. - @param painter reference to the painter object (QPainter) - @param option style options (QStyleOptionGraphicsItem) - @param widget optional reference to the widget painted on (QWidget) + @param painter reference to the painter object + @type QPainter + @param option style options + @type QStyleOptionGraphicsItem + @param widget optional reference to the widget painted on + @type QWidget """ pen = self.pen() if ( @@ -213,7 +228,8 @@ """ Public method to assign an ID to the item. - @param itemId assigned ID (integer) + @param itemId assigned ID + @type int """ self.__id = itemId @@ -221,7 +237,8 @@ """ Public method to get the item ID. - @return ID of the item (integer) + @return ID of the item + @rtype int """ return self.__id @@ -229,7 +246,8 @@ """ Public method to get the item's type. - @return item type (string) + @return item type + @rtype str """ return self.ItemType @@ -241,7 +259,8 @@ "attribute=value" with pairs separated by ", ". value must not contain ", " or newlines. - @return persistence data (string) + @return persistence data + @rtype str """ return "" @@ -249,8 +268,11 @@ """ Public method to parse the given persistence data. - @param version version of the data (string) - @param data persisted data to be parsed (string) - @return flag indicating success (boolean) + @param version version of the data + @type str + @param data persisted data to be parsed + @type str + @return flag indicating success + @rtype bool """ return True
--- a/eric6/Graphics/UMLSceneSizeDialog.py Tue May 04 19:30:25 2021 +0200 +++ b/eric6/Graphics/UMLSceneSizeDialog.py Tue May 04 20:03:40 2021 +0200 @@ -20,12 +20,18 @@ """ Constructor - @param w current width of scene (integer) - @param h current height of scene (integer) - @param minW minimum width allowed (integer) - @param minH minimum height allowed (integer) - @param parent parent widget of this dialog (QWidget) - @param name name of this widget (string) + @param w current width of scene + @type int + @param h current height of scene + @type int + @param minW minimum width allowed + @type int + @param minH minimum height allowed + @type int + @param parent parent widget of this dialog + @type QWidget + @param name name of this widget + @type str """ super().__init__(parent) if name: @@ -47,6 +53,6 @@ Public method to retrieve the entered data. @return tuple giving the selected width and height - (integer, integer) + @rtype tuple of (int, int) """ return (self.widthSpinBox.value(), self.heightSpinBox.value())
