ASTVisitor handles source info independently from javadoc

#improvement

Author: alandefreitas

src/lib/AST/ASTVisitor.cpp

@@ -531,10 +531,24 @@ void
 ASTVisitor::
 populate(Info& I, bool const isNew, DeclTy const* D)
 {
-    // Populate the documentation
-    bool const isDocumented = generateJavadoc(I.javadoc, D);
+    populate(I.javadoc, D);
+    populate(dynamic_cast<SourceInfo&>(I), D);
 
-    // Populate the source info
+    // All other information is redundant if the symbol is not new
+    MRDOCS_CHECK_OR(isNew);
+
+    // These should already have been populated by traverseImpl
+    MRDOCS_ASSERT(I.id);
+    MRDOCS_ASSERT(I.Kind != InfoKind::None);
+
+    I.Name = extractName(D);
+}
+
+template <std::derived_from<Decl> DeclTy>
+void
+ASTVisitor::
+populate(SourceInfo& I, DeclTy const* D)
+{
     clang::SourceLocation Loc = D->getBeginLoc();
     if (Loc.isInvalid())
     {
@@ -544,17 +558,26 @@ populate(Info& I, bool const isNew, DeclTy const* D)
     {
         populate(
             dynamic_cast<SourceInfo&>(I),
-            Loc, isDefinition(D), isDocumented);
+            Loc,
+            isDefinition(D),
+            D->getASTContext().getRawCommentForDeclNoCache(D));
     }
+}
 
-    // All other information is redundant if the symbol is not new
-    MRDOCS_CHECK_OR(isNew);
-
-    // These should already have been populated by traverseImpl
-    MRDOCS_ASSERT(I.id);
-    MRDOCS_ASSERT(I.Kind != InfoKind::None);
-
-    I.Name = extractName(D);
+bool
+ASTVisitor::
+populate(
+    std::optional<Javadoc>& javadoc,
+    Decl const* D)
+{
+    RawComment const* RC =
+        D->getASTContext().getRawCommentForDeclNoCache(D);
+    MRDOCS_CHECK_OR(RC, false);
+    comments::FullComment* FC =
+        RC->parse(D->getASTContext(), &sema_.getPreprocessor(), D);
+    MRDOCS_CHECK_OR(FC, false);
+    parseJavadoc(javadoc, FC, D, config_, diags_);
+    return true;
 }
 
 void
@@ -686,6 +709,13 @@ populate(RecordInfo& I, ClassTemplateSpecializationDecl const* D)
     populate(I, cast<CXXRecordDecl>(D));
 }
 
+void
+ASTVisitor::
+populate(RecordInfo& I, ClassTemplatePartialSpecializationDecl const* D)
+{
+    populate(I, dynamic_cast<ClassTemplateSpecializationDecl const*>(D));
+}
+
 void
 ASTVisitor::
 populate(
@@ -1023,6 +1053,13 @@ populate(VariableInfo& I, VarTemplateSpecializationDecl const* D)
     populate(I, cast<VarDecl>(D));
 }
 
+void
+ASTVisitor::
+populate(VariableInfo& I, VarTemplatePartialSpecializationDecl const* D)
+{
+    populate(I, dynamic_cast<VarTemplateSpecializationDecl const*>(D));
+}
+
 void
 ASTVisitor::
 populate(
@@ -1883,22 +1920,6 @@ qualifiedName(NamedDecl const* ND) const
     return name;
 }
 
-bool
-ASTVisitor::
-generateJavadoc(
-    std::optional<Javadoc>& javadoc,
-    Decl const* D)
-{
-    RawComment const* RC =
-        D->getASTContext().getRawCommentForDeclNoCache(D);
-    MRDOCS_CHECK_OR(RC, false);
-    comments::FullComment* FC =
-        RC->parse(D->getASTContext(), &sema_.getPreprocessor(), D);
-    MRDOCS_CHECK_OR(FC, false);
-    parseJavadoc(javadoc, FC, D, config_, diags_);
-    return true;
-}
-
 Polymorphic<TypeInfo>
 ASTVisitor::
 toTypeInfo(QualType const qt, TraversalMode const mode)

src/lib/AST/ASTVisitor.hpp

@@ -484,6 +484,24 @@ class ASTVisitor
     void
     populate(Info& I, bool isNew, DeclTy const* D);
 
+    template <std::derived_from<Decl> DeclTy>
+    void
+    populate(SourceInfo& I, DeclTy const* D);
+
+    /*  Parse the comments above a declaration as Javadoc
+
+        This function will parse the comments above a declaration
+        as Javadoc, and store the results in the `javadoc` input
+        parameter.
+
+        @return true if the comments were successfully parsed as
+        Javadoc, and false otherwise.
+     */
+    bool
+    populate(
+        std::optional<Javadoc>& javadoc,
+        Decl const* D);
+
     void
     populate(SourceInfo& I, clang::SourceLocation loc, bool definition, bool documented);
 
@@ -503,6 +521,9 @@ class ASTVisitor
     void
     populate(RecordInfo& I, ClassTemplateSpecializationDecl const* D);
 
+    void
+    populate(RecordInfo& I, ClassTemplatePartialSpecializationDecl const* D);
+
     void
     populate(FunctionInfo& I, FunctionDecl const* D);
 
@@ -548,6 +569,9 @@ class ASTVisitor
     void
     populate(VariableInfo& I, VarTemplateSpecializationDecl const* D);
 
+    void
+    populate(VariableInfo& I, VarTemplatePartialSpecializationDecl const* D);
+
     void
     populate(FieldInfo& I, FieldDecl const* D);
 
@@ -718,20 +742,6 @@ class ASTVisitor
     void
     addMember(std::vector<SymbolID>& container, Info const& Member) const;
 
-    /*  Parse the comments above a declaration as Javadoc
-
-        This function will parse the comments above a declaration
-        as Javadoc, and store the results in the `javadoc` input
-        parameter.
-
-        @return true if the comments were successfully parsed as
-        Javadoc, and false otherwise.
-     */
-    bool
-    generateJavadoc(
-        std::optional<Javadoc>& javadoc,
-        Decl const* D);
-
     Polymorphic<TypeInfo>
     toTypeInfo(QualType qt, TraversalMode mode);