Updated source docu.

Wed, 12 May 2021 19:53:31 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Wed, 12 May 2021 19:53:31 +0200
changeset 8308
f39977d44009
parent 8307
01a323d3d4d7
child 8309
10aa9235b817

Updated 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.E5Network.E5JsonServer.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.Globals.__init__.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.Plugins.PluginVcsGit.html file | annotate | diff | comparison | revisions
eric6/Documentation/Source/eric6.UI.UserInterface.html file | annotate | diff | comparison | revisions
--- a/eric6/APIs/Python3/eric6.api	Wed May 12 19:50:20 2021 +0200
+++ b/eric6/APIs/Python3/eric6.api	Wed May 12 19:53:31 2021 +0200
@@ -1933,7 +1933,8 @@
 eric6.Globals.getInstallInfoFilePath?4()
 eric6.Globals.getPyQt5ModulesDirectory?4()
 eric6.Globals.getPyQtToolsPath?4(version=5)
-eric6.Globals.getPythonModulesDirectory?4()
+eric6.Globals.getPythonLibraryDirectory?4()
+eric6.Globals.getPythonModulesDirectory?7
 eric6.Globals.getQtBinariesPath?4()
 eric6.Globals.getWebBrowserSupport?4()
 eric6.Globals.isGnomeDesktop?4()
Binary file eric6/Documentation/Help/source.qch has changed
--- a/eric6/Documentation/Help/source.qhp	Wed May 12 19:50:20 2021 +0200
+++ b/eric6/Documentation/Help/source.qhp	Wed May 12 19:53:31 2021 +0200
@@ -15836,6 +15836,7 @@
       <keyword name="UserInterface.__openHexEditor" id="UserInterface.__openHexEditor" ref="eric6.UI.UserInterface.html#UserInterface.__openHexEditor" />
       <keyword name="UserInterface.__openMiniEditor" id="UserInterface.__openMiniEditor" ref="eric6.UI.UserInterface.html#UserInterface.__openMiniEditor" />
       <keyword name="UserInterface.__openOnStartup" id="UserInterface.__openOnStartup" ref="eric6.UI.UserInterface.html#UserInterface.__openOnStartup" />
+      <keyword name="UserInterface.__pluginInstallFinished" id="UserInterface.__pluginInstallFinished" ref="eric6.UI.UserInterface.html#UserInterface.__pluginInstallFinished" />
       <keyword name="UserInterface.__pluginsConfigure" id="UserInterface.__pluginsConfigure" ref="eric6.UI.UserInterface.html#UserInterface.__pluginsConfigure" />
       <keyword name="UserInterface.__populateToolbarsMenu" id="UserInterface.__populateToolbarsMenu" ref="eric6.UI.UserInterface.html#UserInterface.__populateToolbarsMenu" />
       <keyword name="UserInterface.__preferencesChanged" id="UserInterface.__preferencesChanged" ref="eric6.UI.UserInterface.html#UserInterface.__preferencesChanged" />
@@ -16063,7 +16064,6 @@
       <keyword name="VcsCommandOptionsDialog.getOptions" id="VcsCommandOptionsDialog.getOptions" ref="eric6.VCS.CommandOptionsDialog.html#VcsCommandOptionsDialog.getOptions" />
       <keyword name="VcsGitPlugin" id="VcsGitPlugin" ref="eric6.Plugins.PluginVcsGit.html#VcsGitPlugin" />
       <keyword name="VcsGitPlugin (Constructor)" id="VcsGitPlugin (Constructor)" ref="eric6.Plugins.PluginVcsGit.html#VcsGitPlugin.__init__" />
