Updated source docu.

Tue, 31 Mar 2020 19:16:06 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Tue, 31 Mar 2020 19:16:06 +0200
changeset 7489
6543bcd150fd
parent 7488
36ec7469f492
child 7490
ebd9ae25bb1c

Updated source docu.

eric6/Documentation/Help/source.qch file | annotate | diff | comparison | revisions
eric6/Documentation/Help/source.qhp file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitLogBrowserDialog.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.Toolbox.Startup.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.UI.PixmapCache.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/install.html file | annotate | diff | comparison | revisions
eric6/Plugins/VcsPlugins/vcsGit/GitLogBrowserDialog.py file | annotate | diff | comparison | revisions
eric6/Plugins/VcsPlugins/vcsMercurial/HgLogBrowserDialog.py file | annotate | diff | comparison | revisions
Binary file eric6/Documentation/Help/source.qch has changed
--- a/eric6/Documentation/Help/source.qhp	Tue Mar 31 19:15:51 2020 +0200
+++ b/eric6/Documentation/Help/source.qhp	Tue Mar 31 19:16:06 2020 +0200
@@ -10661,6 +10661,7 @@
       <keyword name="PixmapCache (Module)" id="PixmapCache (Module)" ref="eric6.UI.PixmapCache.html" />
       <keyword name="PixmapCache.addSearchPath" id="PixmapCache.addSearchPath" ref="eric6.UI.PixmapCache.html#PixmapCache.addSearchPath" />
       <keyword name="PixmapCache.getPixmap" id="PixmapCache.getPixmap" ref="eric6.UI.PixmapCache.html#PixmapCache.getPixmap" />
+      <keyword name="PixmapCache.removeSearchPath" id="PixmapCache.removeSearchPath" ref="eric6.UI.PixmapCache.html#PixmapCache.removeSearchPath" />
       <keyword name="PixmapDiagram" id="PixmapDiagram" ref="eric6.Graphics.PixmapDiagram.html#PixmapDiagram" />
       <keyword name="PixmapDiagram (Constructor)" id="PixmapDiagram (Constructor)" ref="eric6.Graphics.PixmapDiagram.html#PixmapDiagram.__init__" />
       <keyword name="PixmapDiagram (Module)" id="PixmapDiagram (Module)" ref="eric6.Graphics.PixmapDiagram.html" />
@@ -17415,6 +17416,7 @@
       <keyword name="isNameConstant_1" id="isNameConstant_1" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AstUtilities.html#isNameConstant_1" />
       <keyword name="isNumber" id="isNumber" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AstUtilities.html#isNumber" />
       <keyword name="isNumber_1" id="isNumber_1" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AstUtilities.html#isNumber_1" />
+      <keyword name="isPipOutdated" id="isPipOutdated" ref="install.html#isPipOutdated" />
       <keyword name="isString" id="isString" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AstUtilities.html#isString" />
       <keyword name="isString_1" id="isString_1" ref="eric6.Plugins.CheckerPlugins.CodeStyleChecker.AstUtilities.html#isString_1" />
       <keyword name="isTextFile" id="isTextFile" ref="eric6.Utilities.MimeTypes.html#isTextFile" />
@@ -17599,6 +17601,7 @@
       <keyword name="removeMarkers" id="removeMarkers" ref="eric6.UI.CompareDialog.html#removeMarkers" />
       <keyword name="removePluginDirectories" id="removePluginDirectories" ref="uninstall.html#removePluginDirectories" />
       <keyword name="removeProjectBrowserFlags" id="removeProjectBrowserFlags" ref="eric6.Preferences.__init__.html#removeProjectBrowserFlags" />
+      <keyword name="removeSearchPath" id="removeSearchPath" ref="eric6.UI.PixmapCache.html#removeSearchPath" />
       <keyword name="renderTabPreview" id="renderTabPreview" ref="eric6.WebBrowser.WebBrowserSnap.html#renderTabPreview" />
       <keyword name="resetInterface" id="resetInterface" ref="eric6.CondaInterface.__init__.html#resetInterface" />
       <keyword name="resetLayout" id="resetLayout" ref="eric6.Preferences.__init__.html#resetLayout" />
