[PATCH] D136894: Add clang-doc readme

[Paul Kirth via Phabricator via cfe-commits]

paulkirth added a comment.

In D136894#3905638 <https://reviews.llvm.org/D136894#3905638>, @brettw wrote:

> I definitely wasn't intending to write "formal documentation" for clang-doc. I was trying to write some notes for a future contributor as I'm winding down my work here, and it seems nobody else is working on it or has any knowledge about it. Is there a place in LLVM for this type of documentation?

Most of LLVM's documentation is either in the formal documentation. Many things are also only documented in the code, though. We're trying to be better about that these days, but manyt things are only described in the comments of a particular `.cpp` file.

> I can rename the file to "notes" or something if you think that would help make things more clear.

I can't think of anything like that elsewhere in our code base. If you don't want formal documentation, you can take the parts you think are appropriate and add them as comments to the relevant files. For things you think should be changed, an issue on github is probably the best way to make sure that gets addressed, and reference that somewhere in clang-doc's code.


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D136894/new/

https://reviews.llvm.org/D136894