commit 67292896973deffdd8061abb801f50e58576e060
author Shafik Yaghmour <syaghmour@apple.com> Fri Apr 09 12:05:36 2021 -0700
committer Copybara-Service <copybara-worker@google.com> Mon Apr 12 11:43:54 2021 -0700
tree f29c7b10540e56d8e54b531cf02ec3a40911ea02
parent 53820163a29363bc4fa95160094859285005a240

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

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

GitOrigin-RevId: d9c9c0b2db0dc4ddf407edcafba0a5a806850ddc

include/lldb/DataFormatters/FormattersHelpers.h

diff --git a/include/lldb/DataFormatters/FormattersHelpers.h b/include/lldb/DataFormatters/FormattersHelpers.h
index a5b0da5..8928070 100644
--- a/include/lldb/DataFormatters/FormattersHelpers.h
+++ b/include/lldb/DataFormatters/FormattersHelpers.h
@@ -36,11 +36,13 @@
                        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,