[Lldb-commits] [lldb] 394e52a - [lldb] NFC reflow comments in WatchpointLocations

[Jason Molenda via lldb-commits]

Author: Jason Molenda
Date: 2023-08-30T17:58:44-07:00
New Revision: 394e52a0bb576508e0fed59ab267e75cf1350fca

URL: https://github.com/llvm/llvm-project/commit/394e52a0bb576508e0fed59ab267e75cf1350fca
DIFF: https://github.com/llvm/llvm-project/commit/394e52a0bb576508e0fed59ab267e75cf1350fca.diff

LOG: [lldb] NFC reflow comments in WatchpointLocations

Reading through this header, many of the comment
line breaks are a mess after various code reformats.

Added: 
    

Modified: 
    lldb/include/lldb/Breakpoint/WatchpointOptions.h

Removed: 
    


################################################################################
diff  --git a/lldb/include/lldb/Breakpoint/WatchpointOptions.h b/lldb/include/lldb/Breakpoint/WatchpointOptions.h
index 369120e985342b..cedd1b186d659a 100644
--- a/lldb/include/lldb/Breakpoint/WatchpointOptions.h
+++ b/lldb/include/lldb/Breakpoint/WatchpointOptions.h
@@ -59,24 +59,20 @@ class WatchpointOptions {
   // synchronous callbacks: 1) They should NOT resume the target themselves.
   // Just return false if you want the target to restart. 2) Watchpoints with
   // synchronous callbacks can't have conditions (or rather, they can have
-  // them, but they
-  //    won't do anything.  Ditto with ignore counts, etc...  You are supposed
-  //    to control that all through the
-  //    callback.
+  // them, but they won't do anything.  Ditto with ignore counts, etc...
+  // You are supposed to control that all through the callback.
   // Asynchronous callbacks get run as part of the "ShouldStop" logic in the
   // thread plan.  The logic there is:
   //   a) If the watchpoint is thread specific and not for this thread, continue
-  //   w/o running the callback.
+  //      w/o running the callback.
   //   b) If the ignore count says we shouldn't stop, then ditto.
   //   c) If the condition says we shouldn't stop, then ditto.
   //   d) Otherwise, the callback will get run, and if it returns true we will
-  //   stop, and if false we won't.
+  //      stop, and if false we won't.
   //  The asynchronous callback can run the target itself, but at present that
-  //  should be the last action the
-  //  callback does.  We will relax this condition at some point, but it will
-  //  take a bit of plumbing to get
+  //  should be the last action the callback does.  We will relax this
+  //  condition at some point, but it will take a bit of plumbing to get
   //  that to work.
-  //
 
   /// Adds a callback to the watchpoint option set.
   ///
@@ -87,8 +83,8 @@ class WatchpointOptions {
   ///    A baton which will get passed back to the callback when it is invoked.
   ///
   /// \param[in] synchronous
-  ///    Whether this is a synchronous or asynchronous callback.  See discussion
-  ///    above.
+  ///    Whether this is a synchronous or asynchronous callback.
+  ///    See discussion above.
   void SetCallback(WatchpointHitCallback callback,
                    const lldb::BatonSP &baton_sp, bool synchronous = false);
 
@@ -102,11 +98,9 @@ class WatchpointOptions {
   ///
   /// \param[in] context
   ///    The context in which the callback is to be invoked.  This includes the
-  ///    stop event, the
-  ///    execution context of the stop (since you might hit the same watchpoint
-  ///    on multiple threads) and
-  ///    whether we are currently executing synchronous or asynchronous
-  ///    callbacks.
+  ///    stop event, the execution context of the stop (since you might hit
+  ///    the same watchpoint on multiple threads) and whether we are currently
+  ///    executing synchronous or asynchronous callbacks.
   ///
   /// \param[in] watch_id
   ///    The watchpoint ID that owns this option set.
@@ -129,23 +123,24 @@ class WatchpointOptions {
   ///     The baton.
   Baton *GetBaton();
 
-  /// Fetch  a const version of the baton from the callback.
+  /// Fetch a const version of the baton from the callback.
   ///
   /// \return
   ///     The baton.
   const Baton *GetBaton() const;
 
   /// Return the current thread spec for this option. This will return nullptr
-  /// if the no thread specifications have been set for this Option yet.
+  /// if the no thread specifications have been set for this WatchpointOptions
+  /// yet.
+  ///
   /// \return
   ///     The thread specification pointer for this option, or nullptr if none
-  ///     has
-  ///     been set yet.
+  ///     has been set yet.
   const ThreadSpec *GetThreadSpecNoCreate() const;
 
-  /// Returns a pointer to the ThreadSpec for this option, creating it. if it
-  /// hasn't been created already.   This API is used for setting the
-  /// ThreadSpec items for this option.
+  /// Returns a pointer to the ThreadSpec for this option, creating it if it
+  /// hasn't been created already. This API is used for setting the
+  /// ThreadSpec items for this WatchpointOptions.
   ThreadSpec *GetThreadSpec();
 
   void SetThreadID(lldb::tid_t thread_id);
@@ -184,11 +179,7 @@ class WatchpointOptions {
                         unsigned indentation) const override;
   };
 
-protected:
-  // Classes that inherit from WatchpointOptions can see and modify these
-
 private:
-  // For WatchpointOptions only
   WatchpointHitCallback m_callback;  // This is the callback function pointer
   lldb::BatonSP m_callback_baton_sp; // This is the client data for the callback
   bool m_callback_is_synchronous = false;