tidy up javadoc code

Author: vinniefalco

include/mrdox/meta/Javadoc.hpp

@@ -284,11 +284,9 @@ struct Javadoc
 
     /** Constructor
     */
+    explicit
     Javadoc(
-        List<Block> blocks,
-        List<Param> params,
-        List<TParam> tparams,
-        Returns returns);
+        List<Block> blocks);
 
     /** Return true if this is empty
     */
@@ -314,28 +312,12 @@ struct Javadoc
         return blocks_;
     }
 
-    /** Return a paragraph describing the return value.
-    */
-    Returns const&
-    getReturns() const noexcept
-    {
-        return returns_;
-    }
-
-    /** Return the list of param commands
-    */
-    List<Param> const&
-    getParams() const noexcept
-    {
-        return params_;
-    }
-
-    /** Return the list of tparam commands
-    */
-    List<TParam> const&
-    getTParams() const noexcept
+    // VFALCO This is unfortunately necessary for
+    //        the deserialization from bitcode...
+    List<Block>&
+    getBlocks() noexcept
     {
-        return tparams_;
+        return blocks_;
     }
 
     //--------------------------------------------
@@ -423,32 +405,16 @@ struct Javadoc
 
     /** Add a top level element to the doc comment.
     */
-    /** @{ */
     void append(Block node)
     {
         append(blocks_, std::move(node));
     }
 
-    void append(Param node)
-    {
-        append(params_, std::move(node));
-    }
-
-    void append(TParam node)
-    {
-        append(tparams_, std::move(node));
-    }
-    /** @} */
-
     //--------------------------------------------
 
-//private:
-public: // VFALCO sigh...
+private:
     std::shared_ptr<Paragraph const> brief_;
     List<Block> blocks_;
-    List<Param> params_;
-    List<TParam> tparams_;
-    std::shared_ptr<Returns const> returns_ptr_;
     Returns returns_;
 };
 

source/lib/ast/BitcodeReader.cpp

@@ -800,7 +800,7 @@ readSubBlock(
             return err;
         if(! J.isTopLevel())
             return J.spliceIntoParent();
-        return J.spliceInto(javadoc_->blocks_);
+        return J.spliceInto(javadoc_->getBlocks());
     }
 
     case BI_JAVADOC_NODE_BLOCK_ID:

source/lib/ast/ParseJavadoc.cpp

@@ -152,11 +152,7 @@ class JavadocVisitor
     {
         visit(FC_);
 
-        return Javadoc(
-            std::move(blocks_),
-            std::move(params_),
-            std::move(tparams_),
-            std::move(returns_));
+        return Javadoc(std::move(blocks_));
     }
 
     void visitComment(
@@ -660,24 +656,6 @@ dumpJavadoc(
     if(! jd.getBlocks().empty())
         dump(os, jd.getBlocks());
 
-    if(! jd.getReturns().empty())
-    {
-        os << "    @returns ";
-        dump(os, jd.getReturns());
-    }
-
-    if(! jd.getParams().empty())
-    {
-        os << '\n';
-        dump(os, jd.getParams());
-    }
-
-    if(! jd.getTParams().empty())
-    {
-        os << '\n';
-        dump(os, jd.getTParams());
-    }
-
     os <<
         "*/\n"
         "\n\n";

source/lib/format/xml/XML.cpp

@@ -499,9 +499,6 @@ writeJavadoc(Javadoc const& jd)
     if(auto brief = jd.getBrief())
         writeBrief(brief);
     writeNodes(jd.getBlocks());
-    writeReturns(jd.getReturns());
-    writeNodes(jd.getParams());
-    writeNodes(jd.getTParams());
     closeTag("doc");
 }
 

source/lib/meta/Javadoc.cpp

@@ -10,8 +10,6 @@
 //
 
 #include <mrdox/meta/Javadoc.hpp>
-#include <mrdox/meta/Namespace.hpp>
-#include <mrdox/Config.hpp>
 #include <llvm/Support/Error.h>
 #include <llvm/Support/Path.h>
 
@@ -36,26 +34,17 @@ static_assert(a_Node<Javadoc::Code>);
 
 Javadoc::
 Javadoc(
-    List<Block> blocks,
-    List<Param> params,
-    List<TParam> tparams,
-    Returns returns)
+    List<Block> blocks)
     : blocks_(std::move(blocks))
