diff -r 2f70ca07f0af -r 4cd7e5a8b3cf src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.subversion.html
--- a/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.subversion.html Fri Dec 22 19:45:17 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Plugins.VcsPlugins.vcsSubversion.subversion.html Sat Dec 23 15:40:23 2023 +0100
@@ -350,17 +350,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.__svnGetFileForRevision" ID="Subversion.__svnGetFileForRevision"></a>
@@ -373,19 +373,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>
@@ -397,15 +403,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>
@@ -427,17 +439,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>
@@ -447,6 +459,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</i>)
@@ -466,13 +484,13 @@
</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>
</dl>
<dl>
@@ -482,6 +500,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>)
@@ -502,15 +526,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>
@@ -526,15 +556,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>
@@ -547,12 +583,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>
@@ -560,7 +595,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>
@@ -580,7 +621,13 @@
<dl>
<dt>Return:</dt>
<dd>
-reference to the plugin object (VcsSubversionPlugin)
+reference to the plugin object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+VcsSubversionPlugin
</dd>
</dl>
<a NAME="Subversion.svnAddToChangelist" ID="Subversion.svnAddToChangelist"></a>
@@ -595,10 +642,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>
@@ -610,9 +656,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>
@@ -624,11 +670,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>
@@ -636,7 +682,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>
@@ -648,11 +700,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>
@@ -676,9 +728,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>
@@ -691,7 +743,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>
@@ -704,9 +762,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>
@@ -715,6 +773,12 @@
string with the repository path URL
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
<a NAME="Subversion.svnListProps" ID="Subversion.svnListProps"></a>
<h4>Subversion.svnListProps</h4>
<b>svnListProps</b>(<i>name, recursive=False</i>)
@@ -724,11 +788,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>
@@ -742,14 +806,14 @@
</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)
+ (False = branches, True = tags)
</dd>
</dl>
<a NAME="Subversion.svnLock" ID="Subversion.svnLock"></a>
@@ -761,19 +825,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>
@@ -785,15 +847,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>
@@ -805,9 +873,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>
@@ -822,10 +890,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>
@@ -837,9 +904,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>
@@ -851,11 +918,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>
@@ -869,9 +936,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>
@@ -883,19 +950,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>
@@ -907,9 +972,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>
@@ -931,9 +996,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>
@@ -946,15 +1011,15 @@
</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
</dd>
@@ -969,13 +1034,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>
@@ -1002,10 +1067,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>
@@ -1023,17 +1087,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>
@@ -1043,6 +1107,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>)
@@ -1053,15 +1123,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>
@@ -1069,7 +1139,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>
@@ -1081,9 +1157,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>
@@ -1102,9 +1178,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>
@@ -1117,16 +1193,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>
@@ -1189,9 +1264,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>
@@ -1205,7 +1280,12 @@
<dt>Return:</dt>
<dd>
flag indicating the existance (boolean) and an error message
- (string)
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
</dd>
</dl>
<a NAME="Subversion.vcsExport" ID="Subversion.vcsExport"></a>
@@ -1218,19 +1298,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>
@@ -1261,15 +1347,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)
@@ -1281,6 +1367,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>)
@@ -1290,7 +1382,7 @@
</p>
<dl>
-<dt><i>project</i></dt>
+<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
@@ -1301,6 +1393,12 @@
the project helper object
</dd>
</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+SvnProjectHelper
+</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>)
@@ -1317,7 +1415,7 @@
</dd>
<dt><i>projectDir</i> (str)</dt>
<dd>
-project directory (string)
+project directory
</dd>
<dt><i>noDialog</i> (bool)</dt>
<dd>
@@ -1355,19 +1453,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>
@@ -1382,9 +1486,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>
@@ -1397,13 +1501,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>
@@ -1415,9 +1519,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>
@@ -1429,19 +1533,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>
@@ -1449,7 +1553,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>
@@ -1462,7 +1572,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>
@@ -1475,16 +1591,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>
@@ -1496,28 +1617,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>
@@ -1529,15 +1655,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>
@@ -1553,17 +1685,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>
@@ -1571,7 +1701,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>
@@ -1583,15 +1719,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>
@@ -1603,9 +1745,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>
@@ -1645,17 +1787,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>
@@ -1682,10 +1824,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>
@@ -1697,15 +1838,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 added or changed files (boolean)
+flag indicating added or changed files
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
</dd>
</dl>
<a NAME="Subversion.vcsTag" ID="Subversion.vcsTag"></a>
@@ -1718,9 +1865,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>
@@ -1733,21 +1880,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>
