Mercurial Repositories > eric / file diff

--- a/src/eric7/Documentation/Source/eric7.Debugger.DebugServer.html	Fri Jun 14 11:18:10 2024 +0200
+++ b/src/eric7/Documentation/Source/eric7.Debugger.DebugServer.html	Fri Jun 14 11:23:45 2024 +0200
@@ -364,6 +364,10 @@
 <td>Public method to return the IDs of the connected debugger backends.</td>
 </tr>
 <tr>
+<td><a href="#DebugServer.getEricServerEnvironmentString">getEricServerEnvironmentString</a></td>
+<td>Public method to get the string for an eric-ide server environment.</td>
+</tr>
+<tr>
 <td><a href="#DebugServer.getExtensions">getExtensions</a></td>
 <td>Public slot to get the extensions associated with the given language.</td>
 </tr>
@@ -389,7 +393,7 @@
 </tr>
 <tr>
 <td><a href="#DebugServer.isClientProcessUp">isClientProcessUp</a></td>
-<td>Public method to check, if the debug client process is up.</td>
+<td>Public method to check, if the debug client process is up or we are doing debugging via the eric-ide server.</td>
 </tr>
 <tr>
 <td><a href="#DebugServer.isConnected">isConnected</a></td>
@@ -1321,6 +1325,25 @@
 list of str
 </dd>
 </dl>
+<a NAME="DebugServer.getEricServerEnvironmentString" ID="DebugServer.getEricServerEnvironmentString"></a>
+<h4>DebugServer.getEricServerEnvironmentString</h4>
+<b>getEricServerEnvironmentString</b>(<i></i>)
+<p>
+        Public method to get the string for an eric-ide server environment.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+string for the eric-ide server environment
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
+</dd>
+</dl>
 <a NAME="DebugServer.getExtensions" ID="DebugServer.getExtensions"></a>
 <h4>DebugServer.getExtensions</h4>
 <b>getExtensions</b>(<i>language</i>)
@@ -1457,7 +1480,8 @@
 <h4>DebugServer.isClientProcessUp</h4>
 <b>isClientProcessUp</b>(<i></i>)
 <p>
-        Public method to check, if the debug client process is up.
+        Public method to check, if the debug client process is up or we are
+        doing debugging via the eric-ide server.
 </p>
 
 <dl>
@@ -2820,42 +2844,47 @@
 
 <a NAME="DebugServer.startClient" ID="DebugServer.startClient"></a>
 <h4>DebugServer.startClient</h4>
-<b>startClient</b>(<i>unplanned=True, clType=None, forProject=False, runInConsole=False, venvName="", workingDir=None, configOverride=None, </i>)
+<b>startClient</b>(<i>unplanned=True, clType=None, forProject=False, runInConsole=False, venvName="", workingDir="", configOverride=None, startRemote=None, </i>)
 <p>
         Public method to start a debug client.
 </p>
 
 <dl>
 
-<dt><i>unplanned</i> (bool)</dt>
+<dt><i>unplanned</i> (bool (optional))</dt>
 <dd>
-flag indicating that the client has died
+flag indicating that the client has died (defaults to True)
 </dd>
-<dt><i>clType</i> (str)</dt>
+<dt><i>clType</i> (str (optional))</dt>
 <dd>
-type of client to be started
+type of client to be started (defaults to None)
 </dd>
-<dt><i>forProject</i> (bool)</dt>
+<dt><i>forProject</i> (bool (optional))</dt>
 <dd>
-flag indicating a project related action
+flag indicating a project related action (defaults to False)
 </dd>
-<dt><i>runInConsole</i> (bool)</dt>
+<dt><i>runInConsole</i> (bool (optional))</dt>
 <dd>
 flag indicating to start the debugger in a
-            console window
+            console window (defaults to False)
 </dd>
-<dt><i>venvName</i> (str)</dt>
+<dt><i>venvName</i> (str (optional))</dt>
 <dd>
-name of the virtual environment to be used
+name of the virtual environment to be used (defaults to "")
+</dd>
+<dt><i>workingDir</i> (str (optional))</dt>
+<dd>
+directory to start the debugger client in (defaults to "")
 </dd>
-<dt><i>workingDir</i> (str)</dt>
+<dt><i>configOverride</i> (dict (optional))</dt>
 <dd>
-directory to start the debugger client in
+dictionary containing the global config override data
+            (defaults to None)
 </dd>
-<dt><i>configOverride</i> (dict)</dt>
+<dt><i>startRemote</i> (bool (optional))</dt>
 <dd>
-dictionary containing the global config override
-            data
+flag indicating to start the client via an eric-ide server
+            (defaults to None)
 </dd>
 </dl>
 <a NAME="DebugServer.unregisterDebuggerInterface" ID="DebugServer.unregisterDebuggerInterface"></a>