-    , params_(std::move(params))
-    , tparams_(std::move(tparams))
-    , returns_(std::move(returns))
 {
 }
 
 bool
 Javadoc::
 empty() const noexcept
 {
-    if( (! brief_) &&
-        blocks_.empty() &&
-        params_.empty() &&
-        tparams_.empty() &&
-        returns_.empty())
+    if( ! brief_ &&
+        blocks_.empty())
     {
         return true;
     }
@@ -67,11 +56,7 @@ Javadoc::
 operator==(
     Javadoc const& other) const noexcept
 {
-    return 
-        blocks_ == other.blocks_ &&
-        params_ == other.params_ &&
-        tparams_ == other.tparams_ &&
-        returns_ == other.returns_;
+    return blocks_ == other.blocks_;
 }
 
 bool
@@ -89,13 +74,7 @@ merge(Javadoc&& other)
     // Unconditionally extend the blocks
     // since each decl may have a comment.
     if(other != *this)
-    {
         append(blocks_, std::move(other.blocks_));
-        append(params_, std::move(other.params_));
-        append(tparams_, std::move(other.tparams_));
-        if( returns_.empty())
-            returns_ = std::move(other.returns_);
-    }
 }
 
 auto

tests/decls/record-access.xml

@@ -4,18 +4,24 @@
 <symbols>
   <symbol name="" tag="namespace"/>
   <symbol name="C0" tag="class" id="sTaqkoFcVbtntbfpe777v5/pWL0="/>
+  <symbol name="C0::f0" tag="function" id="IdInRLjINkaIuyTqWyEUhoM1DZM="/>
   <symbol name="C0::f1" tag="function" id="EyRDT2mXtRNmcISD2rsC6/mLusw="/>
   <symbol name="C0::f2" tag="function" id="ZOAAp99eH9zKUZqx0JzW6AuhRTQ="/>
   <symbol name="S0" tag="struct" id="u38+snleg17KL7EQuD9FV1Z8b9E="/>
   <symbol name="S0::f0" tag="function" id="STTnU4grbgOl2xPE6okWC57zruc="/>
   <symbol name="S0::f1" tag="function" id="IaPeEIwn9q94M3MuwxsB3qhBOSE="/>
+  <symbol name="S0::f2" tag="function" id="QicvGhxlL09TrpXiFYAS+pz8/9g="/>
   <symbol name="U0" tag="union" id="SHIJWZPzfYtLVfe/rzFAmeVpANk="/>
   <symbol name="U0::f0" tag="function" id="eY4R9etszWK2H42p4kWNm5XfpnE="/>
   <symbol name="U0::f1" tag="function" id="KjiG7Uufpmd65dhiSV+Jv2RjgHA="/>
+  <symbol name="U0::f2" tag="function" id="KXASSTkImsSKBg6l0hOSkbt1K7M="/>
 </symbols>
 <namespace name="">
   <class name="C0" id="sTaqkoFcVbtntbfpe777v5/pWL0=">
     <file path="record-access.cpp" line="12" class="def"/>
+    <function name="f0" access="private" id="IdInRLjINkaIuyTqWyEUhoM1DZM=">
+      <file path="record-access.cpp" line="14"/>
+    </function>
     <function name="f1" access="protected" id="EyRDT2mXtRNmcISD2rsC6/mLusw=">
       <file path="record-access.cpp" line="16"/>
     </function>
@@ -31,6 +37,9 @@
     <function name="f1" access="protected" id="IaPeEIwn9q94M3MuwxsB3qhBOSE=">
       <file path="record-access.cpp" line="7"/>
     </function>
+    <function name="f2" access="private" id="QicvGhxlL09TrpXiFYAS+pz8/9g=">
+      <file path="record-access.cpp" line="9"/>
+    </function>
   </struct>
   <union name="U0" id="SHIJWZPzfYtLVfe/rzFAmeVpANk=">
     <file path="record-access.cpp" line="21" class="def"/>
@@ -40,6 +49,9 @@
     <function name="f1" access="protected" id="KjiG7Uufpmd65dhiSV+Jv2RjgHA=">
       <file path="record-access.cpp" line="25"/>
     </function>
+    <function name="f2" access="private" id="KXASSTkImsSKBg6l0hOSkbt1K7M=">
+      <file path="record-access.cpp" line="27"/>
+    </function>
   </union>
 </namespace>
 </mrdox>

tests/decls/record-data.xml

@@ -20,7 +20,9 @@
   </struct>
   <class name="V" id="9kzYwt0WPztMEDUaFxul1Jvqqs8=">
     <file path="record-data.cpp" line="14" class="def"/>
+    <data name="i" type="int" access="private"/>
     <data name="j" type="unsigned long" access="protected"/>
+    <data name="k" type="double" access="private"/>
   </class>
   <struct name="W" id="6OhcFM3BV6KlrvmfpsljaMHxpdA=">
     <file path="record-data.cpp" line="23" class="def"/>