Documentation/Source/eric5.Plugins.PluginVcsSubversion.html

changeset 58
37f0444c3479
parent 21
b88a0e6268bd
child 110
c9a969db1469
--- a/Documentation/Source/eric5.Plugins.PluginVcsSubversion.html	Thu Jan 14 17:27:31 2010 +0000
+++ b/Documentation/Source/eric5.Plugins.PluginVcsSubversion.html	Thu Jan 14 18:35:52 2010 +0000
@@ -22,7 +22,7 @@
 <body><a NAME="top" ID="top"></a>
 <h1>eric5.Plugins.PluginVcsSubversion</h1>
 <p>
-&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#83;&#117;&#98;v&#101;&#114;&#115;&#105;&#111;&#110; v&#101;&#114;&#115;&#105;&#111;&#110; &#99;&#111;&#110;&#116;&#114;&#111;&#108; &#112;&#108;&#117;&#103;&#105;&#110;.
+Module implementing the Subversion version control plugin.
 </p>
 <h3>Global Attributes</h3>
 <table>
@@ -32,36 +32,36 @@
 <table>
 <tr>
 <td><a href="#VcsSubversionPlugin">VcsSubversionPlugin</a></td>
-<td>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#83;&#117;&#98;v&#101;&#114;&#115;&#105;&#111;&#110; v&#101;&#114;&#115;&#105;&#111;&#110; &#99;&#111;&#110;&#116;&#114;&#111;&#108; &#112;&#108;&#117;&#103;&#105;&#110;.</td>
+<td>Class implementing the Subversion version control plugin.</td>
 </tr>
 </table>
 <h3>Functions</h3>
 <table>
 <tr>
 <td><a href="#createConfigurationPage">createConfigurationPage</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#99;&#114;&#101;&#97;&#116;&#101; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#103;&#101;.</td>
+<td>Module function to create the configuration page.</td>
 </tr><tr>
 <td><a href="#displayString">displayString</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y &#115;&#116;&#114;&#105;&#110;&#103;.</td>
+<td>Public function to get the display string.</td>
 </tr><tr>
 <td><a href="#exeDisplayData">exeDisplayData</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#117;&#112;&#112;&#111;&#114;&#116; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y &#111;&#102; &#115;&#111;&#109;&#101; &#101;x&#101;&#99;&#117;&#116;&#97;&#98;&#108;&#101; &#105;&#110;&#102;&#111;.</td>
+<td>Public method to support the display of some executable info.</td>
 </tr><tr>
 <td><a href="#getConfigData">getConfigData</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#114;&#101;&#116;&#117;&#114;&#110;&#105;&#110;&#103; &#100;&#97;&#116;&#97; &#97;&#115; &#114;&#101;&#113;&#117;&#105;&#114;&#101;&#100; &#98;y &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103;.</td>
+<td>Module function returning data as required by the configuration dialog.</td>
 </tr><tr>
 <td><a href="#getVcsSystemIndicator">getVcsSystemIndicator</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#111;&#114;&#115; &#102;&#111;&#114; &#116;&#104;&#105;&#115; v&#101;&#114;&#115;&#105;&#111;&#110; &#99;&#111;&#110;&#116;&#114;&#111;&#108; &#115;y&#115;&#116;&#101;&#109;.</td>
+<td>Public function to get the indicators for this version control system.</td>
 </tr><tr>
 <td><a href="#prepareUninstall">prepareUninstall</a></td>
-<td>&#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#112;&#114;&#101;&#112;&#97;&#114;&#101; &#102;&#111;&#114; &#97;&#110; &#117;&#110;&#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110;.</td>
+<td>Module function to prepare for an uninstallation.</td>
 </tr>
 </table>
 <hr /><hr />
 <a NAME="VcsSubversionPlugin" ID="VcsSubversionPlugin"></a>
 <h2>VcsSubversionPlugin</h2>
 <p>