-      <keyword name="VcsGitPlugin.__loadTranslator" id="VcsGitPlugin.__loadTranslator" ref="eric6.Plugins.PluginVcsGit.html#VcsGitPlugin.__loadTranslator" />
       <keyword name="VcsGitPlugin.activate" id="VcsGitPlugin.activate" ref="eric6.Plugins.PluginVcsGit.html#VcsGitPlugin.activate" />
       <keyword name="VcsGitPlugin.deactivate" id="VcsGitPlugin.deactivate" ref="eric6.Plugins.PluginVcsGit.html#VcsGitPlugin.deactivate" />
       <keyword name="VcsGitPlugin.getConfigPath" id="VcsGitPlugin.getConfigPath" ref="eric6.Plugins.PluginVcsGit.html#VcsGitPlugin.getConfigPath" />
@@ -18067,7 +18067,7 @@
       <keyword name="getPyQtToolsPath" id="getPyQtToolsPath" ref="eric6.Globals.__init__.html#getPyQtToolsPath" />
       <keyword name="getPython" id="getPython" ref="eric6.Preferences.__init__.html#getPython" />
       <keyword name="getPythonLibPath" id="getPythonLibPath" ref="eric6.Utilities.__init__.html#getPythonLibPath" />
-      <keyword name="getPythonModulesDirectory" id="getPythonModulesDirectory" ref="eric6.Globals.__init__.html#getPythonModulesDirectory" />
+      <keyword name="getPythonLibraryDirectory" id="getPythonLibraryDirectory" ref="eric6.Globals.__init__.html#getPythonLibraryDirectory" />
       <keyword name="getPythonVersion" id="getPythonVersion" ref="eric6.Utilities.__init__.html#getPythonVersion" />
       <keyword name="getQt" id="getQt" ref="eric6.Preferences.__init__.html#getQt" />
       <keyword name="getQtBinariesPath" id="getQtBinariesPath" ref="eric6.Globals.__init__.html#getQtBinariesPath" />
--- a/eric6/Documentation/Source/eric6.E5Network.E5JsonServer.html	Wed May 12 19:50:20 2021 +0200
+++ b/eric6/Documentation/Source/eric6.E5Network.E5JsonServer.html	Wed May 12 19:53:31 2021 +0200
@@ -275,13 +275,14 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating a successful client start
+flag indicating a successful client start and the exit code
+            in case of an issue
 </dd>
 </dl>
 <dl>
 <dt>Return Type:</dt>
 <dd>
-bool
+bool, int
 </dd>
 </dl>
 <a NAME="E5JsonServer.stopAllClients" ID="E5JsonServer.stopAllClients"></a>
--- a/eric6/Documentation/Source/eric6.Globals.__init__.html	Wed May 12 19:50:20 2021 +0200
+++ b/eric6/Documentation/Source/eric6.Globals.__init__.html	Wed May 12 19:53:31 2021 +0200
@@ -28,7 +28,7 @@
 <h3>Global Attributes</h3>
 
 <table>
-<tr><td>configDir</td></tr><tr><td>recentNameBreakpointConditions</td></tr><tr><td>recentNameBreakpointFiles</td></tr><tr><td>recentNameFiles</td></tr><tr><td>recentNameHexFiles</td></tr><tr><td>recentNameHosts</td></tr><tr><td>recentNameMultiProject</td></tr><tr><td>recentNameProject</td></tr><tr><td>settingsNameGlobal</td></tr><tr><td>settingsNameOrganization</td></tr><tr><td>settingsNameRecent</td></tr>
+<tr><td>configDir</td></tr><tr><td>getPythonModulesDirectory</td></tr><tr><td>recentNameBreakpointConditions</td></tr><tr><td>recentNameBreakpointFiles</td></tr><tr><td>recentNameFiles</td></tr><tr><td>recentNameHexFiles</td></tr><tr><td>recentNameHosts</td></tr><tr><td>recentNameMultiProject</td></tr><tr><td>recentNameProject</td></tr><tr><td>settingsNameGlobal</td></tr><tr><td>settingsNameOrganization</td></tr><tr><td>settingsNameRecent</td></tr>
 </table>
 <h3>Classes</h3>
 
@@ -64,8 +64,8 @@
 <td>Module function to get the path of the PyQt tools.</td>
 </tr>
 <tr>
