remove CommentInfo

Author: vinniefalco

include/mrdox/MetadataFwd.hpp

@@ -21,7 +21,6 @@ namespace clang {
 namespace mrdox {
 
 struct BaseRecordInfo;
-struct CommentInfo;
 struct EnumValueInfo;
 struct EnumInfo;
 struct FieldTypeInfo;

include/mrdox/meta/Info.hpp

@@ -45,9 +45,9 @@ struct Info
     */
     llvm::SmallVector<Reference, 4> Namespace;
 
-    // Comment description of this decl.
+    /** The extracted javadoc for this declaration.
+    */
     Javadoc javadoc;
-    std::vector<CommentInfo> Description;
 
     // Path of directory where the clang-doc
     // generated file will be saved

include/mrdox/meta/Javadoc.hpp

@@ -21,52 +21,7 @@
 namespace clang {
 namespace mrdox {
 
-/** A single verbatim block.
-*/
-struct VerbatimBlock
-{
-    std::string text;
-};
-
-// A representation of a parsed comment.
-struct CommentInfo
-{
-    CommentInfo() = default;
-    CommentInfo(CommentInfo& Other) = delete;
-    CommentInfo(CommentInfo&& Other) = default;
-    CommentInfo& operator=(CommentInfo&& Other) = default;
-
-    bool operator==(const CommentInfo& Other) const;
-
-    // This operator is used to sort a vector of CommentInfos.
-    // No specific order (attributes more important than others) is required. Any
-    // sort is enough, the order is only needed to call std::unique after sorting
-    // the vector.
-    bool operator<(const CommentInfo& Other) const;
-
-    llvm::SmallString<16> Kind;
-        // Kind of comment (FullComment, ParagraphComment, TextComment,
-        // InlineCommandComment, HTMLStartTagComment, HTMLEndTagComment,
-        // BlockCommandComment, ParamCommandComment,
-        // TParamCommandComment, VerbatimBlockComment,
-        // VerbatimBlockLineComment, VerbatimLineComment).
-    llvm::SmallString<64> Text;      // Text of the comment.
-    llvm::SmallString<16> Name;      // Name of the comment (for Verbatim and HTML).
-    llvm::SmallString<8> Direction;  // Parameter direction (for (T)ParamCommand).
-    llvm::SmallString<16> ParamName; // Parameter name (for (T)ParamCommand).
-    llvm::SmallString<16> CloseName; // Closing tag name (for VerbatimBlock).
-    bool SelfClosing = false;  // Indicates if tag is self-closing (for HTML).
-    bool Explicit = false; // Indicates if the direction of a param is explicit
-    // (for (T)ParamCommand).
-    llvm::SmallVector<llvm::SmallString<16>, 4> AttrKeys; // List of attribute keys (for HTML).
-    llvm::SmallVector<llvm::SmallString<16>, 4> AttrValues; // List of attribute values for each key (for HTML).
-    llvm::SmallVector<llvm::SmallString<16>, 4> Args; // List of arguments to commands (for InlineCommand).
-    std::vector<std::unique_ptr<CommentInfo>> Children; // List of child comments for this CommentInfo.
-};
-
-//------------------------------------------------
-
-/** A processed Javadoc-style comment attached to a declaration.
+/** A processed Doxygen-style comment attached to a declaration.
 */
 struct Javadoc
 {

include/mrdox/meta/MemberType.hpp

@@ -40,8 +40,8 @@ struct MemberTypeInfo
         MemberTypeInfo const& Other) const
     {
         return
-            std::tie(Type, Name, Access, Description) ==
-            std::tie(Other.Type, Other.Name, Other.Access, Other.Description);
+            std::tie(Type, Name, Access, javadoc) ==
+            std::tie(Other.Type, Other.Name, Other.Access, Other.javadoc);
     }
 
     // VFALCO Why public?
@@ -52,7 +52,6 @@ struct MemberTypeInfo
     AccessSpecifier Access = AccessSpecifier::AS_public;
 
     Javadoc javadoc;
-    std::vector<CommentInfo> Description; // Comment description of this field.
 };
 
 } // mrdox

source/lib/meta/Info.cpp

@@ -44,20 +44,12 @@ mergeBase(
         Path = Other.Path;
     if (Namespace.empty())
         Namespace = std::move(Other.Namespace);
-    // Unconditionally extend the description,
-    // since each decl may have a comment.
-    std::move(
-        Other.Description.begin(),
-        Other.Description.end(),
-        std::back_inserter(Description));
-    llvm::sort(Description);
-    auto Last = std::unique(
-        Description.begin(), Description.end());
-    Description.erase(Last, Description.end());
     if (javadoc.brief.empty())
         javadoc.brief = std::move(Other.javadoc.brief);
     if (javadoc.desc.empty())
         javadoc.desc = std::move(Other.javadoc.desc);
+    // Unconditionally extend the blocks
+    // since each decl may have a comment.
     javadoc.merge(Other.javadoc);
 }
 

source/lib/meta/Javadoc.cpp

@@ -36,51 +36,6 @@ static_assert(std::is_move_constructible_v<Javadoc::Param>);
 static_assert(std::is_move_constructible_v<Javadoc::TParam>);
 static_assert(std::is_move_constructible_v<Javadoc::Code>);
 
-bool
-CommentInfo::
-operator==(
-    CommentInfo const& Other) const
-{
-    auto FirstCI = std::tie(
-        Kind, Text, Name, Direction,
-        ParamName, CloseName, SelfClosing,
-        Explicit, AttrKeys, AttrValues, Args);
-    auto SecondCI = std::tie(
-        Other.Kind, Other.Text, Other.Name, Other.Direction,
-        Other.ParamName, Other.CloseName, Other.SelfClosing,
-        Other.Explicit, Other.AttrKeys, Other.AttrValues, Other.Args);
-    if (FirstCI != SecondCI || Children.size() != Other.Children.size())
-        return false;
-    return std::equal(
-        Children.begin(), Children.end(),
-        Other.Children.begin(),
-        llvm::deref<std::equal_to<>>{});
-}
-
-bool
-CommentInfo::
-operator<(
-    CommentInfo const& Other) const
-{
-    auto FirstCI = std::tie(
-        Kind, Text, Name, Direction,
-        ParamName, CloseName, SelfClosing,
-        Explicit, AttrKeys, AttrValues, Args);
-    auto SecondCI = std::tie(
-        Other.Kind, Other.Text, Other.Name, Other.Direction,
-        Other.ParamName, Other.CloseName, Other.SelfClosing,
-        Other.Explicit, Other.AttrKeys, Other.AttrValues, Other.Args);
-    if (FirstCI < SecondCI)
-        return true;
-    if (FirstCI == SecondCI) {
-        return std::lexicographical_compare(
-            Children.begin(), Children.end(),
-            Other.Children.begin(), Other.Children.end(),
-            llvm::deref<std::less<>>());
-    }
-    return false;
-}
-
 //------------------------------------------------
 
 Javadoc::Paragraph const Javadoc::s_empty_;