Regenerated the source docu.

Sun, 05 Apr 2020 12:00:11 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sun, 05 Apr 2020 12:00:11 +0200
changeset 7502
426f64d419f0
parent 7501
802fca9bb6ed
child 7503
b17672e6812d
child 7505
7d3cfeeb5f4f

Regenerated the source docu.

eric6/APIs/Python3/eric6.api file | annotate | diff | comparison | revisions
eric6/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
eric6/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.E5Gui.E5Application.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgServeDialog.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.Toolbox.Startup.html file | annotate | diff | comparison | revisions
eric6/E5Gui/E5Application.py file | annotate | diff | comparison | revisions
eric6/Plugins/VcsPlugins/vcsMercurial/HgServeDialog.py file | annotate | diff | comparison | revisions
--- a/eric6/APIs/Python3/eric6.api	Sun Apr 05 11:54:41 2020 +0200
+++ b/eric6/APIs/Python3/eric6.api	Sun Apr 05 12:00:11 2020 +0200
@@ -966,6 +966,7 @@
 eric6.E5Gui.E5Application.E5Application.registerObject?4(name, objectRef)
 eric6.E5Gui.E5Application.E5Application.registerPluginObject?4(name, objectRef, pluginType=None)
 eric6.E5Gui.E5Application.E5Application.unregisterPluginObject?4(name)
+eric6.E5Gui.E5Application.E5Application.usesDarkPalette?4()
 eric6.E5Gui.E5Application.E5Application?1(argv)
 eric6.E5Gui.E5Application.e5App?7
 eric6.E5Gui.E5ClickableLabel.E5ClickableLabel.clicked?7
Binary file eric6/Documentation/Help/source.qch has changed
--- a/eric6/Documentation/Help/source.qhp	Sun Apr 05 11:54:41 2020 +0200
+++ b/eric6/Documentation/Help/source.qhp	Sun Apr 05 12:00:11 2020 +0200
@@ -3795,6 +3795,7 @@
       <keyword name="E5Application.registerObject" id="E5Application.registerObject" ref="eric6.E5Gui.E5Application.html#E5Application.registerObject" />
       <keyword name="E5Application.registerPluginObject" id="E5Application.registerPluginObject" ref="eric6.E5Gui.E5Application.html#E5Application.registerPluginObject" />
       <keyword name="E5Application.unregisterPluginObject" id="E5Application.unregisterPluginObject" ref="eric6.E5Gui.E5Application.html#E5Application.unregisterPluginObject" />
+      <keyword name="E5Application.usesDarkPalette" id="E5Application.usesDarkPalette" ref="eric6.E5Gui.E5Application.html#E5Application.usesDarkPalette" />
       <keyword name="E5ArrowItem" id="E5ArrowItem" ref="eric6.E5Graphics.E5ArrowItem.html#E5ArrowItem" />
       <keyword name="E5ArrowItem (Constructor)" id="E5ArrowItem (Constructor)" ref="eric6.E5Graphics.E5ArrowItem.html#E5ArrowItem.__init__" />
       <keyword name="E5ArrowItem (Module)" id="E5ArrowItem (Module)" ref="eric6.E5Graphics.E5ArrowItem.html" />
--- a/eric6/Documentation/Source/eric6.E5Gui.E5Application.html	Sun Apr 05 11:54:41 2020 +0200
+++ b/eric6/Documentation/Source/eric6.E5Gui.E5Application.html	Sun Apr 05 12:00:11 2020 +0200
@@ -100,6 +100,10 @@
 <td><a href="#E5Application.unregisterPluginObject">unregisterPluginObject</a></td>
 <td>Public method to unregister a plugin object in the object registry.</td>
 </tr>
+<tr>
+<td><a href="#E5Application.usesDarkPalette">usesDarkPalette</a></td>
+<td>Public method to check, if the application uses a palette with a dark background.</td>
+</tr>
 </table>
 <h3>Static Methods</h3>
 
@@ -116,7 +120,7 @@
 </p>
 <dl>
 
-<dt><i>argv</i></dt>
+<dt><i>argv</i> (list)</dt>
 <dd>
 command line arguments
 </dd>
@@ -130,9 +134,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the object (string)
+name of the object
 </dd>
 </dl>
 <dl>
@@ -142,6 +146,12 @@
 </dd>
 </dl>
 <dl>
+<dt>Return Type:</dt>
+<dd>
+any
+</dd>
+</dl>
+<dl>
 
 <dt>Raises <b>KeyError</b>:</dt>
 <dd>
@@ -157,9 +167,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the plugin object (string)
+name of the plugin object
 </dd>
 </dl>
 <dl>
@@ -169,6 +179,12 @@
 </dd>
 </dl>
 <dl>
+<dt>Return Type:</dt>
+<dd>
+any
+</dd>
+</dl>
+<dl>
 
 <dt>Raises <b>KeyError</b>:</dt>
 <dd>
@@ -184,15 +200,21 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the plugin object (string)
+name of the plugin object
 </dd>
 </dl>
 <dl>
 <dt>Returns:</dt>
 <dd>
-type of the plugin object (string)
+type of the plugin object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <dl>
@@ -216,6 +238,12 @@
 list of (name, reference) pairs
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of (str, any)
+</dd>
+</dl>
 <a NAME="E5Application.registerObject" ID="E5Application.registerObject"></a>
 <h4>E5Application.registerObject</h4>
 <b>registerObject</b>(<i>name, objectRef</i>)
@@ -225,11 +253,11 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the object (string)
+name of the object
 </dd>
