sammccall added a comment.

Hey, apologies for missing the initial patch in D119479 
<https://reviews.llvm.org/D119479>.

This sounds really interesting!
The lack of docs make it very difficult to understand what this library is for 
and how to use it if you don't already know.
It's not clear what the SymbolGraph library is (I think there's a doc missing 
from the directory). The patches are tagged with [extract-api] so it must be 
related, but if it's something distinct it should be documented and reusable, 
and if it's the same why is it not called ExtractAPI :-)

The main entry point seems to be API.h, which has only a trivial file comment 
and no comments on what the meaning of the structs and fields are. Especially 
if this is part of clang proper, it's going to be read and maintained and 
debugged by a lot of people who have never heard of SymbolGraph and don't know 
swift.

It's also not clear from looking at this why this is part of clang itself and 
not a libTooling-style external tool - it seems similar in scope and 
applicability to a lot of the things in clang-tools-extra.

I know a lot of these things don't feel like they need much explanation when 
you're and your reviewer are familiar with it, so apologies that this is 
tedious, but the cost of undocumented code like this in shared projects is high.


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D121873

_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

Reply via email to