canonicalization and brief extraction is improved

Author: vinniefalco

include/mrdox/Corpus.hpp

@@ -74,17 +74,6 @@ class Corpus
         Config const& config,
         Reporter& R);
 
-    /** Canonicalize the contents of the object.
-
-        @return true upon success.
-
-        @param R The diagnostic reporting object to
-        use for delivering errors and information.
-    */
-    [[nodiscard]]
-    bool
-    canonicalize(Reporter& R);
-
     /** Sort an array of Info by fully qualified name
     */
 
@@ -201,6 +190,17 @@ class Corpus
     */
     void insertIntoIndex(Info const& I);
 
+    /** Canonicalize the contents of the object.
+
+        @return true upon success.
+
+        @param R The diagnostic reporting object to
+        use for delivering errors and information.
+    */
+    [[nodiscard]]
+    bool canonicalize(Reporter& R);
+
+    bool canonicalize(std::vector<SymbolID>& list, Temps& t, Reporter& R);
     bool canonicalize(NamespaceInfo& I, Temps& t, Reporter& R);
     bool canonicalize(RecordInfo& I, Temps& t, Reporter& R);
     bool canonicalize(FunctionInfo& I, Temps& t, Reporter& R);

source/lib/Corpus.cpp

@@ -169,46 +169,12 @@ build(
     // Finish up
     //
 
-    // Sort allSymbols by fully qualified name
-    {
-        std::string temp[2];
-        llvm::sort(
-            corpus->allSymbols,
-            [&](SymbolID const& id0,
-                SymbolID const& id1) noexcept
-            {
-                auto s0 = corpus->get<Info>(id0).getFullyQualifiedName(temp[0]);
-                auto s1 = corpus->get<Info>(id1).getFullyQualifiedName(temp[1]);
-                return symbolCompare(s0, s1);
-            });
-    }
+    if(! corpus->canonicalize(R))
+        return makeError("canonicalization failed");
 
     return corpus;
 }
 
