[Lldb-commits] [lldb] d9c9c0b - [LLDB][NFC] Add clarifying comments for AddCXXSummary and AddCXXSynthetic

[Shafik Yaghmour via lldb-commits]

Author: Shafik Yaghmour
Date: 2021-04-09T12:07:24-07:00
New Revision: d9c9c0b2db0dc4ddf407edcafba0a5a806850ddc

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

LOG: [LLDB][NFC] Add clarifying comments for AddCXXSummary and AddCXXSynthetic

Adding comments to AddCXXSynthetic and AddCXXSummary to better explain what they are doing.

Added: 
    

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

Removed: 
    


################################################################################
diff  --git a/lldb/include/lldb/DataFormatters/FormattersHelpers.h b/lldb/include/lldb/DataFormatters/FormattersHelpers.h
index a5b0da57e5d8b..892807063b9ce 100644
--- a/lldb/include/lldb/DataFormatters/FormattersHelpers.h
+++ b/lldb/include/lldb/DataFormatters/FormattersHelpers.h
@@ -36,11 +36,13 @@ void AddOneLineSummary(TypeCategoryImpl::SharedPointer category_sp,
                        ConstString type_name, TypeSummaryImpl::Flags flags,
                        bool regex = false);
 
+/// Add a summary that is implemented by a C++ callback.
 void AddCXXSummary(TypeCategoryImpl::SharedPointer category_sp,
                    CXXFunctionSummaryFormat::Callback funct,
                    const char *description, ConstString type_name,
                    TypeSummaryImpl::Flags flags, bool regex = false);
 
+/// Add a synthetic that is implemented by a C++ callback.
 void AddCXXSynthetic(TypeCategoryImpl::SharedPointer category_sp,
                      CXXSyntheticChildren::CreateFrontEndCallback generator,
                      const char *description, ConstString type_name,