Skip to content

Commit

Permalink
Fix comments in ValueObjectPrinter.h (NFC)
Browse files Browse the repository at this point in the history
  • Loading branch information
adrian-prantl committed Jun 17, 2024
1 parent ca1a963 commit 6c17f1c
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions lldb/include/lldb/DataFormatters/ValueObjectPrinter.h
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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);

Expand All @@ -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,
Expand All @@ -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
Expand Down Expand Up @@ -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;
Expand Down

0 comments on commit 6c17f1c

Please sign in to comment.