src/eric7/Documentation/Source/eric7.VCS.__init__.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10436
f6881d10e995
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.VCS.__init__.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,92 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.VCS.__init__</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.VCS.__init__</h1>
+
+<p>
+Module implementing the general part of the interface to version control
+systems.
+</p>
+<p>
+The general part of the VCS interface defines classes to implement common
+dialogs. These are a dialog to enter command options, a dialog to display
+some repository information and an abstract base class. The individual
+interfaces have to be subclasses of this base class.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>VcsBasicHelperSingleton</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+
+<tr>
+<td><a href="#factory">factory</a></td>
+<td>Modul factory function to generate the right vcs object.</td>
+</tr>
+<tr>
+<td><a href="#getBasicHelper">getBasicHelper</a></td>
+<td>Module function to get a reference to the basic project helper singleton.</td>
+</tr>
+</table>
+<hr />
+<hr />
+<a NAME="factory" ID="factory"></a>
+<h2>factory</h2>
+<b>factory</b>(<i>vcs</i>)
+
+<p>
+    Modul factory function to generate the right vcs object.
+</p>
+<dl>
+
+<dt><i>vcs</i></dt>
+<dd>
+name of the VCS system to be used (string)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+the instantiated VCS object
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+<hr />
+<a NAME="getBasicHelper" ID="getBasicHelper"></a>
+<h2>getBasicHelper</h2>
+<b>getBasicHelper</b>(<i>project</i>)
+
+<p>
+    Module function to get a reference to the basic project helper singleton.
+</p>
+<dl>
+
+<dt><i>project</i></dt>
+<dd>
+reference to the project object (Project)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the basic VCS project helper singleton
+        (VcsProjectHelper)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial