add documentation

Author: charles-zablit

lldb/source/Core/Mangled.cpp

@@ -164,7 +164,7 @@ static ConstString GetSwiftDemangledStr(ConstString m_mangled,
       std::max(info.BasenameRange.second, info.ArgumentsRange.second);
   info.SuffixRange.second = demangled.length();
 
-  // Don't cache the demangled name the function isn't available yet.
+  // Don't cache the demangled name if the function isn't available yet.
   if (!sc || !sc->function) {
     LLDB_LOGF(log, "demangle swift: %s -> \"%s\" (not cached)", mangled_name,
               demangled.c_str());

lldb/source/Plugins/Language/Swift/SwiftMangled.h

@@ -18,6 +18,11 @@
 
 using namespace swift::Demangle;
 
+/// A NodePrinter class with range tracking capabilities.
+///
+/// When used instead of a regular NodePrinter, this class will store additional
+/// range information of the demangled name in the `info` attribute, such as the
+/// range of the name of a method.
 class TrackingNodePrinter : public NodePrinter {
 public:
   TrackingNodePrinter(DemangleOptions options) : NodePrinter(options) {}

lldb/source/Plugins/LanguageRuntime/Swift/SwiftLanguageRuntime.h

@@ -201,13 +201,29 @@ class SwiftLanguageRuntime : public LanguageRuntime {
 
   enum DemangleMode { eSimplified, eTypeName, eDisplayTypeName };
 
+  /// Demangle a symbol to a string.
+  ///
+  /// \param symbol The mangled symbol to demangle.
+  /// \param mode The `DemangleMode` to use when demangling.
+  /// \param sc The associated `SymbolContext`.
+  /// \param exe_ctx The associated `ExecutionContext`.
+  ///
+  /// \return The demangled symbol.
   static std::string
   DemangleSymbolAsString(llvm::StringRef symbol, DemangleMode mode,
                          const SymbolContext *sc = nullptr,
                          const ExecutionContext *exe_ctx = nullptr);
 
   static std::string GetParentNameIfClosure(Function &func);
 
+  /// Demangle a symbol to a string with additional range information.
+  ///
+  /// \param symbol The mangled symbol to demangle.
+  /// \param mode The `DemangleMode` to use when demangling.
+  /// \param sc The associated `SymbolContext`.
+  /// \param exe_ctx The associated `ExecutionContext`.
+  ///
+  /// \return The demangled symbol as well as range tracking information.
   static std::pair<std::string, DemangledNameInfo>
   TrackedDemangleSymbolAsString(llvm::StringRef symbol, DemangleMode mode,
                                 const SymbolContext *sc = nullptr,