-<td><a href="#getPythonModulesDirectory">getPythonModulesDirectory</a></td>
-<td>Function to determine the path to Python's modules directory.</td>
+<td><a href="#getPythonLibraryDirectory">getPythonLibraryDirectory</a></td>
+<td>Function to determine the path to Python's library directory.</td>
 </tr>
 <tr>
 <td><a href="#getQtBinariesPath">getQtBinariesPath</a></td>
@@ -277,17 +277,23 @@
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
-<a NAME="getPythonModulesDirectory" ID="getPythonModulesDirectory"></a>
-<h2>getPythonModulesDirectory</h2>
-<b>getPythonModulesDirectory</b>(<i></i>)
+<a NAME="getPythonLibraryDirectory" ID="getPythonLibraryDirectory"></a>
+<h2>getPythonLibraryDirectory</h2>
+<b>getPythonLibraryDirectory</b>(<i></i>)
 
 <p>
-    Function to determine the path to Python's modules directory.
+    Function to determine the path to Python's library directory.
 </p>
 <dl>
 <dt>Return:</dt>
 <dd>
-path to the Python modules directory (string)
+path to the Python library directory
+</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.Plugins.PluginVcsGit.html	Wed May 12 19:50:20 2021 +0200
+++ b/eric6/Documentation/Source/eric6.Plugins.PluginVcsGit.html	Wed May 12 19:53:31 2021 +0200
@@ -109,10 +109,6 @@
 <td>Constructor</td>
 </tr>
 <tr>
-<td><a href="#VcsGitPlugin.__loadTranslator">__loadTranslator</a></td>
-<td>Private method to load the translation file.</td>
-</tr>
-<tr>
 <td><a href="#VcsGitPlugin.activate">activate</a></td>
 <td>Public method to activate this plugin.</td>
 </tr>
@@ -199,13 +195,6 @@
 reference to the user interface object (UI.UserInterface)
 </dd>
 </dl>
-<a NAME="VcsGitPlugin.__loadTranslator" ID="VcsGitPlugin.__loadTranslator"></a>
-<h4>VcsGitPlugin.__loadTranslator</h4>
-<b>__loadTranslator</b>(<i></i>)
-
-<p>
-        Private method to load the translation file.
-</p>
 <a NAME="VcsGitPlugin.activate" ID="VcsGitPlugin.activate"></a>
 <h4>VcsGitPlugin.activate</h4>
 <b>activate</b>(<i></i>)
--- a/eric6/Documentation/Source/eric6.UI.UserInterface.html	Wed May 12 19:50:20 2021 +0200
+++ b/eric6/Documentation/Source/eric6.UI.UserInterface.html	Wed May 12 19:53:31 2021 +0200
@@ -526,6 +526,10 @@
 <td>Private method to open the last file, project or multiproject.</td>
 </tr>
 <tr>
+<td><a href="#UserInterface.__pluginInstallFinished">__pluginInstallFinished</a></td>
+<td>Private slot to handle the finishing of the plugin install dialog.</td>
+</tr>
+<tr>
 <td><a href="#UserInterface.__pluginsConfigure">__pluginsConfigure</a></td>
 <td>Private slot to show the plugin manager configuration page.</td>
 </tr>
@@ -1915,6 +1919,13 @@
             "Nothing", "File", "Project", "MultiProject" or "Session")
 </dd>
 </dl>
+<a NAME="UserInterface.__pluginInstallFinished" ID="UserInterface.__pluginInstallFinished"></a>
+<h4>UserInterface.__pluginInstallFinished</h4>
+<b>__pluginInstallFinished</b>(<i></i>)
+
+<p>
+        Private slot to handle the finishing of the plugin install dialog.
+</p>
 <a NAME="UserInterface.__pluginsConfigure" ID="UserInterface.__pluginsConfigure"></a>
 <h4>UserInterface.__pluginsConfigure</h4>
 <b>__pluginsConfigure</b>(<i></i>)

eric ide

mercurial