DebugClients/Python3/DebugClientBase.py

changeset 2953
703452a2876f
parent 2761
bcc10ef7015d
child 2987
c99695c0f13a
diff -r 94fc661a54a2 -r 703452a2876f DebugClients/Python3/DebugClientBase.py
--- a/DebugClients/Python3/DebugClientBase.py	Sat Sep 28 17:40:42 2013 +0200
+++ b/DebugClients/Python3/DebugClientBase.py	Sat Sep 28 19:06:25 2013 +0200
@@ -38,7 +38,9 @@
     
     This function works with the split debugger.
     
-    @param prompt The prompt to be shown. (string)
+    @param prompt prompt to be shown (string)
+    @param echo flag indicating to echo the output (boolean)
+    @return result of the input() call
     """
     if DebugClientInstance is None or not DebugClientInstance.redirect:
         return DebugClientOrigInput(prompt)
@@ -60,6 +62,8 @@
 def DebugClientFork():
     """
     Replacement for the standard os.fork().
+    
+    @return result of the fork() call
     """
     if DebugClientInstance is None:
         return DebugClientOrigFork()
@@ -264,7 +268,6 @@
         @param kwargs keyword arguments to pass to target
         @param mainThread True, if we are attaching to the already
               started mainthread of the app
-        @return The identifier of the created thread
         """
         if self.debugging:
             sys.setprofile(self.profile)
@@ -308,7 +311,7 @@
 
     def __exceptionRaised(self):
         """
-        Private method called in the case of an exception
+        Private method called in the case of an exception.
         
         It ensures that the debug server is informed of the raised exception.
         """
@@ -1213,6 +1216,8 @@
     def getRunning(self):
         """
         Public method to return the main script we are currently running.
+        
+        @return flag indicating a running debug session (boolean)
         """
         return self.running
 
@@ -2065,7 +2070,10 @@
         
     def fork(self):
         """
-        Public method implementing a fork routine deciding which branch to follow.
+        Public method implementing a fork routine deciding which branch
+        to follow.
+        
+        @return process ID (integer)
         """
         if not self.fork_auto:
             self.write(DebugProtocol.RequestForkTo + '\n')

eric ide

mercurial