--- a/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsSubversion.html Fri Dec 22 17:24:07 2023 +0100 +++ b/src/eric7/Documentation/Source/eric7.Plugins.PluginVcsSubversion.html Fri Dec 22 19:45:17 2023 +0100 @@ -138,9 +138,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="VcsSubversionPlugin.activate" ID="VcsSubversionPlugin.activate"></a> @@ -154,7 +154,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 (Subversion, bool) </dd> </dl> <a NAME="VcsSubversionPlugin.deactivate" ID="VcsSubversionPlugin.deactivate"></a> @@ -174,7 +180,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="VcsSubversionPlugin.getPreferences" ID="VcsSubversionPlugin.getPreferences"></a> @@ -186,7 +198,7 @@ </p> <dl> -<dt><i>key</i></dt> +<dt><i>key</i> (str)</dt> <dd> the key of the value to get </dd> @@ -197,6 +209,12 @@ the requested setting </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +Any +</dd> +</dl> <a NAME="VcsSubversionPlugin.getProjectHelper" ID="VcsSubversionPlugin.getProjectHelper"></a> <h4>VcsSubversionPlugin.getProjectHelper</h4> <b>getProjectHelper</b>(<i></i>) @@ -210,6 +228,12 @@ reference to the project helper object </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +SvnProjectHelper +</dd> +</dl> <a NAME="VcsSubversionPlugin.getServersPath" ID="VcsSubversionPlugin.getServersPath"></a> <h4>VcsSubversionPlugin.getServersPath</h4> <b>getServersPath</b>(<i></i>) @@ -220,7 +244,13 @@ <dl> <dt>Return:</dt> <dd> -filename of the servers file (string) +filename of the servers file +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +str </dd> </dl> <a NAME="VcsSubversionPlugin.initToolbar" ID="VcsSubversionPlugin.initToolbar"></a> @@ -232,14 +262,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="VcsSubversionPlugin.prepareUninstall" ID="VcsSubversionPlugin.prepareUninstall"></a> @@ -265,11 +294,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> @@ -286,9 +315,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> @@ -297,6 +326,12 @@ reference to the configuration page </dd> </dl> +<dl> +<dt>Return Type:</dt> +<dd> +SubversionPage +</dd> +</dl> <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> @@ -310,7 +345,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> @@ -330,6 +371,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 /> @@ -344,6 +391,12 @@ <dt>Return:</dt> <dd> dictionary with key "zzz_subversionPage" containing the relevant +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict data </dd> </dl> @@ -361,7 +414,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>