[Lldb-commits] [lldb] [lldb] Document the SBDebugger public interface (PR #147621)

[Pavel Labath via lldb-commits]

================
@@ -106,44 +124,122 @@ class LLDB_API SBDebugger {
                                           bool &is_debugger_specific);
 #endif
 
+  /// Get structured progress data from an event.
+  ///
+  /// \param [in] event
+  ///   The event to extract the progress information from.
+  ///
+  /// \return
+  ///   A structured data object containing progress information, or an invalid
+  ///   SBStructuredData if the event was not a progress event.
   static lldb::SBStructuredData
   GetProgressDataFromEvent(const lldb::SBEvent &event);
 
+  /// Get diagnostic information from an event.
+  ///
+  /// \param [in] event
+  ///   The event to extract the diagnostic information from.
+  ///
+  /// \return
+  ///   A structured data object containing diagnostic information, or an
+  ///   invalid SBStructuredData if the event was not a diagnostic event.
   static lldb::SBStructuredData
   GetDiagnosticFromEvent(const lldb::SBEvent &event);
 
+  /// Assignment operator.
   lldb::SBDebugger &operator=(const lldb::SBDebugger &rhs);
 
+  /// Initialize LLDB and its subsystems.
+  ///
+  /// This function should be called before any other LLDB functions. It
+  /// initializes all required subsystems for proper LLDB functionality.
   static void Initialize();
----------------
labath wrote:

I think that, at least in theory, socket subsystem initialization can fail (on windows).

https://github.com/llvm/llvm-project/pull/147621