[Lldb-commits] [lldb] r126868 - /lldb/trunk/include/lldb/Target/Process.h

[Jim Ingham]

Author: jingham
Date: Wed Mar  2 13:58:15 2011
New Revision: 126868

URL: http://llvm.org/viewvc/llvm-project?rev=126868&view=rev
Log:
Add some function docs.

Modified:
    lldb/trunk/include/lldb/Target/Process.h

Modified: lldb/trunk/include/lldb/Target/Process.h
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/include/lldb/Target/Process.h?rev=126868&r1=126867&r2=126868&view=diff
==============================================================================
--- lldb/trunk/include/lldb/Target/Process.h (original)
+++ lldb/trunk/include/lldb/Target/Process.h Wed Mar  2 13:58:15 2011
@@ -1790,12 +1790,30 @@
         m_dynamic_checkers_ap.reset(dynamic_checkers);
     }
 
+    //------------------------------------------------------------------
+    /// Call this to set the lldb in the mode where it breaks on new thread
+    /// creations, and then auto-restarts.  This is useful when you are trying
+    /// to run only one thread, but either that thread or the kernel is creating
+    /// new threads in the process.  If you stop when the thread is created, you
+    /// can immediately suspend it, and keep executing only the one thread you intend.
+    ///
+    /// @return
+    ///     Returns \b true if we were able to start up the notification
+    ///     \b false otherwise.
+    //------------------------------------------------------------------
     virtual bool
     StartNoticingNewThreads()
     {   
         return true;
     }
     
+    //------------------------------------------------------------------
+    /// Call this to turn off the stop & notice new threads mode.
+    ///
+    /// @return
+    ///     Returns \b true if we were able to start up the notification
+    ///     \b false otherwise.
+    //------------------------------------------------------------------
     virtual bool
     StopNoticingNewThreads()
     {