-    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#83;&#117;&#98;v&#101;&#114;&#115;&#105;&#111;&#110; v&#101;&#114;&#115;&#105;&#111;&#110; &#99;&#111;&#110;&#116;&#114;&#111;&#108; &#112;&#108;&#117;&#103;&#105;&#110;.
+    Class implementing the Subversion version control plugin.
 </p>
 <h3>Derived from</h3>
 object
@@ -73,127 +73,127 @@
 <table>
 <tr>
 <td><a href="#VcsSubversionPlugin.__init__">VcsSubversionPlugin</a></td>
-<td>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
+<td>Constructor</td>
 </tr><tr>
 <td><a href="#VcsSubversionPlugin.activate">activate</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#99;&#116;&#105;v&#97;&#116;&#101; &#116;&#104;&#105;&#115; &#112;&#108;&#117;&#103;&#105;&#110;.</td>
+<td>Public method to activate this plugin.</td>
 </tr><tr>
 <td><a href="#VcsSubversionPlugin.deactivate">deactivate</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#101;&#97;&#99;&#116;&#105;v&#97;&#116;&#101; &#116;&#104;&#105;&#115; &#112;&#108;&#117;&#103;&#105;&#110;.</td>
+<td>Public method to deactivate this plugin.</td>
 </tr><tr>
 <td><a href="#VcsSubversionPlugin.getConfigPath">getConfigPath</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103; &#102;&#105;&#108;&#101;.</td>
+<td>Public method to get the filename of the config file.</td>
 </tr><tr>
 <td><a href="#VcsSubversionPlugin.getPreferences">getPreferences</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; v&#97;&#114;&#105;&#111;&#117;&#115; &#114;&#101;&#102;&#97;&#99;&#116;&#111;&#114;&#105;&#110;&#103; &#115;&#101;&#116;&#116;&#105;&#110;&#103;&#115;.</td>
+<td>Public method to retrieve the various refactoring settings.</td>
 </tr><tr>
 <td><a href="#VcsSubversionPlugin.getProjectHelper">getProjectHelper</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97; &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#104;&#101;&#108;&#112;&#101;&#114; &#111;&#98;&#106;&#101;&#99;&#116;.</td>
+<td>Public method to get a reference to the project helper object.</td>
 </tr><tr>
 <td><a href="#VcsSubversionPlugin.getServersPath">getServersPath</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#115;&#101;&#114;v&#101;&#114;&#115; &#102;&#105;&#108;&#101;.</td>
+<td>Public method to get the filename of the servers file.</td>
 </tr><tr>
 <td><a href="#VcsSubversionPlugin.prepareUninstall">prepareUninstall</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#112;&#114;&#101;&#112;&#97;&#114;&#101; &#102;&#111;&#114; &#97;&#110; &#117;&#110;&#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110;.</td>
+<td>Public method to prepare for an uninstallation.</td>
 </tr><tr>
 <td><a href="#VcsSubversionPlugin.setPreferences">setPreferences</a></td>
-<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#116;&#111;&#114;&#101; &#116;&#104;&#101; v&#97;&#114;&#105;&#111;&#117;&#115; &#114;&#101;&#102;&#97;&#99;&#116;&#111;&#114;&#105;&#110;&#103; &#115;&#101;&#116;&#116;&#105;&#110;&#103;&#115;.</td>
+<td>Public method to store the various refactoring settings.</td>
 </tr>
 </table>
 <a NAME="VcsSubversionPlugin.__init__" ID="VcsSubversionPlugin.__init__"></a>
 <h4>VcsSubversionPlugin (Constructor)</h4>
 <b>VcsSubversionPlugin</b>(<i>ui</i>)
 <p>
-        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
+        Constructor
 </p><dl>
 <dt><i>ui</i></dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#117;&#115;&#101;&#114; &#105;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101; &#111;&#98;&#106;&#101;&#99;&#116; (&#85;&#73;.&#85;&#115;&#101;&#114;&#73;&#110;&#116;&#101;&#114;&#102;&#97;&#99;&#101;)
