Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsGit.html	Fri Dec 22 17:24:07 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsGit.html	Fri Dec 22 19:45:17 2023 +0100
@@ -138,7 +138,7 @@
 </p>
 <dl>
 
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
 <dd>
 the key of the value to get
 </dd>
@@ -149,6 +149,12 @@
 the requested setting
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Any
+</dd>
+</dl>
 <a NAME="VcsGitPlugin.setPreferences" ID="VcsGitPlugin.setPreferences"></a>
 <h4>VcsGitPlugin.setPreferences (class method)</h4>
 <b>setPreferences</b>(<i>key, value</i>)
@@ -158,11 +164,11 @@
 </p>
 <dl>
 
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
 <dd>
 the key of the setting to be set
 </dd>
-<dt><i>value</i></dt>
+<dt><i>value</i> (Any)</dt>
 <dd>
 the value to be set
 </dd>
@@ -176,9 +182,9 @@
 </p>
 <dl>
 
-<dt><i>ui</i></dt>
+<dt><i>ui</i> (UserInterface)</dt>
 <dd>
-reference to the user interface object (UI.UserInterface)
+reference to the user interface object
 </dd>
 </dl>
 <a NAME="VcsGitPlugin.activate" ID="VcsGitPlugin.activate"></a>
@@ -191,8 +197,14 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-tuple of reference to instantiated viewmanager and
-            activation status (boolean)
+tuple of reference to instantiated version control and
+            activation status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (Git, bool)
 </dd>
 </dl>
 <a NAME="VcsGitPlugin.deactivate" ID="VcsGitPlugin.deactivate"></a>
@@ -212,7 +224,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-filename of the config file (string)
+filename of the config file
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="VcsGitPlugin.getProjectHelper" ID="VcsGitPlugin.getProjectHelper"></a>
@@ -228,6 +246,12 @@
 reference to the project helper object
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+GitProjectHelper
+</dd>
+</dl>
 <a NAME="VcsGitPlugin.initToolbar" ID="VcsGitPlugin.initToolbar"></a>
 <h4>VcsGitPlugin.initToolbar</h4>
 <b>initToolbar</b>(<i>ui, toolbarManager</i>)
@@ -237,14 +261,13 @@
 </p>
 <dl>
 
-<dt><i>ui</i></dt>
+<dt><i>ui</i> (UserInterface)</dt>
 <dd>
-reference to the main window (UserInterface)
+reference to the main window
 </dd>
-<dt><i>toolbarManager</i></dt>
+<dt><i>toolbarManager</i> (EricToolBarManager)</dt>
 <dd>
 reference to a toolbar manager object
-            (EricToolBarManager)
 </dd>
 </dl>
 <a NAME="VcsGitPlugin.prepareUninstall" ID="VcsGitPlugin.prepareUninstall"></a>
@@ -283,9 +306,9 @@
 </p>
 <dl>
 
-<dt><i>configDlg</i></dt>
+<dt><i>configDlg</i> (QDialog)</dt>
 <dd>
-reference to the configuration dialog (QDialog)
+reference to the configuration dialog
 </dd>
 </dl>
 <dl>
@@ -294,6 +317,12 @@
 reference to the configuration page
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+GitPage
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
@@ -307,7 +336,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-display string (string)
+display string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -327,6 +362,12 @@
         the executable
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
@@ -340,8 +381,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-dictionary with key "zzz_gitPage" containing the relevant
-        data
+dictionary with key "zzz_gitPage" containing the relevant data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -358,7 +404,13 @@
 <dt>Return:</dt>
 <dd>
 dictionary with indicator as key and a tuple with the vcs name
-        (string) and vcs display string (string)
+        and vcs display string
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>