Feat/improved clean comment pass (#1928)

* Code cleanup

* Improved XML style comment parsing

* Fix test errors

Author: duckdoom5

src/AST/Comment.cs

@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.Linq;
 
 namespace CppSharp.AST
 {
@@ -109,7 +110,7 @@ public interface ICommentVisitor<out T>
         T VisitTParamCommand(TParamCommandComment comment);
         T VisitVerbatimBlock(VerbatimBlockComment comment);
         T VisitVerbatimLine(VerbatimLineComment comment);
-        T VisitParagraphCommand(ParagraphComment comment);
+        T VisitParagraph(ParagraphComment comment);
         T VisitFull(FullComment comment);
         T VisitHTMLStartTag(HTMLStartTagComment comment);
         T VisitHTMLEndTag(HTMLEndTagComment comment);
@@ -129,20 +130,13 @@ public abstract class Comment
 
         public static string GetMultiLineCommentPrologue(CommentKind kind)
         {
-            switch (kind)
+            return kind switch
             {
-                case CommentKind.BCPL:
-                case CommentKind.BCPLExcl:
-                    return "//";
-                case CommentKind.C:
-                case CommentKind.JavaDoc:
-                case CommentKind.Qt:
-                    return " *";
-                case CommentKind.BCPLSlash:
-                    return "///";
-                default:
-                    throw new ArgumentOutOfRangeException();
-            }
+                CommentKind.BCPL or CommentKind.BCPLExcl => "//",
+                CommentKind.C or CommentKind.JavaDoc or CommentKind.Qt => " *",
+                CommentKind.BCPLSlash => "///",
+                _ => throw new ArgumentOutOfRangeException()
+            };
         }
 
         public static string GetLineCommentPrologue(CommentKind kind)
@@ -375,7 +369,7 @@ public ParagraphComment()
 
         public override void Visit<T>(ICommentVisitor<T> visitor)
         {
-            visitor.VisitParagraphCommand(this);
+            visitor.VisitParagraph(this);
         }
     }
 
@@ -416,10 +410,17 @@ public struct Attribute
         {
             public string Name;
             public string Value;
+
+            public override string ToString()
+            {
+                return $"{Name}=\"{Value}\"";
+            }
         }
 
         public List<Attribute> Attributes;
 
+        public bool SelfClosing { get; set; }
+
         public HTMLStartTagComment()
         {
             Kind = DocumentationCommentKind.HTMLStartTagComment;
@@ -430,6 +431,15 @@ public override void Visit<T>(ICommentVisitor<T> visitor)
         {
             visitor.VisitHTMLStartTag(this);
         }
+
+        public override string ToString()
+        {
+            var attrStr = string.Empty;
+            if (Attributes.Count != 0)
+                attrStr = " " + string.Join(' ', Attributes.Select(x => x.ToString()));
+
+            return $"<{TagName}{attrStr}{(SelfClosing ? "/" : "")}>";
+        }
     }
 
     /// <summary>
@@ -446,6 +456,11 @@ public override void Visit<T>(ICommentVisitor<T> visitor)
         {
             visitor.VisitHTMLEndTag(this);
         }
+
+        public override string ToString()
+        {
+            return $"</{TagName}>";
+        }
     }
 
     /// <summary>
@@ -464,6 +479,13 @@ public override void Visit<T>(ICommentVisitor<T> visitor)
         {
             visitor.VisitText(this);
         }
+
+        public override string ToString()
+        {
+            return Text;
+        }
+
+        public bool IsEmpty => string.IsNullOrEmpty(Text) && !HasTrailingNewline;
     }
 
     /// <summary>

src/CppParser/Comments.cpp

@@ -263,8 +263,8 @@ void Parser::HandleComments(const clang::Decl* D, Declaration* Decl)
 {
     using namespace clang;
 
-    const clang::RawComment* RC = 0;
-    if (!(RC = c->getASTContext().getRawCommentForAnyRedecl(D)))
+    const clang::RawComment* RC = c->getASTContext().getRawCommentForAnyRedecl(D);
+    if (!RC)
         return;
 
     auto RawComment = WalkRawComment(RC);

src/Generator.Tests/Passes/TestPasses.cs

@@ -123,17 +123,38 @@ public void TestFunctionToStaticPass()
         [Test]
         public void TestCleanCommentsPass()
         {
-            var c = AstContext.FindClass("TestCommentsPass").FirstOrDefault();
+            var c = AstContext.Class("TestCommentsPass");
+            var c2 = AstContext.Class("TestCommentsPass2");
 
             passBuilder.AddPass(new CleanCommentsPass());
             passBuilder.RunPasses(pass => pass.VisitDeclaration(c));
+            passBuilder.RunPasses(pass => pass.VisitClassDecl(c2));
 
             var para = (ParagraphComment)c.Comment.FullComment.Blocks[0];
             var textGenerator = new TextGenerator();
             textGenerator.Print(para, CommentKind.BCPLSlash);
 
             Assert.That(textGenerator.StringBuilder.ToString().Trim(),
                 Is.EqualTo("/// <summary>A simple test.</summary>"));
+
+            var textGenerator2 = new TextGenerator();
+            textGenerator2.Print(c2.Methods[0].Comment.FullComment, CommentKind.BCPLSlash);
+
+            Assert.That(textGenerator2.StringBuilder.ToString().Trim().Replace("\r\n", "\n"),
+                Is.EqualTo(
+                    "/// <summary>Gets a value</summary>\n" +
+                            "/// <returns>One</returns>"
+                        ));
+
+            var textGenerator3 = new TextGenerator();
+            textGenerator3.Print(c2.Methods[1].Comment.FullComment, CommentKind.BCPLSlash);
+
+            Assert.That(textGenerator3.StringBuilder.ToString().Trim().Replace("\r\n", "\n"),
+                Is.EqualTo(
+                    "/// <summary>Sets a value. Get it with <see cref=\"GetValueWithComment\"/></summary>\n" +
+                            "/// <param name=\"value\">The value to set</param>\n" +
+                            "/// <returns>The parameter (typeof<float>)</returns>"
+                        ));
         }
 
         [Test]