paulkirth added a comment.

Overall I like the direction of the patch, I know this is WIP, but I've left 
some small question inline regarding scope and work tracking.



================
Comment at: clang-tools-extra/clang-doc/MDGenerator.cpp:23-52
+static std::string genEscaped(StringRef Name) {
+  std::string Buffer;
+  llvm::raw_string_ostream Stream(Buffer);
+  for (unsigned I = 0, E = Name.size(); I != E; ++I) {
+    unsigned char C = Name[I];
+    switch (C) {
+      case '\\':
----------------
This isn't something I expect to get addressed in this patch, but I feel like 
I've seen this same pattern of escaping characters repeated throughout the 
codebase. Maybe we should add a TODO regarding it? I'm also fine with ignoring 
this.


================
Comment at: clang-tools-extra/clang-doc/MDGenerator.cpp:110-113
+    // TODO: @return is a block command and should be included in the 
"Returns" table.
+    // TODO: @see block commands should be grouped and rendered as "See Also" 
section.
+    // TODO: Figure out handling for @brief.
+    // TODO: What other block commands need special handling?
----------------
Are these TODOs (and the others throughout the patch) something you plan to 
address in this patch before landing? or are they future improvements? If the 
latter, maybe we should file an issue on github reference it here?


Repository:
  rG LLVM Github Monorepo

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

https://reviews.llvm.org/D130231

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

Reply via email to