-<dt><i>objectRef</i></dt>
+<dt><i>objectRef</i> (any)</dt>
 <dd>
 reference to the object
 </dd>
@@ -250,17 +278,17 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the plugin object (string)
+name of the plugin object
 </dd>
-<dt><i>objectRef</i></dt>
+<dt><i>objectRef</i> (any)</dt>
 <dd>
 reference to the plugin object
 </dd>
-<dt><i>pluginType=</i></dt>
+<dt><i>pluginType</i> (str)</dt>
 <dd>
-type of the plugin object (string)
+type of the plugin object
 </dd>
 </dl>
 <dl>
@@ -279,9 +307,29 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the plugin object (string)
+name of the plugin object
+</dd>
+</dl>
+<a NAME="E5Application.usesDarkPalette" ID="E5Application.usesDarkPalette"></a>
+<h4>E5Application.usesDarkPalette</h4>
+<b>usesDarkPalette</b>(<i></i>)
+
+<p>
+        Public method to check, if the application uses a palette with a dark
+        background.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating the use of a palette with a dark background
+</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.Plugins.VcsPlugins.vcsMercurial.HgServeDialog.html	Sun Apr 05 11:54:41 2020 +0200
+++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgServeDialog.html	Sun Apr 05 12:00:11 2020 +0200
@@ -120,17 +120,17 @@
 </p>
 <dl>
 
-<dt><i>vcs</i></dt>
+<dt><i>vcs</i> (Hg)</dt>
 <dd>
 reference to the vcs object
 </dd>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
-path of the repository to serve (string)
+path of the repository to serve
 </dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-reference to the parent widget (QWidget)
+reference to the parent widget
 </dd>
 </dl>
 <a NAME="HgServeDialog.__appendText" ID="HgServeDialog.__appendText"></a>
@@ -142,13 +142,13 @@
 </p>
 <dl>
 
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
 <dd>
-text to insert (string)
+text to insert
 </dd>
-<dt><i>error</i></dt>
+<dt><i>error</i> (bool)</dt>
 <dd>
-flag indicating to insert error text (boolean)
+flag indicating to insert error text
 </dd>
 </dl>
 <a NAME="HgServeDialog.__procFinished" ID="HgServeDialog.__procFinished"></a>
@@ -160,13 +160,13 @@
 </p>
 <dl>
 
-<dt><i>exitCode</i></dt>
+<dt><i>exitCode</i> (int)</dt>
 <dd>
-exit code of the process (integer)
+exit code of the process
 </dd>
-<dt><i>exitStatus</i></dt>
+<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
 <dd>
-exit status of the process (QProcess.ExitStatus)
+exit status of the process
 </dd>
 </dl>
 <a NAME="HgServeDialog.__readStderr" ID="HgServeDialog.__readStderr"></a>
@@ -219,9 +219,9 @@
 </p>
 <dl>
 
-<dt><i>e</i></dt>
+<dt><i>e</i> (QCloseEvent)</dt>
 <dd>
-close event (QCloseEvent)
+close event
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
--- a/eric6/Documentation/Source/eric6.Toolbox.Startup.html	Sun Apr 05 11:54:41 2020 +0200
+++ b/eric6/Documentation/Source/eric6.Toolbox.Startup.html	Sun Apr 05 12:00:11 2020 +0200
@@ -112,9 +112,9 @@
 </p>
 <dl>
 
-<dt><i>application</i> (QGuiApplication)</dt>
+<dt><i>application</i> (E5Application)</dt>
 <dd>
-reference to the application objetc
+reference to the application object
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
--- a/eric6/E5Gui/E5Application.py	Sun Apr 05 11:54:41 2020 +0200
+++ b/eric6/E5Gui/E5Application.py	Sun Apr 05 12:00:11 2020 +0200
@@ -69,7 +69,7 @@
         @param name name of the object
         @type str
         @return reference to the registered object
-        @type any
+        @rtype any
         @exception KeyError raised when the given name is not known
         """
         if name in self.__objectRegistry:
--- a/eric6/Plugins/VcsPlugins/vcsMercurial/HgServeDialog.py	Sun Apr 05 11:54:41 2020 +0200
+++ b/eric6/Plugins/VcsPlugins/vcsMercurial/HgServeDialog.py	Sun Apr 05 12:00:11 2020 +0200
@@ -37,7 +37,8 @@
         @type Hg
         @param path path of the repository to serve
         @type str
-        @param parent reference to the parent widget (QWidget)
+        @param parent reference to the parent widget
+        @type QWidget
         """
         super(HgServeDialog, self).__init__(parent)
         
@@ -183,7 +184,8 @@
         """
         Protected slot implementing a close event handler.
         
-        @param e close event (QCloseEvent)
+        @param e close event
+        @type QCloseEvent
         """
         self.__stopServer()
     
@@ -191,8 +193,10 @@
         """
         Private slot connected to the finished signal.
         
-        @param exitCode exit code of the process (integer)
-        @param exitStatus exit status of the process (QProcess.ExitStatus)
+        @param exitCode exit code of the process
+        @type int
+        @param exitStatus exit status of the process
+        @type QProcess.ExitStatus
         """
         self.__stopServer()
     
@@ -222,8 +226,10 @@
         """
         Private method to append text to the end.
         
-        @param txt text to insert (string)
-        @param error flag indicating to insert error text (boolean)
+        @param txt text to insert
+        @type str
+        @param error flag indicating to insert error text
+        @type bool
         """
         tc = self.__log.textCursor()
         tc.movePosition(QTextCursor.End)

eric ide

mercurial