+reference to the user interface object (UI.UserInterface)
 </dd>
 </dl><a NAME="VcsSubversionPlugin.activate" ID="VcsSubversionPlugin.activate"></a>
 <h4>VcsSubversionPlugin.activate</h4>
 <b>activate</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#97;&#99;&#116;&#105;v&#97;&#116;&#101; &#116;&#104;&#105;&#115; &#112;&#108;&#117;&#103;&#105;&#110;.
+        Public method to activate this plugin.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#117;&#112;&#108;&#101; &#111;&#102; &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#105;&#110;&#115;&#116;&#97;&#110;&#116;&#105;&#97;&#116;&#101;&#100; v&#105;&#101;w&#109;&#97;&#110;&#97;&#103;&#101;&#114; &#97;&#110;&#100;
-            &#97;&#99;&#116;&#105;v&#97;&#116;&#105;&#111;&#110; &#115;&#116;&#97;&#116;&#117;&#115; (&#98;&#111;&#111;&#108;&#101;&#97;&#110;)
+tuple of reference to instantiated viewmanager and
+            activation status (boolean)
 </dd>
 </dl><a NAME="VcsSubversionPlugin.deactivate" ID="VcsSubversionPlugin.deactivate"></a>
 <h4>VcsSubversionPlugin.deactivate</h4>
 <b>deactivate</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#100;&#101;&#97;&#99;&#116;&#105;v&#97;&#116;&#101; &#116;&#104;&#105;&#115; &#112;&#108;&#117;&#103;&#105;&#110;.
+        Public method to deactivate this plugin.
 </p><a NAME="VcsSubversionPlugin.getConfigPath" ID="VcsSubversionPlugin.getConfigPath"></a>
 <h4>VcsSubversionPlugin.getConfigPath</h4>
 <b>getConfigPath</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103; &#102;&#105;&#108;&#101;.
