[PATCH] D63666: [clang-doc] Add templates to HTML generator

Julie Hockett via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Fri Jun 21 14:00:55 PDT 2019


juliehockett added inline comments.


================
Comment at: clang-tools-extra/clang-doc/HTMLGenerator.cpp:59
+      Items +=
+          applyHTMLTemplate(HTMLTemplates::BlockItem, M.str().str().c_str());
+    }
----------------
Put `FIXME: Transition Members from llvm::SmallString to std::string` and such on this (and others)


================
Comment at: clang-tools-extra/clang-doc/HTMLTemplates.cpp:163-166
+// - Open command (string), use Name attribute of Info
+// - Content of comment (string), use concatenated return value of genHTML() for
+// each child of Info
+// - Close command (string), use CloseName attribute of Info
----------------
For verbatim, the open/close commands are simply specifiers for where the section starts and stops, and so don't need to be rendered.


================
Comment at: clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp:307-308
+<title></title>
+<div>
+<div>
+<h3>f</h3>
----------------
Emitting an extra div here?


================
Comment at: clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp:313-314
+<div>
+<div>
+<p></p>
+<p> Brief description.</p>
----------------
Emitting extra div/p here? Add a check in the comment generation bit to ensure you're not emitting an empty string for ParagraphComments


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

https://reviews.llvm.org/D63666





More information about the cfe-commits mailing list