diff -r 2f70ca07f0af -r 4cd7e5a8b3cf src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.subversion.html
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.subversion.html Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsPySvn.subversion.html Sat Dec 23 15:40:23 2023 +0100
@@ -362,17 +362,17 @@
</p>
<dl>
-<dt><i>plugin</i></dt>
+<dt><i>plugin</i> (VcsSubversionPlugin)</dt>
<dd>
reference to the plugin object
</dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
<dd>
-parent widget (QWidget)
+parent widget
</dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-name of this object (string)
+name of this object
</dd>
</dl>
<a NAME="Subversion.__isVersioned" ID="Subversion.__isVersioned"></a>
@@ -385,15 +385,21 @@
</p>
<dl>
-<dt><i>status</i></dt>
+<dt><i>status</i> (pysvn.PysvnStatus)</dt>
<dd>
-status object to check (pysvn.PysvnStatus)
+status object to check
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating a versioned state (boolean)
+flag indicating a versioned state
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Subversion.__svnGetFileForRevision" ID="Subversion.__svnGetFileForRevision"></a>
@@ -406,19 +412,25 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-file name to get from the repository (string)
+file name to get from the repository
</dd>
-<dt><i>rev</i></dt>
+<dt><i>rev</i> (int or str)</dt>
<dd>
-revision to retrieve (integer or string)
+revision to retrieve
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-contents of the file (string) and an error message (string)
+contents of the file (string) and an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Subversion.__svnURL" ID="Subversion.__svnURL"></a>
@@ -430,15 +442,21 @@
</p>
<dl>
-<dt><i>url</i></dt>
+<dt><i>url</i> (str)</dt>
<dd>
-unformatted url string (string)
+unformatted url string
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-properly formated url for subversion (string)
+properly formated url for subversion
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Subversion.__vcsAllRegisteredStates_wc" ID="Subversion.__vcsAllRegisteredStates_wc"></a>
@@ -460,17 +478,17 @@
</p>
<dl>
-<dt><i>names</i></dt>
+<dt><i>names</i> (dict)</dt>
<dd>
dictionary with all filenames to be checked as keys
</dd>
-<dt><i>dname</i></dt>
+<dt><i>dname</i> (str)</dt>
<dd>
-directory to check in (string)
+directory to check in
</dd>
-<dt><i>shortcut</i></dt>
+<dt><i>shortcut</i> (bool)</dt>
<dd>
-flag indicating a shortcut should be taken (boolean)
+flag indicating a shortcut should be taken
</dd>
</dl>
<dl>
@@ -480,6 +498,12 @@
canBeCommited and canBeAdded or None in order to signal an error
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
<a NAME="Subversion.__vcsAllRegisteredStates_wcng" ID="Subversion.__vcsAllRegisteredStates_wcng"></a>
<h4>Subversion.__vcsAllRegisteredStates_wcng</h4>
<b>__vcsAllRegisteredStates_wcng</b>(<i>names, dname, shortcut=True</i>)
@@ -499,17 +523,17 @@
</p>
<dl>
-<dt><i>names</i></dt>
+<dt><i>names</i> (dict)</dt>
<dd>
dictionary with all filenames to be checked as keys
</dd>
-<dt><i>dname</i></dt>
+<dt><i>dname</i> (str)</dt>
<dd>
-directory to check in (string)
+directory to check in
</dd>
-<dt><i>shortcut</i></dt>
+<dt><i>shortcut</i> (bool)</dt>
<dd>
-flag indicating a shortcut should be taken (boolean)
+flag indicating a shortcut should be taken
</dd>
</dl>
<dl>
@@ -519,6 +543,12 @@
canBeCommited and canBeAdded or None in order to signal an error
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
<a NAME="Subversion.__vcsCommit_Step2" ID="Subversion.__vcsCommit_Step2"></a>
<h4>Subversion.__vcsCommit_Step2</h4>
<b>__vcsCommit_Step2</b>(<i></i>)
@@ -539,15 +569,21 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-filename to check (string)
+filename to check
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-a combination of canBeCommited and canBeAdded
+registered state (one of canBeCommited and canBeAdded)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="Subversion.__vcsRegisteredState_wcng" ID="Subversion.__vcsRegisteredState_wcng"></a>
@@ -563,15 +599,21 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-filename to check (string)
+filename to check
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-a combination of canBeCommited and canBeAdded
+registered state (one of canBeCommited and canBeAdded)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="Subversion._createStatusMonitorThread" ID="Subversion._createStatusMonitorThread"></a>
@@ -584,12 +626,11 @@
</p>
<dl>
-<dt><i>interval</i></dt>
+<dt><i>interval</i> (int)</dt>
<dd>
check interval for the monitor thread in seconds
- (integer)
</dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
@@ -597,7 +638,13 @@
<dl>
<dt>Return:</dt>
<dd>
-reference to the monitor thread (QThread)
+reference to the monitor thread
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+SvnStatusMonitorThread
</dd>
</dl>
<a NAME="Subversion.clearStatusCache" ID="Subversion.clearStatusCache"></a>
@@ -617,7 +664,13 @@
<dl>
<dt>Return:</dt>
<dd>
-the pysvn client object (pysvn.Client)
+the pysvn client object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+pysvn.Client
</dd>
</dl>
<a NAME="Subversion.getPlugin" ID="Subversion.getPlugin"></a>
@@ -630,7 +683,13 @@
<dl>
<dt>Return:</dt>
<dd>
-reference to the plugin object (VcsPySvnPlugin)
+reference to the plugin object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+VcsPySvnPlugin
</dd>
</dl>
<a NAME="Subversion.svnAddToChangelist" ID="Subversion.svnAddToChangelist"></a>
@@ -645,10 +704,9 @@
</p>
<dl>
-<dt><i>names</i></dt>
+<dt><i>names</i> (str or list of str)</dt>
<dd>
name or list of names of file or directory to add
- (string)
</dd>
</dl>
<a NAME="Subversion.svnBlame" ID="Subversion.svnBlame"></a>
@@ -660,9 +718,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-file name to show the blame for (string)
+file name to show the blame for
</dd>
</dl>
<a NAME="Subversion.svnCopy" ID="Subversion.svnCopy"></a>
@@ -674,11 +732,11 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-file/directory name to be copied (string)
+file/directory name to be copied
</dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
@@ -686,7 +744,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating successfull operation (boolean)
+flag indicating successfull operation
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Subversion.svnDelProp" ID="Subversion.svnDelProp"></a>
@@ -698,11 +762,11 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str or list of str)</dt>
<dd>
-file/directory name (string or list of strings)
+file/directory name
</dd>
-<dt><i>recursive</i></dt>
+<dt><i>recursive</i> (bool)</dt>
<dd>
flag indicating a recursive list is requested
</dd>
@@ -726,9 +790,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-file/directory name to be diffed (string)
+file/directory name to be diffed
</dd>
</dl>
<a NAME="Subversion.svnGetChangelists" ID="Subversion.svnGetChangelists"></a>
@@ -741,7 +805,13 @@
<dl>
<dt>Return:</dt>
<dd>
-list of defined change list names (list of strings)
+list of defined change list names
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
</dd>
</dl>
<a NAME="Subversion.svnGetReposName" ID="Subversion.svnGetReposName"></a>
@@ -754,9 +824,9 @@
</p>
<dl>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
<dd>
-local path to get the svn repository path for (string)
+local path to get the svn repository path for
</dd>
</dl>
<dl>
@@ -765,6 +835,12 @@
string with the repository path URL
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
<a NAME="Subversion.svnInfo" ID="Subversion.svnInfo"></a>
<h4>Subversion.svnInfo</h4>
<b>svnInfo</b>(<i>projectPath, name</i>)
@@ -774,13 +850,13 @@
</p>
<dl>
-<dt><i>projectPath</i></dt>
+<dt><i>projectPath</i> (str)</dt>
<dd>
-path name of the project (string)
+path name of the project
</dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-file/directory name relative to the project (string)
+file/directory name relative to the project
</dd>
</dl>
<a NAME="Subversion.svnListProps" ID="Subversion.svnListProps"></a>
@@ -792,11 +868,11 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str or list of str)</dt>
<dd>
-file/directory name (string or list of strings)
+file/directory name
</dd>
-<dt><i>recursive</i></dt>
+<dt><i>recursive</i> (bool)</dt>
<dd>
flag indicating a recursive list is requested
</dd>
@@ -810,11 +886,11 @@
</p>
<dl>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
<dd>
-directory name of the project (string)
+directory name of the project
</dd>
-<dt><i>tags</i></dt>
+<dt><i>tags</i> (bool)</dt>
<dd>
flag indicating listing of branches or tags
(False = branches, True = tags)
@@ -829,19 +905,17 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str or list of str)</dt>
<dd>
-file/directory name to be locked (string or list of
- strings)
+file/directory name to be locked
</dd>
-<dt><i>stealIt</i></dt>
+<dt><i>stealIt</i> (bool)</dt>
<dd>
-flag indicating a forced operation (boolean)
+flag indicating a forced operation
</dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent object of the subversion dialog
- (QWidget)
</dd>
</dl>
<a NAME="Subversion.svnNormalizeURL" ID="Subversion.svnNormalizeURL"></a>
@@ -853,15 +927,21 @@
</p>
<dl>
-<dt><i>url</i></dt>
+<dt><i>url</i> (str)</dt>
<dd>
-url string (string)
+url string
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-properly normalized url for subversion (string)
+properly normalized url for subversion
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Subversion.svnRelocate" ID="Subversion.svnRelocate"></a>
@@ -873,9 +953,9 @@
</p>
<dl>
-<dt><i>projectPath</i></dt>
+<dt><i>projectPath</i> (str)</dt>
<dd>
-path name of the project (string)
+path name of the project
</dd>
</dl>
<a NAME="Subversion.svnRemoveFromChangelist" ID="Subversion.svnRemoveFromChangelist"></a>
@@ -890,10 +970,9 @@
</p>
<dl>
-<dt><i>names</i></dt>
+<dt><i>names</i> (str or list of str)</dt>
<dd>
name or list of names of file or directory to remove
- (string)
</dd>
</dl>
<a NAME="Subversion.svnRepoBrowser" ID="Subversion.svnRepoBrowser"></a>
@@ -905,9 +984,9 @@
</p>
<dl>
-<dt><i>projectPath</i></dt>
+<dt><i>projectPath</i> (str)</dt>
<dd>
-path name of the project (string)
+path name of the project
</dd>
</dl>
<a NAME="Subversion.svnSetProp" ID="Subversion.svnSetProp"></a>
@@ -919,11 +998,11 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str or list of str)</dt>
<dd>
-file/directory name (string or list of strings)
+file/directory name
</dd>
-<dt><i>recursive</i></dt>
+<dt><i>recursive</i> (bool)</dt>
<dd>
flag indicating a recursive set is requested
</dd>
@@ -937,9 +1016,9 @@
</p>
<dl>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
<dd>
-directory name to show change lists for (string)
+directory name to show change lists for
</dd>
</dl>
<a NAME="Subversion.svnUnlock" ID="Subversion.svnUnlock"></a>
@@ -951,19 +1030,17 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str or list of str)</dt>
<dd>
-file/directory name to be unlocked (string or list of
- strings)
+file/directory name to be unlocked
</dd>
-<dt><i>breakIt</i></dt>
+<dt><i>breakIt</i> (bool)</dt>
<dd>
-flag indicating a forced operation (boolean)
+flag indicating a forced operation
</dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
<dd>
reference to the parent object of the subversion dialog
- (QWidget)
</dd>
</dl>
<a NAME="Subversion.svnUpgrade" ID="Subversion.svnUpgrade"></a>
@@ -975,9 +1052,9 @@
</p>
<dl>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str)</dt>
<dd>
-directory name to show change lists for (string)
+directory name to show change lists for
</dd>
</dl>
<a NAME="Subversion.svnUrlDiff" ID="Subversion.svnUrlDiff"></a>
@@ -999,9 +1076,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-file/directory name to be diffed (string)
+file/directory name to be diffed
</dd>
</dl>
<a NAME="Subversion.vcsAdd" ID="Subversion.vcsAdd"></a>
@@ -1014,17 +1091,17 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-file/directory name to be added (string)
+file/directory name to be added
</dd>
-<dt><i>isDir</i></dt>
+<dt><i>isDir</i> (bool)</dt>
<dd>
-flag indicating name is a directory (boolean)
+flag indicating name is a directory
</dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
<dd>
-flag indicating quiet operations (boolean)
+flag indicating quiet operations
</dd>
</dl>
<a NAME="Subversion.vcsAddBinary" ID="Subversion.vcsAddBinary"></a>
@@ -1037,13 +1114,13 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-file/directory name to be added (string)
+file/directory name to be added
</dd>
-<dt><i>isDir</i></dt>
+<dt><i>isDir</i> (bool)</dt>
<dd>
-flag indicating name is a directory (boolean)
+flag indicating name is a directory
</dd>
</dl>
<a NAME="Subversion.vcsAddCommitMessage" ID="Subversion.vcsAddCommitMessage"></a>
@@ -1070,10 +1147,9 @@
</p>
<dl>
-<dt><i>path</i></dt>
+<dt><i>path</i> (str or list of str)</dt>
<dd>
-root directory of the tree to be added (string or list of
- strings))
+root directory of the tree to be added
</dd>
</dl>
<a NAME="Subversion.vcsAllRegisteredStates" ID="Subversion.vcsAllRegisteredStates"></a>
@@ -1091,17 +1167,17 @@
</p>
<dl>
-<dt><i>names</i></dt>
+<dt><i>names</i> (dict)</dt>
<dd>
dictionary with all filenames to be checked as keys
</dd>
-<dt><i>dname</i></dt>
+<dt><i>dname</i> (str)</dt>
<dd>
-directory to check in (string)
+directory to check in
</dd>
-<dt><i>shortcut</i></dt>
+<dt><i>shortcut</i> (bool)</dt>
<dd>
-flag indicating a shortcut should be taken (boolean)
+flag indicating a shortcut should be taken
</dd>
</dl>
<dl>
@@ -1111,6 +1187,12 @@
canBeCommited and canBeAdded or None in order to signal an error
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
<a NAME="Subversion.vcsCheckout" ID="Subversion.vcsCheckout"></a>
<h4>Subversion.vcsCheckout</h4>
<b>vcsCheckout</b>(<i>vcsDataDict, projectDir, noDialog=False</i>)
@@ -1121,15 +1203,15 @@
</p>
<dl>
-<dt><i>vcsDataDict</i></dt>
+<dt><i>vcsDataDict</i> (dict)</dt>
<dd>
dictionary of data required for the checkout
</dd>
-<dt><i>projectDir</i></dt>
+<dt><i>projectDir</i> (str)</dt>
<dd>
-project directory to create (string)
+project directory to create
</dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
<dd>
flag indicating quiet operations
</dd>
@@ -1137,7 +1219,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating an execution without errors (boolean)
+flag indicating an execution without errors
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Subversion.vcsCleanup" ID="Subversion.vcsCleanup"></a>
@@ -1149,9 +1237,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-directory name to be cleaned up (string)
+directory name to be cleaned up
</dd>
</dl>
<a NAME="Subversion.vcsClearCommitMessages" ID="Subversion.vcsClearCommitMessages"></a>
@@ -1170,9 +1258,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-directory name of the working directory (string)
+directory name of the working directory
</dd>
</dl>
<a NAME="Subversion.vcsCommit" ID="Subversion.vcsCommit"></a>
@@ -1185,16 +1273,15 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str or list of str)</dt>
<dd>
-file/directory name to be committed (string or
- list of strings)
+file/directory name to be committed
</dd>
-<dt><i>message</i></dt>
+<dt><i>message</i> (str)</dt>
<dd>
-message for this operation (string)
+message for this operation
</dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
<dd>
flag indicating quiet operations
</dd>
@@ -1257,9 +1344,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-file/directory name to be diffed (string)
+file/directory name to be diffed
</dd>
</dl>
<a NAME="Subversion.vcsExists" ID="Subversion.vcsExists"></a>
@@ -1272,8 +1359,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating the existance (boolean) and an error message
- (string)
+flag indicating the existance and an error message
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (bool, str)
</dd>
</dl>
<a NAME="Subversion.vcsExport" ID="Subversion.vcsExport"></a>
@@ -1286,19 +1378,25 @@
</p>
<dl>
-<dt><i>vcsDataDict</i></dt>
+<dt><i>vcsDataDict</i> (dict)</dt>
<dd>
dictionary of data required for the checkout
</dd>
-<dt><i>projectDir</i></dt>
+<dt><i>projectDir</i> (str)</dt>
<dd>
-project directory to create (string)
+project directory to create
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating an execution without errors (boolean)
+flag indicating an execution without errors
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Subversion.vcsForget" ID="Subversion.vcsForget"></a>
@@ -1329,15 +1427,15 @@
</p>
<dl>
-<dt><i>browser</i></dt>
+<dt><i>browser</i> (ProjectBaseBrowser)</dt>
<dd>
reference to the project browser object
</dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
-<dt><i>isTranslationsBrowser</i></dt>
+<dt><i>isTranslationsBrowser</i> (bool)</dt>
<dd>
flag indicating, the helper is requested
for the translations browser (this needs some special treatment)
@@ -1349,6 +1447,12 @@
the project browser helper object
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+SvnProjectBrowserHelper
+</dd>
+</dl>
<a NAME="Subversion.vcsGetProjectHelper" ID="Subversion.vcsGetProjectHelper"></a>
<h4>Subversion.vcsGetProjectHelper</h4>
<b>vcsGetProjectHelper</b>(<i>project</i>)
@@ -1358,7 +1462,7 @@
</p>
<dl>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
@@ -1369,6 +1473,12 @@
the project helper object
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+PySvnProjectHelper
+</dd>
+</dl>
<a NAME="Subversion.vcsImport" ID="Subversion.vcsImport"></a>
<h4>Subversion.vcsImport</h4>
<b>vcsImport</b>(<i>vcsDataDict, projectDir, noDialog=False, addAll=True</i>)
@@ -1385,7 +1495,7 @@
</dd>
<dt><i>projectDir</i> (str)</dt>
<dd>
-project directory (string)
+project directory
</dd>
<dt><i>noDialog</i> (bool)</dt>
<dd>
@@ -1423,19 +1533,25 @@
</p>
<dl>
-<dt><i>vcsDir</i></dt>
+<dt><i>vcsDir</i> (str)</dt>
<dd>
-name of the VCS directory (string)
+name of the VCS directory
</dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
<dd>
-flag indicating quiet operations (boolean)
+flag indicating quiet operations
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-always TRUE
+always True
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Subversion.vcsInitConfig" ID="Subversion.vcsInitConfig"></a>
@@ -1451,9 +1567,9 @@
</p>
<dl>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
<dd>
-reference to the project (Project)
+reference to the project
</dd>
</dl>
<a NAME="Subversion.vcsLogBrowser" ID="Subversion.vcsLogBrowser"></a>
@@ -1466,13 +1582,13 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-file/directory name to show the log of (string)
+file/directory name to show the log of
</dd>
-<dt><i>isFile</i></dt>
+<dt><i>isFile</i> (bool)</dt>
<dd>
-flag indicating log for a file is to be shown (boolean)
+flag indicating log for a file is to be shown
</dd>
</dl>
<a NAME="Subversion.vcsMerge" ID="Subversion.vcsMerge"></a>
@@ -1484,9 +1600,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-file/directory name to be merged (string)
+file/directory name to be merged
</dd>
</dl>
<a NAME="Subversion.vcsMove" ID="Subversion.vcsMove"></a>
@@ -1498,19 +1614,19 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-file/directory name to be moved (string)
+file/directory name to be moved
</dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
-<dt><i>target</i></dt>
+<dt><i>target</i> (str)</dt>
<dd>
-new name of the file/directory (string)
+new name of the file/directory
</dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
<dd>
flag indicating quiet operations
</dd>
@@ -1518,7 +1634,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating successfull operation (boolean)
+flag indicating successfull operation
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Subversion.vcsName" ID="Subversion.vcsName"></a>
@@ -1531,7 +1653,13 @@
<dl>
<dt>Return:</dt>
<dd>
-always 'Subversion' (string)
+always 'Subversion'
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Subversion.vcsNewProjectOptionsDialog" ID="Subversion.vcsNewProjectOptionsDialog"></a>
@@ -1544,16 +1672,21 @@
</p>
<dl>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
<dd>
-parent widget (QWidget)
+parent widget
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
reference to the instantiated options dialog
- (SvnNewProjectOptionsDialog)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+SvnNewProjectOptionsDialog
</dd>
</dl>
<a NAME="Subversion.vcsOptionsDialog" ID="Subversion.vcsOptionsDialog"></a>
@@ -1565,28 +1698,33 @@
</p>
<dl>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
-<dt><i>archive</i></dt>
+<dt><i>archive</i> (str)</dt>
<dd>
-name of the project in the repository (string)
+name of the project in the repository
</dd>
-<dt><i>editable</i></dt>
+<dt><i>editable</i> (bool)</dt>
<dd>
flag indicating that the project name is editable
- (boolean)
</dd>
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
<dd>
-parent widget (QWidget)
+parent widget
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-reference to the instantiated options dialog (SvnOptionsDialog)
+reference to the instantiated options dialog
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+SvnOptionsDialog
</dd>
</dl>
<a NAME="Subversion.vcsRegisteredState" ID="Subversion.vcsRegisteredState"></a>
@@ -1598,15 +1736,21 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-filename to check (string)
+filename to check
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-a combination of canBeCommited and canBeAdded
+registered state (one of canBeCommited and canBeAdded)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
</dd>
</dl>
<a NAME="Subversion.vcsRemove" ID="Subversion.vcsRemove"></a>
@@ -1622,17 +1766,15 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str or list of str)</dt>
<dd>
-file/directory name to be removed (string or list of
- strings))
+file/directory name to be removed
</dd>
-<dt><i>project</i></dt>
+<dt><i>project</i> (bool)</dt>
<dd>
-flag indicating deletion of a project tree (boolean)
- (not needed)
+flag indicating deletion of a project tree
</dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
<dd>
flag indicating quiet operations
</dd>
@@ -1640,7 +1782,13 @@
<dl>
<dt>Return:</dt>
<dd>
-flag indicating successfull operation (boolean)
+flag indicating successfull operation
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Subversion.vcsRepositoryInfos" ID="Subversion.vcsRepositoryInfos"></a>
@@ -1652,15 +1800,21 @@
</p>
<dl>
-<dt><i>ppath</i></dt>
+<dt><i>ppath</i> (str)</dt>
<dd>
-local path to get the repository infos (string)
+local path to get the repository infos
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-string with ready formated info for display (string)
+string with ready formated info for display
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Subversion.vcsResolved" ID="Subversion.vcsResolved"></a>
@@ -1672,9 +1826,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-file/directory name to be resolved (string)
+file/directory name to be resolved
</dd>
</dl>
<a NAME="Subversion.vcsRevert" ID="Subversion.vcsRevert"></a>
@@ -1714,17 +1868,17 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-file name to be diffed (string)
+file name to be diffed
</dd>
-<dt><i>extended</i></dt>
+<dt><i>extended</i> (bool)</dt>
<dd>
-flag indicating the extended variant (boolean)
+flag indicating the extended variant
</dd>
-<dt><i>revisions</i></dt>
+<dt><i>revisions</i> (tuple of (str, str))</dt>
<dd>
-tuple of two revisions (tuple of strings)
+tuple of two revisions
</dd>
</dl>
<dl>
@@ -1751,10 +1905,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str or list of str)</dt>
<dd>
file/directory name(s) to show the status of
- (string or list of strings)
</dd>
</dl>
<a NAME="Subversion.vcsSwitch" ID="Subversion.vcsSwitch"></a>
@@ -1766,16 +1919,21 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-directory name to be switched (string)
+directory name to be switched
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, that the switch contained an add
- or delete (boolean)
+flag indicating, that the switch contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Subversion.vcsTag" ID="Subversion.vcsTag"></a>
@@ -1788,9 +1946,9 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
<dd>
-file/directory name to be tagged (string)
+file/directory name to be tagged
</dd>
</dl>
<a NAME="Subversion.vcsUpdate" ID="Subversion.vcsUpdate"></a>
@@ -1803,21 +1961,25 @@
</p>
<dl>
-<dt><i>name</i></dt>
+<dt><i>name</i> ((str or list of str)</dt>
<dd>
-file/directory name to be updated (string or list of
- strings)
+file/directory name to be updated
</dd>
-<dt><i>noDialog</i></dt>
+<dt><i>noDialog</i> (bool)</dt>
<dd>
-flag indicating quiet operations (boolean)
+flag indicating quiet operations
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
-flag indicating, that the update contained an add
- or delete (boolean)
+flag indicating, that the update contained an add or delete
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