+        Public method to get the filename of the config file.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+filename of the config file (string)
 </dd>
 </dl><a NAME="VcsSubversionPlugin.getPreferences" ID="VcsSubversionPlugin.getPreferences"></a>
 <h4>VcsSubversionPlugin.getPreferences</h4>
 <b>getPreferences</b>(<i>key</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#116;&#114;&#105;&#101;v&#101; &#116;&#104;&#101; v&#97;&#114;&#105;&#111;&#117;&#115; &#114;&#101;&#102;&#97;&#99;&#116;&#111;&#114;&#105;&#110;&#103; &#115;&#101;&#116;&#116;&#105;&#110;&#103;&#115;.
+        Public method to retrieve the various refactoring settings.
 </p><dl>
 <dt><i>key</i></dt>
 <dd>
-&#116;&#104;&#101; &#107;&#101;y &#111;&#102; &#116;&#104;&#101; v&#97;&#108;&#117;&#101; &#116;&#111; &#103;&#101;&#116;
+the key of the value to get
 </dd><dt><i>prefClass</i></dt>
 <dd>
-&#112;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#99;&#108;&#97;&#115;&#115; &#117;&#115;&#101;&#100; &#97;&#115; &#116;&#104;&#101; &#115;&#116;&#111;&#114;&#97;&#103;&#101; &#97;&#114;&#101;&#97;
+preferences class used as the storage area
 </dd>
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-&#116;&#104;&#101; &#114;&#101;&#113;&#117;&#101;&#115;&#116;&#101;&#100; &#114;&#101;&#102;&#97;&#99;&#116;&#111;&#114;&#105;&#110;&#103; &#115;&#101;&#116;&#116;&#105;&#110;&#103;
+the requested refactoring setting
 </dd>
 </dl><a NAME="VcsSubversionPlugin.getProjectHelper" ID="VcsSubversionPlugin.getProjectHelper"></a>
 <h4>VcsSubversionPlugin.getProjectHelper</h4>
 <b>getProjectHelper</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#97; &#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#104;&#101;&#108;&#112;&#101;&#114; &#111;&#98;&#106;&#101;&#99;&#116;.
+        Public method to get a reference to the project helper object.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#112;&#114;&#111;&#106;&#101;&#99;&#116; &#104;&#101;&#108;&#112;&#101;&#114; &#111;&#98;&#106;&#101;&#99;&#116;
+reference to the project helper object
 </dd>
 </dl><a NAME="VcsSubversionPlugin.getServersPath" ID="VcsSubversionPlugin.getServersPath"></a>
 <h4>VcsSubversionPlugin.getServersPath</h4>
 <b>getServersPath</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#115;&#101;&#114;v&#101;&#114;&#115; &#102;&#105;&#108;&#101;.
+        Public method to get the filename of the servers file.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#115;&#101;&#114;v&#101;&#114;&#115; &#102;&#105;&#108;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
+filename of the servers file (string)
 </dd>
 </dl><a NAME="VcsSubversionPlugin.prepareUninstall" ID="VcsSubversionPlugin.prepareUninstall"></a>
 <h4>VcsSubversionPlugin.prepareUninstall</h4>
 <b>prepareUninstall</b>(<i></i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#112;&#114;&#101;&#112;&#97;&#114;&#101; &#102;&#111;&#114; &#97;&#110; &#117;&#110;&#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110;.
+        Public method to prepare for an uninstallation.
 </p><a NAME="VcsSubversionPlugin.setPreferences" ID="VcsSubversionPlugin.setPreferences"></a>
 <h4>VcsSubversionPlugin.setPreferences</h4>
 <b>setPreferences</b>(<i>key, value</i>)
 <p>
-        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#116;&#111;&#114;&#101; &#116;&#104;&#101; v&#97;&#114;&#105;&#111;&#117;&#115; &#114;&#101;&#102;&#97;&#99;&#116;&#111;&#114;&#105;&#110;&#103; &#115;&#101;&#116;&#116;&#105;&#110;&#103;&#115;.
+        Public method to store the various refactoring settings.
 </p><dl>
 <dt><i>key</i></dt>
 <dd>
-&#116;&#104;&#101; &#107;&#101;y &#111;&#102; &#116;&#104;&#101; &#115;&#101;&#116;&#116;&#105;&#110;&#103; &#116;&#111; &#98;&#101; &#115;&#101;&#116;
+the key of the setting to be set
 </dd><dt><i>value</i></dt>
 <dd>
-&#116;&#104;&#101; v&#97;&#108;&#117;&#101; &#116;&#111; &#98;&#101; &#115;&#101;&#116;
+the value to be set
 </dd><dt><i>prefClass</i></dt>
 <dd>
-&#112;&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101;&#115; &#99;&#108;&#97;&#115;&#115; &#117;&#115;&#101;&#100; &#97;&#115; &#116;&#104;&#101; &#115;&#116;&#111;&#114;&#97;&#103;&#101; &#97;&#114;&#101;&#97;
+preferences class used as the storage area
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -202,11 +202,11 @@
 <h2>createConfigurationPage</h2>
 <b>createConfigurationPage</b>(<i>configDlg</i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#99;&#114;&#101;&#97;&#116;&#101; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#103;&#101;.
+    Module function to create the configuration page.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#114;&#101;&#102;&#101;&#114;&#101;&#110;&#99;&#101; &#116;&#111; &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#112;&#97;&#103;&#101;
+reference to the configuration page
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -215,11 +215,11 @@
 <h2>displayString</h2>
 <b>displayString</b>(<i></i>)
 <p>
-    &#80;&#117;&#98;&#108;&#105;&#99; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y &#115;&#116;&#114;&#105;&#110;&#103;.
+    Public function to get the display string.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#100;&#105;&#115;&#112;&#108;&#97;y &#115;&#116;&#114;&#105;&#110;&#103; (&#81;&#83;&#116;&#114;&#105;&#110;&#103;)
+display string (QString)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -228,12 +228,12 @@
 <h2>exeDisplayData</h2>
 <b>exeDisplayData</b>(<i></i>)
 <p>
-    &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#115;&#117;&#112;&#112;&#111;&#114;&#116; &#116;&#104;&#101; &#100;&#105;&#115;&#112;&#108;&#97;y &#111;&#102; &#115;&#111;&#109;&#101; &#101;x&#101;&#99;&#117;&#116;&#97;&#98;&#108;&#101; &#105;&#110;&#102;&#111;.
+    Public method to support the display of some executable info.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#100;&#97;&#116;&#97; &#116;&#111; &#113;&#117;&#101;&#114;y &#116;&#104;&#101; &#112;&#114;&#101;&#115;&#101;&#110;&#99;&#101; &#111;&#102;
-        &#116;&#104;&#101; &#101;x&#101;&#99;&#117;&#116;&#97;&#98;&#108;&#101;
+dictionary containing the data to query the presence of
+        the executable
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -242,11 +242,11 @@
 <h2>getConfigData</h2>
 <b>getConfigData</b>(<i></i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#114;&#101;&#116;&#117;&#114;&#110;&#105;&#110;&#103; &#100;&#97;&#116;&#97; &#97;&#115; &#114;&#101;&#113;&#117;&#105;&#114;&#101;&#100; &#98;y &#116;&#104;&#101; &#99;&#111;&#110;&#102;&#105;&#103;&#117;&#114;&#97;&#116;&#105;&#111;&#110; &#100;&#105;&#97;&#108;&#111;&#103;.
+    Module function returning data as required by the configuration dialog.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y w&#105;&#116;&#104; &#107;&#101;y "zzz&#95;&#115;&#117;&#98;v&#101;&#114;&#115;&#105;&#111;&#110;&#80;&#97;&#103;&#101;" &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101; &#114;&#101;&#108;&#101;v&#97;&#110;&#116; &#100;&#97;&#116;&#97;
+dictionary with key "zzz_subversionPage" containing the relevant data
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -255,12 +255,12 @@
 <h2>getVcsSystemIndicator</h2>
 <b>getVcsSystemIndicator</b>(<i></i>)
 <p>
-    &#80;&#117;&#98;&#108;&#105;&#99; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#103;&#101;&#116; &#116;&#104;&#101; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#111;&#114;&#115; &#102;&#111;&#114; &#116;&#104;&#105;&#115; v&#101;&#114;&#115;&#105;&#111;&#110; &#99;&#111;&#110;&#116;&#114;&#111;&#108; &#115;y&#115;&#116;&#101;&#109;.
+    Public function to get the indicators for this version control system.
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y w&#105;&#116;&#104; &#105;&#110;&#100;&#105;&#99;&#97;&#116;&#111;&#114; &#97;&#115; &#107;&#101;y &#97;&#110;&#100; &#97; &#116;&#117;&#112;&#108;&#101; w&#105;&#116;&#104; &#116;&#104;&#101; v&#99;&#115; &#110;&#97;&#109;&#101; (&#115;&#116;&#114;&#105;&#110;&#103;)
-        &#97;&#110;&#100; v&#99;&#115; &#100;&#105;&#115;&#112;&#108;&#97;y &#115;&#116;&#114;&#105;&#110;&#103; (&#115;&#116;&#114;&#105;&#110;&#103;)
+dictionary with indicator as key and a tuple with the vcs name (string)
+        and vcs display string (string)
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -269,7 +269,7 @@
 <h2>prepareUninstall</h2>
 <b>prepareUninstall</b>(<i></i>)
 <p>
-    &#77;&#111;&#100;&#117;&#108;&#101; &#102;&#117;&#110;&#99;&#116;&#105;&#111;&#110; &#116;&#111; &#112;&#114;&#101;&#112;&#97;&#114;&#101; &#102;&#111;&#114; &#97;&#110; &#117;&#110;&#105;&#110;&#115;&#116;&#97;&#108;&#108;&#97;&#116;&#105;&#111;&#110;.
+    Module function to prepare for an uninstallation.
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />

eric ide

mercurial