[clang-tools-extra] [Clang-doc] Display values and comments in MD (PR #183754)

[Samrudh Nelli via cfe-commits]

SamrudhNelli wrote:

> I'm not really sure what's going on here. The design seems to change wildly after every set of comments. If you think your design or approach is correct, then please discuss the details with me, but just rewriting the implementation after every round makes review rather challenging.
> 
> In the last round, I noted that you're using a stream, and then creating a string that you then write into another stream. It is far more efficient to just write into the stream directly.
> 
I am really sorry for rewriting the code after basically every review and adding extra review cycles.

I tried to use streams with the current approach as you suggested.
Before any other changes, I would like to know your opinions on the implementation. Would you prefer the current approach that consumes some space for the `ChildBuffer` or the [initial approach](https://github.com/llvm/llvm-project/pull/183754#discussion_r2885434472) that did not need any extra storage but required 3 global boolean pointers for handling the indentation?
Any other approach that can handle this better would be appreciated.

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