friend work

Author: vinniefalco

source/lib/ast/ASTVisitor.cpp

@@ -203,6 +203,14 @@ VisitCXXMethodDecl(
     return mapDecl(D);
 }
 
+bool
+ASTVisitor::
+VisitFriendDecl(
+    FriendDecl const* D)
+{
+    return true;
+}
+
 bool
 ASTVisitor::
 VisitFunctionDecl(

source/lib/ast/ASTVisitor.hpp

@@ -72,6 +72,7 @@ class ASTVisitor
     bool VisitCXXDestructorDecl(CXXDestructorDecl const* D);
     bool VisitCXXConstructorDecl(CXXConstructorDecl const* D);
     bool VisitCXXMethodDecl(CXXMethodDecl const* D);
+    bool VisitFriendDecl(FriendDecl const* D);
     bool VisitFunctionDecl(FunctionDecl const* D);
     bool VisitTypedefDecl(TypedefDecl const* D);
     bool VisitTypeAliasDecl(TypeAliasDecl const* D);

source/lib/ast/Serialize.cpp

@@ -14,6 +14,7 @@
 #include "ParseJavadoc.hpp"
 #include <mrdox/Debug.hpp>
 #include <mrdox/Metadata.hpp>
+#include <clang/AST/DeclFriend.h>
 #include <clang/Index/USRGeneration.h>
 #include <clang/Lex/Lexer.h>
 #include <llvm/ADT/Hashing.h>

source/lib/format/xml/XML.cpp

@@ -631,7 +631,7 @@ writeJavadoc(Javadoc const& jd)
         return;
     openTag("doc");
     if(auto brief = jd.getBrief())
-        writeBrief(brief);
+        writeBrief(*brief);
     writeNodes(jd.getBlocks());
     closeTag("doc");
 }
@@ -666,6 +666,9 @@ writeNode(
     case Javadoc::Kind::paragraph:
         writeParagraph(static_cast<Javadoc::Paragraph const&>(node));
         break;
+    case Javadoc::Kind::brief:
+        writeBrief(static_cast<Javadoc::Brief const&>(node));
+        break;
     case Javadoc::Kind::admonition:
         writeAdmonition(static_cast<Javadoc::Admonition const&>(node));
         break;
@@ -690,14 +693,10 @@ void
 XMLGenerator::
 Writer::
 writeBrief(
-    Javadoc::Paragraph const* node)
+    Javadoc::Paragraph const& node)
 {
-    if(! node)
-        return;
-    if(node->empty())
-        return;
     openTag("brief");
-    writeNodes(node->children);
+    writeNodes(node.children);
     closeTag("brief");
 }
 

source/lib/format/xml/XML.hpp

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

tests/javadoc/friend-1.cpp

@@ -0,0 +1,5 @@
+struct T
+{
+    /// f
+    friend void f();
+};

tests/javadoc/friend-1.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mrdox SYSTEM "mrdox.dtd">
+<mrdox>
+<symbols>
+  <symbol name="" tag="namespace"/>
+  <symbol name="f" tag="function" id="s6nsa+zVhpzzrN+yUVPP5rvdXqs="/>
+  <symbol name="T" tag="struct" id="CgGNdHpW5mG/i5741WPYQDw28OQ="/>
+</symbols>
+<namespace name="">
+  <struct name="T" id="CgGNdHpW5mG/i5741WPYQDw28OQ=">
+    <file path="friend-1.cpp" line="1" class="def"/>
+  </struct>
+  <function name="f" id="s6nsa+zVhpzzrN+yUVPP5rvdXqs=">
+    <file path="friend-1.cpp" line="4"/>
+    <doc>
+      <para>
+        <text> f</text>
+      </para>
+    </doc>
+  </function>
+</namespace>
+</mrdox>

tests/javadoc/friend-2.cpp

@@ -0,0 +1,7 @@
+struct T
+{
+    /// f
+    friend void f();
+};
+
+void f();

tests/javadoc/friend-2.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE mrdox SYSTEM "mrdox.dtd">
+<mrdox>
+<symbols>
+  <symbol name="" tag="namespace"/>
+  <symbol name="f" tag="function" id="s6nsa+zVhpzzrN+yUVPP5rvdXqs="/>
+  <symbol name="T" tag="struct" id="CgGNdHpW5mG/i5741WPYQDw28OQ="/>
+</symbols>
+<namespace name="">
+  <struct name="T" id="CgGNdHpW5mG/i5741WPYQDw28OQ=">
+    <file path="friend-2.cpp" line="1" class="def"/>
+  </struct>
+  <function name="f" id="s6nsa+zVhpzzrN+yUVPP5rvdXqs=">
+    <file path="friend-2.cpp" line="4"/>
+    <file path="friend-2.cpp" line="7"/>
+    <doc>
+      <para>
+        <text> f</text>
+      </para>
+    </doc>
+  </function>
+</namespace>
+</mrdox>

tests/javadoc/friend-3.cpp

@@ -0,0 +1,12 @@
+struct T
+{
+    /// T::f
+    friend void f();
+};
+
+struct U
+{
+    friend void f();
+};
+
+void f();