Extract content model, make doc model independent from descriptors, parse doccomments with custom parser, some tests failing due to hanging new lines.

5 files changed, 74 insertions, 65 deletions

diff --git a/test/src/model/ClassTest.kt b/test/src/model/ClassTest.kt
index 05e156f3..7068038f 100644
--- a/test/src/model/ClassTest.kt
+++ b/test/src/model/ClassTest.kt
@@ -10,7 +10,7 @@ public class ClassTest {
             with(model.members.single().members.single()) {
                 assertEquals(DocumentationNode.Kind.Class, kind)
                 assertEquals("Klass", name)
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
                 assertEquals(2, details.count())
                 assertEquals("<init>", members.single().name)
                 assertTrue(links.none())
@@ -23,7 +23,7 @@ public class ClassTest {
             with(model.members.single().members.single()) {
                 assertEquals(DocumentationNode.Kind.Class, kind)
                 assertEquals("Klass", name)
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
                 assertEquals(2, details.count())
                 assertEquals("<init>", members.single().name)
                 assertTrue(links.none())
@@ -36,7 +36,7 @@ public class ClassTest {
             with(model.members.single().members.single()) {
                 assertEquals(DocumentationNode.Kind.Object, kind)
                 assertEquals("Obj", name)
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
                 assertEquals(2, details.count())
                 assertTrue(members.none())
                 assertTrue(links.none())
@@ -49,21 +49,21 @@ public class ClassTest {
             with (model.members.single().members.single()) {
                 assertEquals(DocumentationNode.Kind.Class, kind)
                 assertEquals("Klass", name)
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
                 assertEquals(2, details.count())
                 assertTrue(links.none())
 
                 assertEquals(1, members.count())
                 with(members.elementAt(0)) {
                     assertEquals("<init>", name)
-                    assertEquals(DocumentationContent.Empty, doc)
+                    assertEquals(Content.Empty, doc)
                     assertEquals(DocumentationNode.Kind.Constructor, kind)
                     assertEquals(2, details.count())
                     assertEquals("public", details.elementAt(0).name)
                     with(details.elementAt(1)) {
                         assertEquals("name", name)
                         assertEquals(DocumentationNode.Kind.Parameter, kind)
-                        assertEquals(DocumentationContent.Empty, doc)
+                        assertEquals(Content.Empty, doc)
                         assertEquals("String", details.single().name)
                         assertTrue(links.none())
                         assertTrue(members.none())
@@ -80,14 +80,14 @@ public class ClassTest {
             with(model.members.single().members.single()) {
                 assertEquals(DocumentationNode.Kind.Class, kind)
                 assertEquals("Klass", name)
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
                 assertEquals(2, details.count())
                 assertTrue(links.none())
 
                 assertEquals(2, members.count())
                 with(members.elementAt(0)) {
                     assertEquals("<init>", name)
-                    assertEquals(DocumentationContent.Empty, doc)
+                    assertEquals(Content.Empty, doc)
                     assertEquals(DocumentationNode.Kind.Constructor, kind)
                     assertEquals(1, details.count())
                     assertEquals("public", details.elementAt(0).name)
@@ -96,7 +96,7 @@ public class ClassTest {
                 }
                 with(members.elementAt(1)) {
                     assertEquals("fn", name)
-                    assertEquals(DocumentationContent.Empty, doc)
+                    assertEquals(Content.Empty, doc)
                     assertEquals(DocumentationNode.Kind.Function, kind)
                     assertEquals("Unit", detail(DocumentationNode.Kind.Type).name)
                     assertTrue(links.none())
@@ -111,14 +111,14 @@ public class ClassTest {
             with(model.members.single().members.single()) {
                 assertEquals(DocumentationNode.Kind.Class, kind)
                 assertEquals("Klass", name)
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
                 assertEquals(2, details.count())
                 assertTrue(links.none())
 
                 assertEquals(2, members.count())
                 with(members.elementAt(0)) {
                     assertEquals("<init>", name)
-                    assertEquals(DocumentationContent.Empty, doc)
+                    assertEquals(Content.Empty, doc)
                     assertEquals(DocumentationNode.Kind.Constructor, kind)
                     assertEquals(1, details.count())
                     assertEquals("public", details.elementAt(0).name)
@@ -127,7 +127,7 @@ public class ClassTest {
                 }
                 with(members.elementAt(1)) {
                     assertEquals("name", name)
-                    assertEquals(DocumentationContent.Empty, doc)
+                    assertEquals(Content.Empty, doc)
                     assertEquals(DocumentationNode.Kind.Property, kind)
                     assertEquals("String", detail(DocumentationNode.Kind.Type).name)
                     assertTrue(members.none())
diff --git a/test/src/model/CommentTest.kt b/test/src/model/CommentTest.kt
index 28f717db..62f64a58 100644
--- a/test/src/model/CommentTest.kt
+++ b/test/src/model/CommentTest.kt
@@ -8,7 +8,7 @@ public class CommentTest {
     Test fun emptyDoc() {
         verifyModel("test/data/comments/emptyDoc.kt") { model ->
             with(model.members.single().members.single()) {
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
             }
         }
     }
@@ -16,7 +16,7 @@ public class CommentTest {
     Test fun emptyDocButComment() {
         verifyModel("test/data/comments/emptyDocButComment.kt") { model ->
             with(model.members.single().members.single()) {
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
             }
         }
     }
@@ -24,8 +24,8 @@ public class CommentTest {
     Test fun multilineDoc() {
         verifyModel("test/data/comments/multilineDoc.kt") { model ->
             with(model.members.single().members.single()) {
-                assertEquals("doc1".toRichString(), doc.summary)
-                assertEquals("doc2\ndoc3".toRichString(), doc.description)
+                assertEquals("doc1", doc.summary.toTestString())
+                assertEquals("doc2\ndoc3\n", doc.description.toTestString())
             }
         }
     }
@@ -33,8 +33,8 @@ public class CommentTest {
     Test fun multipleDocs() {
         verifyModel("test/data/comments/multipleDocs.kt") { model ->
             with(model.members.single().members.single()) {
-                assertEquals("doc1".toRichString(), doc.summary)
-                assertEquals("doc2\ndoc3".toRichString(), doc.description)
+                assertEquals("doc1", doc.summary.toTestString())
+                assertEquals("doc2\ndoc3", doc.description.toTestString())
             }
         }
     }
@@ -42,8 +42,8 @@ public class CommentTest {
     Test fun multilineDocWithComment() {
         verifyModel("test/data/comments/multilineDocWithComment.kt") { model ->
             with(model.members.single().members.single()) {
-                assertEquals("doc1".toRichString(), doc.summary)
-                assertEquals("doc2\ndoc3".toRichString(), doc.description)
+                assertEquals("doc1", doc.summary.toTestString())
+                assertEquals("doc2\ndoc3", doc.description.toTestString())
             }
         }
     }
@@ -51,7 +51,7 @@ public class CommentTest {
     Test fun oneLineDoc() {
         verifyModel("test/data/comments/oneLineDoc.kt") { model ->
             with(model.members.single().members.single()) {
-                assertEquals("doc".toRichString(), doc.summary)
+                assertEquals("doc", doc.summary.toTestString())
             }
         }
     }
@@ -59,7 +59,7 @@ public class CommentTest {
     Test fun oneLineDocWithComment() {
         verifyModel("test/data/comments/oneLineDocWithComment.kt") { model ->
             with(model.members.single().members.single()) {
-                assertEquals("doc".toRichString(), doc.summary)
+                assertEquals("doc", doc.summary.toTestString())
             }
         }
     }
@@ -67,7 +67,7 @@ public class CommentTest {
     Test fun oneLineDocWithEmptyLine() {
         verifyModel("test/data/comments/oneLineDocWithEmptyLine.kt") { model ->
             with(model.members.single().members.single()) {
-                assertEquals("doc".toRichString(), doc.summary)
+                assertEquals("doc", doc.summary.toTestString())
             }
         }
     }
@@ -76,24 +76,34 @@ public class CommentTest {
         verifyModel("test/data/comments/emptySection.kt") { model ->
             with(model.members.single().members.single()) {
                 assertEquals(NormalStyle, NormalStyle)
-                assertEquals("Summary".toRichString(), doc.summary)
+                assertEquals("Summary", doc.summary.toTestString())
                 assertEquals(2, doc.sections.count())
                 with (doc.sections["one"]!!) {
                     assertEquals("one", label)
-                    assertEquals(RichString.empty, text)
+                    assertEquals("", toTestString())
                 }
             }
         }
     }
 
+    Test fun explicitSummary() {
+        verifyModel("test/data/comments/explicitSummary.kt") { model ->
+            with(model.members.single().members.single()) {
+                assertEquals("Summary", doc.summary.toTestString())
+                assertEquals("Description", doc.description.toTestString())
+                assertEquals(2, doc.sections.count())
+            }
+        }
+    }
+
     Test fun section1() {
         verifyModel("test/data/comments/section1.kt") { model ->
             with(model.members.single().members.single()) {
-                assertEquals("Summary".toRichString(), doc.summary)
+                assertEquals("Summary", doc.summary.toTestString())
                 assertEquals(2, doc.sections.count())
                 with (doc.sections["one"]!!) {
                     assertEquals("one", label)
-                    assertEquals("section one".toRichString(), text)
+                    assertEquals("section one", toTestString())
                 }
             }
         }
@@ -102,15 +112,15 @@ public class CommentTest {
     Test fun section2() {
         verifyModel("test/data/comments/section2.kt") { model ->
             with(model.members.single().members.single()) {
-                assertEquals("Summary".toRichString(), doc.summary)
+                assertEquals("Summary", doc.summary.toTestString())
                 assertEquals(3, doc.sections.count())
                 with (doc.sections["one"]!!) {
                     assertEquals("one", label)
-                    assertEquals("section one".toRichString(), text)
+                    assertEquals("section one", toTestString())
                 }
                 with (doc.sections["two"]!!) {
                     assertEquals("two", label)
-                    assertEquals("section two".toRichString(), text)
+                    assertEquals("section two", toTestString())
                 }
             }
         }
@@ -119,11 +129,11 @@ public class CommentTest {
     Test fun sectionOnOneLine() {
         verifyModel("test/data/comments/sectionOnOneLine.kt") { model ->
             with(model.members.single().members.single()) {
-                assertEquals("Summary".toRichString(), doc.summary)
+                assertEquals("Summary", doc.summary.toTestString())
                 assertEquals(2, doc.sections.count())
                 with (doc.sections["one"]!!) {
                     assertEquals("one", label)
-                    assertEquals("same line".toRichString(), text)
+                    assertEquals("same line", toTestString())
                 }
             }
         }
@@ -132,11 +142,11 @@ public class CommentTest {
     Test fun emptySectionOnOneLine() {
         verifyModel("test/data/comments/emptySectionOnOneLine.kt") { model ->
             with(model.members.single().members.single()) {
-                assertEquals("Summary".toRichString(), doc.summary)
+                assertEquals("Summary", doc.summary.toTestString())
                 assertEquals(2, doc.sections.count())
                 with (doc.sections["one"]!!) {
                     assertEquals("one", label)
-                    assertEquals(RichString.empty, text)
+                    assertEquals("", toTestString())
                 }
             }
         }
@@ -145,12 +155,12 @@ public class CommentTest {
     Test fun multilineSection() {
         verifyModel("test/data/comments/multilineSection.kt") { model ->
             with(model.members.single().members.single()) {
-                assertEquals("Summary".toRichString(), doc.summary)
+                assertEquals("Summary", doc.summary.toTestString())
                 assertEquals(2, doc.sections.count())
                 with (doc.sections["one"]!!) {
                     assertEquals("one", label)
                     assertEquals("""line one
-line two""".toRichString(), text)
+line two""", toTestString())
                 }
             }
         }
@@ -159,11 +169,11 @@ line two""".toRichString(), text)
     Test fun sectionWithBracedLabel() {
         verifyModel("test/data/comments/sectionWithBracedLabel.kt") { model ->
             with(model.members.single().members.single()) {
-                assertEquals("Summary".toRichString(), doc.summary)
+                assertEquals("Summary", doc.summary.toTestString())
                 assertEquals(2, doc.sections.count())
                 with (doc.sections["this.label.is.really.long"]!!) {
                     assertEquals("this.label.is.really.long", label)
-                    assertEquals("section one".toRichString(), text)
+                    assertEquals("section one", toTestString())
                 }
             }
         }
diff --git a/test/src/model/FunctionTest.kt b/test/src/model/FunctionTest.kt
index f090fcd5..fe8b6397 100644
--- a/test/src/model/FunctionTest.kt
+++ b/test/src/model/FunctionTest.kt
@@ -10,7 +10,7 @@ public class FunctionTest {
             with(model.members.single().members.single()) {
                 assertEquals("fn", name)
                 assertEquals(DocumentationNode.Kind.Function, kind)
-                assertEquals("Function fn".toRichString(), doc.summary)
+                assertEquals("Function fn", doc.summary.toTestString())
                 assertEquals("Unit", detail(DocumentationNode.Kind.Type).name)
                 assertTrue(members.none())
                 assertTrue(links.none())
@@ -23,7 +23,7 @@ public class FunctionTest {
             with(model.members.single().members.single()) {
                 assertEquals("fn", name)
                 assertEquals(DocumentationNode.Kind.Function, kind)
-                assertEquals("Function with receiver".toRichString(), doc.summary)
+                assertEquals("Function with receiver", doc.summary.toTestString())
                 assertEquals("Unit", details.elementAt(0).name)
 
                 assertEquals(4, details.count())
@@ -32,7 +32,7 @@ public class FunctionTest {
                 with(details.elementAt(3)) {
                     assertEquals("<this>", name)
                     assertEquals(DocumentationNode.Kind.Receiver, kind)
-                    assertEquals(DocumentationContent.Empty, doc)
+                    assertEquals(Content.Empty, doc)
                     assertEquals("String", details.single().name)
                     assertTrue(members.none())
                     assertTrue(links.none())
@@ -48,7 +48,7 @@ public class FunctionTest {
             with(model.members.single().members.single()) {
                 assertEquals("generic", name)
                 assertEquals(DocumentationNode.Kind.Function, kind)
-                assertEquals("generic function".toRichString(), doc.summary)
+                assertEquals("generic function", doc.summary.toTestString())
 
                 assertEquals(4, details.count())
                 assertEquals("Unit", details.elementAt(0).name)
@@ -57,7 +57,7 @@ public class FunctionTest {
                 with(details.elementAt(3)) {
                     assertEquals("T", name)
                     assertEquals(DocumentationNode.Kind.TypeParameter, kind)
-                    assertEquals(DocumentationContent.Empty, doc)
+                    assertEquals(Content.Empty, doc)
                     assertTrue(details.none())
                     assertTrue(members.none())
                     assertTrue(links.none())
@@ -73,7 +73,7 @@ public class FunctionTest {
             with(model.members.single().members.single()) {
                 assertEquals("generic", name)
                 assertEquals(DocumentationNode.Kind.Function, kind)
-                assertEquals("generic function".toRichString(), doc.summary)
+                assertEquals("generic function", doc.summary.toTestString())
 
                 assertEquals(5, details.count())
                 assertEquals("Unit", details.elementAt(0).name)
@@ -82,11 +82,11 @@ public class FunctionTest {
                 with(details.elementAt(3)) {
                     assertEquals("T", name)
                     assertEquals(DocumentationNode.Kind.TypeParameter, kind)
-                    assertEquals(DocumentationContent.Empty, doc)
+                    assertEquals(Content.Empty, doc)
                     with(details.single()) {
                         assertEquals("R", name)
                         assertEquals(DocumentationNode.Kind.UpperBound, kind)
-                        assertEquals(DocumentationContent.Empty, doc)
+                        assertEquals(Content.Empty, doc)
                         assertTrue(details.none())
                         assertTrue(members.none())
                         assertTrue(links.none())
@@ -97,7 +97,7 @@ public class FunctionTest {
                 with(details.elementAt(4)) {
                     assertEquals("R", name)
                     assertEquals(DocumentationNode.Kind.TypeParameter, kind)
-                    assertEquals(DocumentationContent.Empty, doc)
+                    assertEquals(Content.Empty, doc)
                     assertTrue(members.none())
                     assertTrue(links.none())
                 }
@@ -113,10 +113,9 @@ public class FunctionTest {
             with(model.members.single().members.single()) {
                 assertEquals("function", name)
                 assertEquals(DocumentationNode.Kind.Function, kind)
-                assertEquals("Multiline".toRichString(), doc.summary)
+                assertEquals("Multiline", doc.summary.toTestString())
                 assertEquals("""Function
-Documentation""".toRichString()
-                             , doc.description)
+Documentation""", doc.description.toTestString())
 
                 assertEquals(4, details.count())
                 assertEquals("Unit", details.elementAt(0).name)
@@ -125,7 +124,7 @@ Documentation""".toRichString()
                 with(details.elementAt(3)) {
                     assertEquals("x", name)
                     assertEquals(DocumentationNode.Kind.Parameter, kind)
-                    assertEquals("parameter".toRichString(), doc.summary)
+                    assertEquals("parameter", doc.summary.toTestString())
                     assertEquals("Int", details.single().name)
                     assertTrue(members.none())
                     assertTrue(links.none())
diff --git a/test/src/model/PackageTest.kt b/test/src/model/PackageTest.kt
index b855ad7d..848fff3e 100644
--- a/test/src/model/PackageTest.kt
+++ b/test/src/model/PackageTest.kt
@@ -10,7 +10,7 @@ public class PackageTest {
             with(model.members.single()) {
                 assertEquals(DocumentationNode.Kind.Package, kind)
                 assertEquals("", name)
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
                 assertTrue(details.none())
                 assertTrue(members.none())
                 assertTrue(links.none())
@@ -23,7 +23,7 @@ public class PackageTest {
             with(model.members.single()) {
                 assertEquals(DocumentationNode.Kind.Package, kind)
                 assertEquals("simple", name)
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
                 assertTrue(details.none())
                 assertTrue(members.none())
                 assertTrue(links.none())
@@ -36,7 +36,7 @@ public class PackageTest {
             with(model.members.single()) {
                 assertEquals(DocumentationNode.Kind.Package, kind)
                 assertEquals("dot.name", name)
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
                 assertTrue(details.none())
                 assertTrue(members.none())
                 assertTrue(links.none())
@@ -50,14 +50,14 @@ public class PackageTest {
             with(model.members.single { it.name == "simple" }) {
                 assertEquals(DocumentationNode.Kind.Package, kind)
                 assertEquals("simple", name)
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
                 assertTrue(details.none())
                 assertTrue(members.none())
                 assertTrue(links.none())
             }
             with(model.members.single { it.name == "dot.name" }) {
                 assertEquals(DocumentationNode.Kind.Package, kind)
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
                 assertTrue(details.none())
                 assertTrue(members.none())
                 assertTrue(links.none())
@@ -71,7 +71,7 @@ public class PackageTest {
             with(model.members.elementAt(0)) {
                 assertEquals(DocumentationNode.Kind.Package, kind)
                 assertEquals("simple", name)
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
                 assertTrue(details.none())
                 assertTrue(members.none())
                 assertTrue(links.none())
diff --git a/test/src/model/PropertyTest.kt b/test/src/model/PropertyTest.kt
index 07651ce2..ed49bd6b 100644
--- a/test/src/model/PropertyTest.kt
+++ b/test/src/model/PropertyTest.kt
@@ -10,7 +10,7 @@ public class PropertyTest {
             with(model.members.single().members.single()) {
                 assertEquals("property", name)
                 assertEquals(DocumentationNode.Kind.Property, kind)
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
                 assertEquals("String", detail(DocumentationNode.Kind.Type).name)
                 assertTrue(members.none())
                 assertTrue(links.none())
@@ -23,7 +23,7 @@ public class PropertyTest {
             with(model.members.single().members.single()) {
                 assertEquals("property", name)
                 assertEquals(DocumentationNode.Kind.Property, kind)
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
                 assertEquals("String", detail(DocumentationNode.Kind.Type).name)
                 assertTrue(members.none())
                 assertTrue(links.none())
@@ -36,13 +36,13 @@ public class PropertyTest {
             with(model.members.single().members.single()) {
                 assertEquals("property", name)
                 assertEquals(DocumentationNode.Kind.Property, kind)
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
                 assertEquals("String", detail(DocumentationNode.Kind.Type).name)
                 assertTrue(links.none())
                 with(members.single()) {
                     assertEquals("<get-property>", name)
                     assertEquals(DocumentationNode.Kind.Function, kind)
-                    assertEquals(DocumentationContent.Empty, doc)
+                    assertEquals(Content.Empty, doc)
                     assertEquals("String", detail(DocumentationNode.Kind.Type).name)
                     assertTrue(links.none())
                     assertTrue(members.none())
@@ -56,7 +56,7 @@ public class PropertyTest {
             with(model.members.single().members.single()) {
                 assertEquals("property", name)
                 assertEquals(DocumentationNode.Kind.Property, kind)
-                assertEquals(DocumentationContent.Empty, doc)
+                assertEquals(Content.Empty, doc)
                 assertEquals(3, details.count())
                 with(details.elementAt(0)) {
                     assertEquals(DocumentationNode.Kind.Type, kind)
@@ -76,7 +76,7 @@ public class PropertyTest {
                 with(members.elementAt(0)) {
                     assertEquals("<get-property>", name)
                     assertEquals(DocumentationNode.Kind.Function, kind)
-                    assertEquals(DocumentationContent.Empty, doc)
+                    assertEquals(Content.Empty, doc)
                     assertEquals("String", detail(DocumentationNode.Kind.Type).name)
                     assertTrue(links.none())
                     assertTrue(members.none())
@@ -84,7 +84,7 @@ public class PropertyTest {
                 with(members.elementAt(1)) {
                     assertEquals("<set-property>", name)
                     assertEquals(DocumentationNode.Kind.Function, kind)
-                    assertEquals(DocumentationContent.Empty, doc)
+                    assertEquals(Content.Empty, doc)
                     assertEquals(4, details.count())
                     assertEquals("Unit", details.elementAt(0).name)
                     assertEquals("final", details.elementAt(1).name)
@@ -92,7 +92,7 @@ public class PropertyTest {
                     with(details.elementAt(3)) {
                         assertEquals("value", name)
                         assertEquals(DocumentationNode.Kind.Parameter, kind)
-                        assertEquals(DocumentationContent.Empty, doc)
+                        assertEquals(Content.Empty, doc)
                         assertEquals("String", detail(DocumentationNode.Kind.Type).name)
                         assertTrue(links.none())
                         assertTrue(members.none())