-bool
-Corpus::
-canonicalize(
-    Reporter& R)
-{
-    if(isCanonical_)
-        return true;
-    auto p = find<NamespaceInfo>(EmptySID);
-    if(! p)
-    {
-        R.failed("find global namespace");
-        return false;
-    }
-
-    Temps t;
-    if(config_.verbose())
-        R.print("Canonicalizing...");
-    if(! canonicalize(*p, t, R))
-        return false;
-    isCanonical_ = true;
-    return true;
-}
-
 void
 Corpus::
 reportResult(
@@ -311,8 +277,17 @@ insert(std::unique_ptr<Info> Ip)
 
     auto& I = *Ip;
 
+    // VFALCO Better to do this in canonicalize
     // Clean up the javadoc
+    /*
     I.javadoc.calculateBrief();
+    if(I.IT == InfoType::IT_record)
+    {
+        auto& J = static_cast<RecordInfo&>(I);
+        for(auto& K : J.Members)
+            K.javadoc.calculateBrief();
+    }
+    */
 
     // Add a reference to this Info in the Index
     insertIntoIndex(I);
@@ -395,13 +370,61 @@ insertIntoIndex(
 
 //------------------------------------------------
 
+bool
+Corpus::
+canonicalize(Reporter& R)
+{
+    if(isCanonical_)
+        return true;
+    auto p = find<NamespaceInfo>(EmptySID);
+    if(! p)
+    {
+        R.failed("find global namespace");
+        return false;
+    }
+
+    if(config_.verbose())
+        R.print("Canonicalizing...");
+
+    Temps t;
+
+    if(! canonicalize(*p, t, R))
+        return false;
+
+    if(! canonicalize(allSymbols, t, R))
+        return false;
+
+    isCanonical_ = true;
+    return true;
+}
+
+bool
+Corpus::
+canonicalize(
+    std::vector<SymbolID>& list, Temps& t, Reporter& R)
+{
+    // Sort by fully qualified name
+    llvm::sort(
+        list,
+        [&](SymbolID const& id0,
+            SymbolID const& id1) noexcept
+        {
+            auto s0 = get<Info>(id0).getFullyQualifiedName(t.s0);
+            auto s1 = get<Info>(id1).getFullyQualifiedName(t.s1);
+            return symbolCompare(s0, s1);
+        });
+    return true;
+}
+
+
 bool
 Corpus::
 canonicalize(
     NamespaceInfo& I,
     Temps& t,
     Reporter& R)
 {
+    I.javadoc.calculateBrief();
     if(! canonicalize(I.Children, t, R))
         return false;
     return true;
@@ -414,6 +437,8 @@ canonicalize(
     Temps& t,
     Reporter& R)
 {
+    I.javadoc.calculateBrief();
+    canonicalize(I.Members, t, R);
     return true;
 }
 
@@ -424,6 +449,7 @@ canonicalize(
     Temps& t,
     Reporter& R)
 {
+    I.javadoc.calculateBrief();
     return true;
 }
 
@@ -434,6 +460,7 @@ canonicalize(
     Temps& t,
     Reporter& R)
 {
+    I.javadoc.calculateBrief();
     return true;
 }
 
@@ -444,6 +471,7 @@ canonicalize(
     Temps& t,
     Reporter& R)
 {
+    I.javadoc.calculateBrief();
     return true;
 }
 
@@ -546,6 +574,8 @@ canonicalize(
     Temps& t,
     Reporter& R)
 {
+    for(auto J : list)
+        J.javadoc.calculateBrief();
     return true;
 }
 

source/lib/format/Asciidoc.cpp

@@ -102,8 +102,6 @@ buildOne(
     if(R.error(ec, "open the stream for '", fileName, "'"))
         return false;
 
-    if(! corpus.canonicalize(R))
-        return false;
     Writer w(os, corpus, config, R);
     w.beginFile();
     w.visitAllSymbols();
@@ -122,8 +120,6 @@ buildString(
     dest.clear();
     llvm::raw_string_ostream os(dest);
 
-    if(! corpus.canonicalize(R))
-        return false;
     Writer w(os, corpus, config, R);
     w.beginFile();
     w.visitAllSymbols();

source/lib/format/XML.cpp

@@ -42,8 +42,6 @@ buildOne(
     if(R.error(ec, "open a stream for '", fileName, "'"))
         return false;
 
-    if(! corpus.canonicalize(R))
-        return false;
     Writer w(os, corpus, config, R);
     w.write();
     return true;
@@ -60,8 +58,6 @@ buildString(
     dest.clear();
     llvm::raw_string_ostream os(dest);
 
-    if(! corpus.canonicalize(R))
-        return false;
     Writer w(os, corpus, config, R);
     w.write();
     return true;
@@ -359,6 +355,12 @@ Writer::
 writeTypedef(
     TypedefInfo const& I)
 {
+    if(I.Name == "error_category")
+    {
+        adjustNesting(1);
+        adjustNesting(-1);
+    }
+
     openTag("typedef", {
         { "name", I.Name },
         { I.USR }
@@ -433,7 +435,7 @@ writeParam(
     FieldTypeInfo const& I)
 {
     writeTag("param", {
-        { "name", I.Name },
+        { "name", I.Name, ! I.Name.empty() },
         { "default", I.DefaultValue, ! I.DefaultValue.empty() },
         { "type", I.Type.Name },
         { I.Type.USR }
@@ -478,7 +480,7 @@ writeJavadoc(Javadoc const& jd)
     openTag("doc");
     adjustNesting(1);
     if(auto brief = jd.getBrief())
-        writeBrief(*brief);
+        writeBrief(brief);
     writeReturns(jd.getReturns());
     writeNodes(jd.getBlocks());
     writeNodes(jd.getParams());
@@ -542,11 +544,13 @@ void
 XMLGenerator::
 Writer::
 writeBrief(
-    Javadoc::Paragraph const& brief)
+    Javadoc::Paragraph const* brief)
 {
-    if(brief.empty())
+    if(! brief)
+        return;
+    if(brief->empty())
         return;
-    writeParagraph(brief, "brief");
+    writeParagraph(*brief, "brief");
 }
 
 void

source/lib/format/XML.hpp

@@ -104,7 +104,7 @@ class XMLGenerator::Writer
     template<class T>
     void writeNodes(List<T> const& list);
     void writeNode(Javadoc::Node const& node);
-    void writeBrief(Javadoc::Paragraph const& brief);
+    void writeBrief(Javadoc::Paragraph const* brief);
     void writeText(Javadoc::Text const& text, llvm::StringRef tag = "");
     void writeStyledText(Javadoc::StyledText const& text);
     void writeParagraph(Javadoc::Paragraph const& para, llvm::StringRef tag = "");