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

[Med Ismail Bennani via lldb-commits]

medismailben wrote:

> We definitely need more documentation, but I do sometimes get annoyed by it when it obscures browsing through the source code by stretching out the class definition. If that includes important information about the API, then I think it's worth it, but some of these comments tend to get very... sparse:
> 
> ```
> /// Gets Foo for Bar
> ///
> /// \param [in] bar
> ///   Bar to get the Foo for
> ///
> /// \return
> ///   Foo for bar
> Foo GetFooForBar(Bar bar);
> ```
> 
> Now we eight lines of code for what should really be one or two. Would the documentation look too bad if we dropped the \param and \return thingies when we don't have anything meaningful to say there?

+1, may be getters and setter should be self-documented ?

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