--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitLogBrowserDialog.html	Tue Mar 31 19:15:51 2020 +0200
+++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsGit.GitLogBrowserDialog.html	Tue Mar 31 19:16:06 2020 +0200
@@ -28,7 +28,7 @@
 <h3>Global Attributes</h3>
 
 <table>
-<tr><td>COLORNAMES</td></tr><tr><td>COLORS</td></tr>
+<tr><td>COLORNAMES</td></tr><tr><td>COLORS</td></tr><tr><td>LIGHTCOLORS</td></tr>
 </table>
 <h3>Classes</h3>
 
@@ -786,15 +786,21 @@
 </p>
 <dl>
 
-<dt><i>n</i></dt>
+<dt><i>n</i> (int)</dt>
 <dd>
-color index (integer)
+color index
 </dd>
 </dl>
 <dl>
 <dt>Returns:</dt>
 <dd>
-color name (string)
+color name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="GitLogBrowserDialog.__getCommitForTag" ID="GitLogBrowserDialog.__getCommitForTag"></a>
--- a/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.html	Tue Mar 31 19:15:51 2020 +0200
+++ b/eric6/Documentation/Source/eric6.Plugins.VcsPlugins.vcsMercurial.HgLogBrowserDialog.html	Tue Mar 31 19:16:06 2020 +0200
@@ -28,7 +28,7 @@
 <h3>Global Attributes</h3>
 
 <table>
-<tr><td>COLORNAMES</td></tr><tr><td>COLORS</td></tr>
+<tr><td>COLORNAMES</td></tr><tr><td>COLORS</td></tr><tr><td>LIGHTCOLORS</td></tr>
 </table>
 <h3>Classes</h3>
 
@@ -750,15 +750,21 @@
 </p>
 <dl>
 
-<dt><i>n</i></dt>
+<dt><i>n</i> (int)</dt>
 <dd>
-color index (integer)
+color index
 </dd>
 </dl>
 <dl>
 <dt>Returns:</dt>
 <dd>
-color name (string)
+color name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="HgLogBrowserDialog.__getHeads" ID="HgLogBrowserDialog.__getHeads"></a>
--- a/eric6/Documentation/Source/eric6.Toolbox.Startup.html	Tue Mar 31 19:15:51 2020 +0200
+++ b/eric6/Documentation/Source/eric6.Toolbox.Startup.html	Tue Mar 31 19:16:06 2020 +0200
@@ -105,11 +105,18 @@
 <hr />
 <a NAME="initializeResourceSearchPath" ID="initializeResourceSearchPath"></a>
 <h2>initializeResourceSearchPath</h2>
-<b>initializeResourceSearchPath</b>(<i></i>)
+<b>initializeResourceSearchPath</b>(<i>application</i>)
 
 <p>
     Module function to initialize the default mime source factory.
 </p>
+<dl>
+
+<dt><i>application</i> (QGuiApplication)</dt>
+<dd>
+reference to the application objetc
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
--- a/eric6/Documentation/Source/eric6.UI.PixmapCache.html	Tue Mar 31 19:15:51 2020 +0200
+++ b/eric6/Documentation/Source/eric6.UI.PixmapCache.html	Tue Mar 31 19:16:06 2020 +0200
@@ -63,6 +63,10 @@
 <td><a href="#getSymlinkIcon">getSymlinkIcon</a></td>
 <td>Module function to retrieve a symbolic link icon.</td>
 </tr>
+<tr>
+<td><a href="#removeSearchPath">removeSearchPath</a></td>
+<td>Public method to remove a path from the search path.</td>
+</tr>
 </table>
 <hr />
 <hr />
@@ -100,6 +104,10 @@
 <td><a href="#PixmapCache.getPixmap">getPixmap</a></td>
 <td>Public method to retrieve a pixmap.</td>
 </tr>
