aboutsummaryrefslogtreecommitdiff
path: root/test
diff options
context:
space:
mode:
authorDmitry Jemerov <yole@jetbrains.com>2014-12-29 20:22:43 +0100
committerDmitry Jemerov <yole@jetbrains.com>2014-12-29 20:22:43 +0100
commitc43a437caa047f787bd3bb84ff612f505d0f8efc (patch)
treef91f6ee668a88ba5a73c0edd86bd45604d34571f /test
parentbadba07c1d151ff5a9cf623abecf7f2c906b5931 (diff)
downloaddokka-c43a437caa047f787bd3bb84ff612f505d0f8efc.tar.gz
dokka-c43a437caa047f787bd3bb84ff612f505d0f8efc.tar.bz2
dokka-c43a437caa047f787bd3bb84ff612f505d0f8efc.zip
don't generate "Description" header if nothing is going to follow it
Diffstat (limited to 'test')
-rw-r--r--test/data/format/emptyDescription.kt5
-rw-r--r--test/data/format/emptyDescription.md15
-rw-r--r--test/src/TestAPI.kt17
-rw-r--r--test/src/format/MarkdownFormatTest.kt16
4 files changed, 53 insertions, 0 deletions
diff --git a/test/data/format/emptyDescription.kt b/test/data/format/emptyDescription.kt
new file mode 100644
index 00000000..3ed81dfa
--- /dev/null
+++ b/test/data/format/emptyDescription.kt
@@ -0,0 +1,5 @@
+/**
+ * Function fn
+ */
+fun fn() {
+} \ No newline at end of file
diff --git a/test/data/format/emptyDescription.md b/test/data/format/emptyDescription.md
new file mode 100644
index 00000000..5e8c05c0
--- /dev/null
+++ b/test/data/format/emptyDescription.md
@@ -0,0 +1,15 @@
+[test](out.md) / [](out.md) / [fn](out.md)
+
+
+# fn
+
+
+```
+fun fn(): Unit
+```
+
+
+Function fn
+
+
+
diff --git a/test/src/TestAPI.kt b/test/src/TestAPI.kt
index 5a4b9863..a16a0b57 100644
--- a/test/src/TestAPI.kt
+++ b/test/src/TestAPI.kt
@@ -5,6 +5,8 @@ import com.intellij.openapi.util.*
import kotlin.test.fail
import org.jetbrains.dokka.*
import org.jetbrains.jet.lang.descriptors.DeclarationDescriptor
+import java.io.File
+import kotlin.test.assertEquals
public fun verifyModel(vararg files: String, verifier: (DocumentationModule) -> Unit) {
val messageCollector = object : MessageCollector {
@@ -49,6 +51,15 @@ public fun verifyModel(vararg files: String, verifier: (DocumentationModule) ->
Disposer.dispose(environment)
}
+public fun verifyOutput(path: String, outputGenerator: (DocumentationModule, StringBuilder) -> Unit) {
+ verifyModel(path) {
+ val output = StringBuilder()
+ outputGenerator(it, output)
+ val expectedOutput = File(path.replace(".kt", ".md")).readText()
+ assertEquals(expectedOutput, output.toString())
+ }
+}
+
fun StringBuilder.appendChildren(node: ContentNode): StringBuilder {
for (child in node.children) {
val childText = child.toTestString()
@@ -83,3 +94,9 @@ fun ContentNode.toTestString(): String {
appendNode(node)
}.toString()
}
+
+val tempLocation = Location(File("/tmp/out"))
+
+object InMemoryLocationService: LocationService {
+ override fun location(node: DocumentationNode) = tempLocation;
+}
diff --git a/test/src/format/MarkdownFormatTest.kt b/test/src/format/MarkdownFormatTest.kt
new file mode 100644
index 00000000..beb727da
--- /dev/null
+++ b/test/src/format/MarkdownFormatTest.kt
@@ -0,0 +1,16 @@
+package org.jetbrains.dokka.tests
+
+import org.junit.Test
+import org.jetbrains.dokka.*
+import java.io.File
+import kotlin.test.assertEquals
+
+public class MarkdownFormatTest {
+ private val markdownService = MarkdownFormatService(InMemoryLocationService, KotlinLanguageService())
+
+ Test fun emptyDescription() {
+ verifyOutput("test/data/format/emptyDescription.kt") { model, output ->
+ markdownService.appendNodes(tempLocation, output, model.members.single().members)
+ }
+ }
+}