Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsMercurial.html	Fri Dec 22 17:24:07 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsMercurial.html	Fri Dec 22 19:45:17 2023 +0100
@@ -142,7 +142,7 @@
 </p>
 <dl>
 
-<dt><i>key</i></dt>
+<dt><i>key</i> (str)</dt>
 <dd>
 the key of the value to get
 </dd>
@@ -153,6 +153,12 @@
 the requested setting
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Any
+</dd>
+</dl>
 <a NAME="VcsMercurialPlugin.setPreferences" ID="VcsMercurialPlugin.setPreferences"></a>
 <h4>VcsMercurialPlugin.setPreferences (class method)</h4>
 <b>setPreferences</b>(<i>key, value</i>)
@@ -162,11 +168,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>
@@ -180,9 +186,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="VcsMercurialPlugin.activate" ID="VcsMercurialPlugin.activate"></a>
@@ -196,7 +202,13 @@
 <dt>Return:</dt>
 <dd>
 tuple of reference to instantiated viewmanager and
-            activation status (boolean)
+            activation status
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (Hg, bool)
 </dd>
 </dl>
 <a NAME="VcsMercurialPlugin.deactivate" ID="VcsMercurialPlugin.deactivate"></a>
@@ -216,7 +228,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="VcsMercurialPlugin.getGlobalOptions" ID="VcsMercurialPlugin.getGlobalOptions"></a>
@@ -229,7 +247,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of global options (list of string)
+list of global options
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="VcsMercurialPlugin.getProjectHelper" ID="VcsMercurialPlugin.getProjectHelper"></a>
@@ -245,6 +269,12 @@
 reference to the project helper object
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+HgProjectHelper
+</dd>
+</dl>
 <a NAME="VcsMercurialPlugin.initToolbar" ID="VcsMercurialPlugin.initToolbar"></a>
 <h4>VcsMercurialPlugin.initToolbar</h4>
 <b>initToolbar</b>(<i>ui, toolbarManager</i>)
@@ -254,14 +284,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="VcsMercurialPlugin.prepareUninstall" ID="VcsMercurialPlugin.prepareUninstall"></a>
@@ -300,9 +329,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>
@@ -311,6 +340,12 @@
 reference to the configuration page
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+MercurialPage
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
@@ -324,7 +359,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>
@@ -344,6 +385,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 />
@@ -357,8 +404,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-dictionary with key "zzz_mercurialPage" containing the relevant
-        data
+dictionary with key "zzz_mercurialPage" containing the relevant data
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -375,7 +427,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>