+<tr>
+<td><a href="#PixmapCache.removeSearchPath">removeSearchPath</a></td>
+<td>Public method to remove a path from the search path.</td>
+</tr>
 </table>
 <h3>Static Methods</h3>
 
@@ -123,9 +131,9 @@
 </p>
 <dl>
 
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
-path to add (string)
+path to add
 </dd>
 </dl>
 <a NAME="PixmapCache.getPixmap" ID="PixmapCache.getPixmap"></a>
@@ -158,6 +166,20 @@
 QPixmap
 </dd>
 </dl>
+<a NAME="PixmapCache.removeSearchPath" ID="PixmapCache.removeSearchPath"></a>
+<h4>PixmapCache.removeSearchPath</h4>
+<b>removeSearchPath</b>(<i>path</i>)
+
+<p>
+        Public method to remove a path from the search path.
+</p>
+<dl>
+
+<dt><i>path</i> (str)</dt>
+<dd>
+path to remove
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
@@ -170,13 +192,13 @@
 </p>
 <dl>
 
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
 <dd>
-path to add (string)
+path to add
 </dd>
-<dt><i>cache</i></dt>
+<dt><i>cache</i> (PixmapCache)</dt>
 <dd>
-reference to the pixmap cache object (PixmapCache)
+reference to the pixmap cache object
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -329,4 +351,25 @@
 </dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
+<hr />
+<a NAME="removeSearchPath" ID="removeSearchPath"></a>
+<h2>removeSearchPath</h2>
+<b>removeSearchPath</b>(<i>path, cache=pixCache</i>)
+
+<p>
+    Public method to remove a path from the search path.
+</p>
+<dl>
+
+<dt><i>path</i> (str)</dt>
+<dd>
+path to remove
+</dd>
+<dt><i>cache</i> (PixmapCache)</dt>
+<dd>
+reference to the pixmap cache object
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
 </body></html>
\ No newline at end of file
--- a/eric6/Documentation/Source/install.html	Tue Mar 31 19:15:51 2020 +0200
+++ b/eric6/Documentation/Source/install.html	Tue Mar 31 19:16:06 2020 +0200
@@ -136,6 +136,10 @@
 <td>Actually perform the installation steps.</td>
 </tr>
 <tr>
+<td><a href="#isPipOutdated">isPipOutdated</a></td>
+<td>Check, if pip is outdated.</td>
+</tr>
+<tr>
 <td><a href="#main">main</a></td>
 <td>The main function of the script.</td>
 </tr>
@@ -589,6 +593,28 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
+<a NAME="isPipOutdated" ID="isPipOutdated"></a>
+<h2>isPipOutdated</h2>
+<b>isPipOutdated</b>(<i></i>)
+
+<p>
+    Check, if pip is outdated.
+</p>
+<dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating an outdated pip
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
 <a NAME="main" ID="main"></a>
 <h2>main</h2>
 <b>main</b>(<i>argv</i>)
--- a/eric6/Plugins/VcsPlugins/vcsGit/GitLogBrowserDialog.py	Tue Mar 31 19:15:51 2020 +0200
+++ b/eric6/Plugins/VcsPlugins/vcsGit/GitLogBrowserDialog.py	Tue Mar 31 19:16:06 2020 +0200
@@ -480,7 +480,7 @@
         @param n color index
         @type int
         @return color name
-        @type str
+        @rtype str
         """
         if self.__logTreeHasDarkBackground:
             return LIGHTCOLORS[n % len(LIGHTCOLORS)]
--- a/eric6/Plugins/VcsPlugins/vcsMercurial/HgLogBrowserDialog.py	Tue Mar 31 19:15:51 2020 +0200
+++ b/eric6/Plugins/VcsPlugins/vcsMercurial/HgLogBrowserDialog.py	Tue Mar 31 19:16:06 2020 +0200
@@ -533,7 +533,7 @@
         @param n color index
         @type int
         @return color name
-        @type str
+        @rtype str
         """
         if self.__logTreeHasDarkBackground:
             return LIGHTCOLORS[n % len(LIGHTCOLORS)]

eric ide

mercurial