--- a/eric6/Documentation/Source/eric6.VCS.__init__.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.VCS.__init__.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,65 +18,83 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.VCS.__init__</h1> + <p> Module implementing the general part of the interface to version control systems. -</p><p> +</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> +</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 /> +<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> +</p> +<dl> + <dt><i>vcs</i></dt> <dd> name of the VCS system to be used (string) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> the instantiated VCS object </dd> </dl> <div align="right"><a href="#top">Up</a></div> -<hr /><hr /> +<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> +</p> +<dl> + <dt><i>project</i></dt> <dd> reference to the project object (Project) </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> reference to the basic VCS project helper singleton