[Lldb-commits] [lldb] 6c17f1c - Fix comments in ValueObjectPrinter.h (NFC)

[Adrian Prantl via lldb-commits]

Author: Adrian Prantl
Date: 2024-06-17T15:11:33-07:00
New Revision: 6c17f1cabdee3399feceb478921a8369bde18b16

URL: https://github.com/llvm/llvm-project/commit/6c17f1cabdee3399feceb478921a8369bde18b16
DIFF: https://github.com/llvm/llvm-project/commit/6c17f1cabdee3399feceb478921a8369bde18b16.diff

LOG: Fix comments in ValueObjectPrinter.h (NFC)

Added: 
    

Modified: 
    lldb/include/lldb/DataFormatters/ValueObjectPrinter.h

Removed: 
    


################################################################################
diff  --git a/lldb/include/lldb/DataFormatters/ValueObjectPrinter.h b/lldb/include/lldb/DataFormatters/ValueObjectPrinter.h
index 32b101a2f9843..fb5d60ba30d77 100644
--- a/lldb/include/lldb/DataFormatters/ValueObjectPrinter.h
+++ b/lldb/include/lldb/DataFormatters/ValueObjectPrinter.h
@@ -1,5 +1,4 @@
-//===-- ValueObjectPrinter.h ---------------------------------------*- C++
-//-*-===//
+//===-- ValueObjectPrinter.h ------------------------------------*- C++ -*-===//
 //
 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
 // See https://llvm.org/LICENSE.txt for license information.
@@ -25,7 +24,7 @@ class ValueObjectPrinter {
   /// does not retain the ValueObject it is printing, that is the job of
   /// its caller.  It also doesn't attempt to track changes in the
   /// ValueObject, e.g. changing synthetic child providers or changing
-  /// dynamic vrs. static vrs. synthetic settings.
+  /// dynamic versus static versus synthetic settings.
 public:
   ValueObjectPrinter(ValueObject &valobj, Stream *s);
 
@@ -42,16 +41,16 @@ class ValueObjectPrinter {
 
   InstancePointersSetSP m_printed_instance_pointers;
 
-  // only this class (and subclasses, if any) should ever be concerned with the
-  // depth mechanism
+  /// Only this class (and subclasses, if any) should ever be
+  /// concerned with the depth mechanism.
   ValueObjectPrinter(ValueObject &valobj, Stream *s,
                      const DumpValueObjectOptions &options,
                      const DumpValueObjectOptions::PointerDepth &ptr_depth,
                      uint32_t curr_depth,
                      InstancePointersSetSP printed_instance_pointers);
 
-  // we should actually be using delegating constructors here but some versions
-  // of GCC still have trouble with those
+  /// Ee should actually be using delegating constructors here but
+  /// some versions of GCC still have trouble with those.
   void Init(ValueObject &valobj, Stream *s,
             const DumpValueObjectOptions &options,
             const DumpValueObjectOptions::PointerDepth &ptr_depth,
@@ -67,7 +66,7 @@ class ValueObjectPrinter {
   /// use dynamic and use synthetic settings of the ValueObject being printed,
   /// so changes made to these settings won't affect already made
   /// ValueObjectPrinters. SetupMostSpecializedValue();
-
+  ///
   /// Access the cached "most specialized value" - that is the one to use for
   /// printing the value object's value.  However, be sure to use
   /// GetValueForChildGeneration when you are generating the children of this
@@ -143,9 +142,9 @@ class ValueObjectPrinter {
   bool ShouldShowName() const;
 
   ValueObject &m_orig_valobj;
-  ValueObject *m_cached_valobj; /// Cache the current "most specialized" value.
-                                /// Don't use this directly, use
-                                /// GetMostSpecializedValue.
+  /// Cache the current "most specialized" value.  Don't use this
+  /// directly, use GetMostSpecializedValue.
+  ValueObject *m_cached_valobj;
   Stream *m_stream;
   DumpValueObjectOptions m_options;
   Flags m_type_flags;