src/eric7/Documentation/Source/eric7.DebugClients.Python.DebugClientBase.html

branch
eric7
changeset 10417
c6011e501282
parent 10321
4a017fdf316f
child 10423
299802979277
diff -r 5d807e997391 -r c6011e501282 src/eric7/Documentation/Source/eric7.DebugClients.Python.DebugClientBase.html
--- a/src/eric7/Documentation/Source/eric7.DebugClients.Python.DebugClientBase.html	Sat Dec 16 17:52:02 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.DebugClients.Python.DebugClientBase.html	Sun Dec 17 17:15:19 2023 +0100
@@ -288,7 +288,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-client capabilities (integer)
+client capabilities
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+int
 </dd>
 </dl>
 <a NAME="DebugClientBase.__compileCommand" ID="DebugClientBase.__compileCommand"></a>
@@ -352,9 +358,9 @@
 </p>
 <dl>
 
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-the text to be completed (string)
+the text to be completed
 </dd>
 </dl>
 <a NAME="DebugClientBase.__dumpVariable" ID="DebugClientBase.__dumpVariable"></a>
@@ -467,12 +473,12 @@
 </p>
 <dl>
 
-<dt><i>scope</i></dt>
+<dt><i>scope</i> (int)</dt>
 <dd>
 1 to generate filter for global variables, 0 for local
-            variables (int)
+            variables
 </dd>
-<dt><i>filterString</i></dt>
+<dt><i>filterString</i> (str)</dt>
 <dd>
 string of filter patterns separated by ';'
 </dd>
@@ -486,17 +492,17 @@
 </p>
 <dl>
 
-<dt><i>text</i></dt>
+<dt><i>text</i> (str)</dt>
 <dd>
-text to complete (string)
+text to complete
 </dd>
-<dt><i>completer</i></dt>
+<dt><i>completer</i> (function)</dt>
 <dd>
 completer method
 </dd>
-<dt><i>completions</i></dt>
+<dt><i>completions</i> (set)</dt>
 <dd>
-set where to add new completions strings (set)
+set where to add new completions strings
 </dd>
 </dl>
 <a NAME="DebugClientBase.__getSysPath" ID="DebugClientBase.__getSysPath"></a>
@@ -509,15 +515,21 @@
 </p>
 <dl>
 
-<dt><i>firstEntry</i></dt>
+<dt><i>firstEntry</i> (str)</dt>
 <dd>
-entry to be put first in sys.path (string)
+entry to be put first in sys.path
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-path list for use as sys.path (list of strings)
+path list for use as sys.path
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="DebugClientBase.__interact" ID="DebugClientBase.__interact"></a>
@@ -543,15 +555,21 @@
 </p>
 <dl>
 
-<dt><i>host</i></dt>
+<dt><i>host</i> (str)</dt>
 <dd>
-hostname of the debug server (string)
+hostname of the debug server
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-IP address (string)
+IP address
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="DebugClientBase.__setCoding" ID="DebugClientBase.__setCoding"></a>
@@ -563,9 +581,9 @@
 </p>
 <dl>
 
-<dt><i>filename</i></dt>
+<dt><i>filename</i> (str)</dt>
 <dd>
-name of the file to inspect (string)
+name of the file to inspect
 </dd>
 </dl>
 <a NAME="DebugClientBase.__signalHandler" ID="DebugClientBase.__signalHandler"></a>
@@ -595,15 +613,15 @@
 </p>
 <dl>
 
-<dt><i>exctype</i></dt>
+<dt><i>exctype</i> (type)</dt>
 <dd>
-the type of the exception
+class of the exception
 </dd>
-<dt><i>excval</i></dt>
+<dt><i>excval</i> (Exception)</dt>
 <dd>
-data about the exception
+exception instance
 </dd>
-<dt><i>exctb</i></dt>
+<dt><i>exctb</i> (traceback)</dt>
 <dd>
 traceback for the exception
 </dd>
@@ -621,15 +639,21 @@
 </p>
 <dl>
 
-<dt><i>fn</i></dt>
+<dt><i>fn</i> (str)</dt>
 <dd>
-filename (string)
+filename
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-the converted filename (string)
+the converted filename
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="DebugClientBase.close" ID="DebugClientBase.close"></a>
@@ -645,9 +669,9 @@
 </p>
 <dl>
 
-<dt><i>fd</i></dt>
+<dt><i>fd</i> (int)</dt>
 <dd>
-file descriptor to be closed (integer)
+file descriptor to be closed
 </dd>
 </dl>
 <a NAME="DebugClientBase.connectDebugger" ID="DebugClientBase.connectDebugger"></a>
@@ -691,10 +715,10 @@
 </p>
 <dl>
 
-<dt><i>disablePolling</i></dt>
+<dt><i>disablePolling</i> (bool)</dt>
 <dd>
 flag indicating to enter an event loop with
-            polling disabled (boolean)
+            polling disabled
 </dd>
 </dl>
 <a NAME="DebugClientBase.eventPoll" ID="DebugClientBase.eventPoll"></a>
@@ -714,7 +738,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-codec name (string)
+codec name
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="DebugClientBase.getRunning" ID="DebugClientBase.getRunning"></a>
@@ -727,7 +757,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating a running debug session (boolean)
+flag indicating a running debug session
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="DebugClientBase.handleJsonCommand" ID="DebugClientBase.handleJsonCommand"></a>
@@ -838,15 +874,15 @@
 </p>
 <dl>
 
-<dt><i>scriptname</i></dt>
+<dt><i>scriptname</i> (str)</dt>
 <dd>
-name of the script to be debugged (string)
+name of the script to be debugged
 </dd>
-<dt><i>func</i></dt>
+<dt><i>func</i> (function)</dt>
 <dd>
 function to be called
 </dd>
-<dt><i>*args</i></dt>
+<dt><i>*args</i> (list)</dt>
 <dd>
 arguments being passed to func
 </dd>
@@ -857,6 +893,12 @@
 result of the function call
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Any
+</dd>
+</dl>
 <a NAME="DebugClientBase.sendCallTrace" ID="DebugClientBase.sendCallTrace"></a>
 <h4>DebugClientBase.sendCallTrace</h4>
 <b>sendCallTrace</b>(<i>event, fromInfo, toInfo</i>)
@@ -896,7 +938,7 @@
 </dd>
 <dt><i>lineno</i> (int)</dt>
 <dd>
-linenumber of the bp
+line number of the bp
 </dd>
 </dl>
 <a NAME="DebugClientBase.sendClearTemporaryWatch" ID="DebugClientBase.sendClearTemporaryWatch"></a>
@@ -1041,9 +1083,9 @@
 </p>
 <dl>
 
-<dt><i>terminate</i></dt>
+<dt><i>terminate</i> (bool)</dt>
 <dd>
-flag indicating to terminate (boolean)
+flag indicating to terminate
 </dd>
 </dl>
 <a NAME="DebugClientBase.setDisassembly" ID="DebugClientBase.setDisassembly"></a>
@@ -1236,9 +1278,9 @@
 </p>
 <dl>
 
-<dt><i>fd</i></dt>
+<dt><i>fd</i> (int)</dt>
 <dd>
-open file descriptor to be closed (integer)
+open file descriptor to be closed
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -1289,9 +1331,9 @@
 </p>
 <dl>
 
-<dt><i>limit</i></dt>
+<dt><i>limit</i> (int)</dt>
 <dd>
-recursion limit (integer)
+recursion limit
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>

eric ide

mercurial