attach javadoc to Info

cppalliance · Apr 16, 2023 · 95c8da3 · 95c8da3
1 parent a6ac939
commit 95c8da3
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 31 deletions.
diff --git a/source/lib/ast/CommentVisitor.hpp b/source/lib/ast/CommentVisitor.hpp
@@ -33,7 +33,7 @@ parseComment(
 */
 Javadoc
 parseJavadoc(
-    RawComment const& RC,
+    RawComment const* RC,
     ASTContext const& Ctx,
     Decl const* D);
 

diff --git a/source/lib/ast/FrontendAction.cpp b/source/lib/ast/FrontendAction.cpp
@@ -192,7 +192,8 @@ mapDecl(T const* D)
 
     // VFALCO is this right?
     bool const IsFileInRootDir = true;
-    auto I = preEmitInfo(
+
+    auto I = buildInfoPair(
         D,
         getComment(D, D->getASTContext()),
         getLine(D, D->getASTContext()),

diff --git a/source/lib/ast/ParseJavadoc.cpp b/source/lib/ast/ParseJavadoc.cpp
@@ -118,10 +118,10 @@ class JavadocVisitor
 
 public:
     JavadocVisitor(
-        RawComment const& RC,
+        RawComment const* RC,
         ASTContext const& ctx,
         Decl const* D)
-        : FC_(RC.parse(ctx, nullptr, D))
+        : FC_(RC->parse(ctx, nullptr, D))
         , ctx_(ctx)
     {
     }
@@ -661,7 +661,7 @@ dumpJavadoc(
 
 Javadoc
 parseJavadoc(
-    RawComment const& RC,
+    RawComment const* RC,
     ASTContext const& Ctx,
     Decl const* D)
 {

diff --git a/source/lib/ast/Serialize.cpp b/source/lib/ast/Serialize.cpp
@@ -20,11 +20,11 @@
 #include <llvm/Support/Path.h>
 #include <llvm/Support/SHA1.h>
 
-using clang::comments::FullComment;
-
 namespace clang {
 namespace mrdox {
 
+using clang::comments::FullComment;
+
 SymbolID hashUSR(llvm::StringRef USR) {
     return llvm::SHA1::hash(arrayRefFromStringRef(USR));
 }
@@ -699,8 +699,9 @@ parseBases(
 std::pair<
     std::unique_ptr<Info>,
     std::unique_ptr<Info>>
-emitInfo(
+buildInfo(
     NamespaceDecl const* D,
+    Javadoc jd,
     FullComment const* FC,
     int LineNumber,
     llvm::StringRef File,
@@ -728,8 +729,9 @@ emitInfo(
 std::pair<
     std::unique_ptr<Info>,
     std::unique_ptr<Info>>
-emitInfo(
+buildInfo(
     RecordDecl const* D,
+    Javadoc jd,
     FullComment const* FC,
     int LineNumber,
     llvm::StringRef File,
@@ -817,8 +819,9 @@ emitInfo(
 std::pair<
     std::unique_ptr<Info>,
     std::unique_ptr<Info>>
-emitInfo(
+buildInfo(
     FunctionDecl const* D,
+    Javadoc jd,
     FullComment const* FC,
     int LineNumber,
     llvm::StringRef File,
@@ -843,8 +846,9 @@ emitInfo(
 std::pair<
     std::unique_ptr<Info>,
     std::unique_ptr<Info>>
-emitInfo(
+buildInfo(
     CXXMethodDecl const* D,
+    Javadoc jd,
     FullComment const* FC,
     int LineNumber,
     llvm::StringRef File,
@@ -882,8 +886,9 @@ emitInfo(
 std::pair<
     std::unique_ptr<Info>,
     std::unique_ptr<Info>>
-emitInfo(
+buildInfo(
     TypedefDecl const* D,
+    Javadoc jd,
     FullComment const* FC,
     int LineNumber,
     StringRef File,
@@ -921,8 +926,9 @@ emitInfo(
 std::pair<
     std::unique_ptr<Info>,
     std::unique_ptr<Info>>
-emitInfo(
+buildInfo(
     TypeAliasDecl const* D,
+    Javadoc jd,
     FullComment const* FC,
     int LineNumber,
     StringRef File,
@@ -948,8 +954,9 @@ emitInfo(
 std::pair<
     std::unique_ptr<Info>,
     std::unique_ptr<Info>>
-emitInfo(
+buildInfo(
     EnumDecl const* D,
+    Javadoc jd,
     FullComment const* FC,
     int LineNumber,
     llvm::StringRef File,

diff --git a/source/lib/ast/Serialize.hpp b/source/lib/ast/Serialize.hpp
@@ -39,50 +39,54 @@ namespace mrdox {
 // its parent scope. For NamespaceDecl and RecordDecl both elements are not
 // nullptr.
 std::pair<std::unique_ptr<Info>, std::unique_ptr<Info>>
-emitInfo(const NamespaceDecl *D, const comments::FullComment *FC, int LineNumber,
+buildInfo(NamespaceDecl const* D, Javadoc jd, comments::FullComment const* FC, int LineNumber,
          StringRef File, bool IsFileInRootDir, bool PublicOnly, Reporter& R);
 
 std::pair<std::unique_ptr<Info>, std::unique_ptr<Info>>
-emitInfo(const RecordDecl *D, const comments::FullComment *FC, int LineNumber,
+buildInfo(RecordDecl const* D, Javadoc jd, comments::FullComment const* FC, int LineNumber,
          StringRef File, bool IsFileInRootDir, bool PublicOnly, Reporter& R);
 
 std::pair<std::unique_ptr<Info>, std::unique_ptr<Info>>
-emitInfo(const EnumDecl *D, const comments::FullComment *FC, int LineNumber,
+buildInfo(EnumDecl const* D, Javadoc jd, comments::FullComment const* FC, int LineNumber,
          StringRef File, bool IsFileInRootDir, bool PublicOnly, Reporter& R);
 
 std::pair<std::unique_ptr<Info>, std::unique_ptr<Info>>
-emitInfo(const FunctionDecl *D, const comments::FullComment *FC, int LineNumber,
+buildInfo(FunctionDecl const* D, Javadoc jd, comments::FullComment const* FC, int LineNumber,
          StringRef File, bool IsFileInRootDir, bool PublicOnly, Reporter& R);
 
 std::pair<std::unique_ptr<Info>, std::unique_ptr<Info>>
-emitInfo(const CXXMethodDecl *D, const comments::FullComment *FC, int LineNumber,
+buildInfo(CXXMethodDecl const* D, Javadoc jd, comments::FullComment const* FC, int LineNumber,
          StringRef File, bool IsFileInRootDir, bool PublicOnly, Reporter& R);
 
 std::pair<std::unique_ptr<Info>, std::unique_ptr<Info>>
-emitInfo(const TypedefDecl *D, const comments::FullComment *FC, int LineNumber,
+buildInfo(TypedefDecl const* D, Javadoc jd, comments::FullComment const* FC, int LineNumber,
          StringRef File, bool IsFileInRootDir, bool PublicOnly, Reporter& R);
 
 std::pair<std::unique_ptr<Info>, std::unique_ptr<Info>>
-emitInfo(const TypeAliasDecl *D, const comments::FullComment *FC, int LineNumber,
+buildInfo(TypeAliasDecl const* D, Javadoc jd, comments::FullComment const* FC, int LineNumber,
          StringRef File, bool IsFileInRootDir, bool PublicOnly, Reporter& R);
 
-
 template<class Decl, class... Args>
-std::pair<std::unique_ptr<Info>, std::unique_ptr<Info>>
-preEmitInfo(
+std::pair<
+    std::unique_ptr<Info>,
+    std::unique_ptr<Info>>
+buildInfoPair(
     Decl const* D,
     Args&&... args)
 {
-    // TODO investigate whether we can use ASTContext::getCommentForDecl instead
-    // of this logic. See also similar code in Mapper.cpp.
-    RawComment* raw = D->getASTContext().getRawCommentForDeclNoCache(D);
-    if(raw)
+    Javadoc jd;
+
+    // TODO investigate whether we can use
+    // ASTContext::getCommentForDecl instead of
+    // this logic. See also similar code in Mapper.cpp.
+    RawComment* RC = D->getASTContext().getRawCommentForDeclNoCache(D);
+    if(RC)
     {
-        raw->setAttached();
-        auto jd = parseJavadoc(*raw, D->getASTContext(), D);
+        RC->setAttached();
+        jd = parseJavadoc(RC, D->getASTContext(), D);
     }
 
-    return emitInfo(D, std::forward<Args>(args)...);
+    return buildInfo(D, std::move(jd), std::forward<Args>(args)...);
 }
 
 // Function to hash a given USR value for storage.