Upgrade to Dokka 0.9.18 (#307)

* Upgrade to Dokka 0.9.18

* Upgrade Jackson to 2.9.8

* Remove unused import

* Update Kotlin example project

Author: fbenz

samples/kotlin-webmvc/build.gradle

@@ -4,7 +4,7 @@ buildscript {
         springAutoRestDocsVersion = "2.0.5-SNAPSHOT"
         springRestDocsVersion = "2.0.3.RELEASE"
         springBootVersion = "2.1.3.RELEASE"
-        dokkaVersion = "0.9.17"
+        dokkaVersion = "0.9.18"
     }
     repositories {
         jcenter()

samples/kotlin-webmvc/generated-docs/index.html

@@ -36,7 +36,7 @@
         <spring-restdocs.version>2.0.3.RELEASE</spring-restdocs.version>
         <spring-auto-restdocs.version>2.0.5-SNAPSHOT</spring-auto-restdocs.version>
         <kotlin.version>1.3.21</kotlin.version>
-        <dokka.version>0.9.17</dokka.version>
+        <dokka.version>0.9.18</dokka.version>
         <jsonDirectory>${project.build.directory}/generated-javadoc-json</jsonDirectory>
     </properties>
 

samples/kotlin-webmvc/pom.xml

@@ -18,9 +18,10 @@
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <kotlin.version>1.3.0</kotlin.version>
+        <kotlin.version>1.3.21</kotlin.version>
         <junit.version>4.12</junit.version>
-        <dokka.version>0.9.17</dokka.version>
+        <jackson.version>2.9.8</jackson.version>
+        <dokka.version>0.9.18</dokka.version>
         <kotlin.compiler.jvmTarget>1.8</kotlin.compiler.jvmTarget>
     </properties>
 
@@ -50,12 +51,12 @@
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-core</artifactId>
-            <version>2.9.4</version>
+            <version>${jackson.version}</version>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.module</groupId>
             <artifactId>jackson-module-kotlin</artifactId>
-            <version>2.9.4.1</version>
+            <version>${jackson.version}</version>
         </dependency>
     </dependencies>
 

spring-auto-restdocs-dokka-json/pom.xml

@@ -23,22 +23,21 @@ import com.google.inject.Binder
 import org.jetbrains.dokka.DefaultPackageListService
 import org.jetbrains.dokka.FormatService
 import org.jetbrains.dokka.Formats.DefaultAnalysisComponent
+import org.jetbrains.dokka.Formats.DefaultAnalysisComponentServices
+import org.jetbrains.dokka.Formats.KotlinAsKotlin
 import org.jetbrains.dokka.Formats.FormatDescriptor
 import org.jetbrains.dokka.Generator
-import org.jetbrains.dokka.Kotlin.KotlinDescriptorSignatureProvider
-import org.jetbrains.dokka.KotlinJavaDocumentationBuilder
 import org.jetbrains.dokka.KotlinLanguageService
-import org.jetbrains.dokka.KotlinPackageDocumentationBuilder
 import org.jetbrains.dokka.LanguageService
 import org.jetbrains.dokka.NodeLocationAwareGenerator
 import org.jetbrains.dokka.PackageListService
-import org.jetbrains.dokka.Samples.DefaultSampleProcessingService
-import org.jetbrains.dokka.Samples.SampleProcessingService
 import org.jetbrains.dokka.Utilities.bind
 import org.jetbrains.dokka.Utilities.toType
-import kotlin.reflect.KClass
 
-class JsonFormatDescriptor : FormatDescriptor, DefaultAnalysisComponent {
+class JsonFormatDescriptor
+    : FormatDescriptor,
+        DefaultAnalysisComponent,
+        DefaultAnalysisComponentServices by KotlinAsKotlin {
 
     override fun configureOutput(binder: Binder): Unit = with(binder) {
         bind<Generator>() toType NodeLocationAwareGenerator::class
@@ -47,9 +46,4 @@ class JsonFormatDescriptor : FormatDescriptor, DefaultAnalysisComponent {
         bind<FormatService>() toType JsonFormatService::class
         bind<PackageListService>() toType DefaultPackageListService::class
     }
-
-    override val javaDocumentationBuilderClass = KotlinJavaDocumentationBuilder::class
-    override val descriptorSignatureProvider = KotlinDescriptorSignatureProvider::class
-    override val packageDocumentationBuilderClass = KotlinPackageDocumentationBuilder::class
-    override val sampleProcessingService: KClass<out SampleProcessingService> = DefaultSampleProcessingService::class
 }

spring-auto-restdocs-dokka-json/src/main/kotlin/capital/scalable/dokka/json/JsonFormatDescriptor.kt

@@ -118,7 +118,10 @@ open class JsonOutputBuilder(
     }
 
     private fun extractContent(content: List<ContentNode>): String {
-        return content.mapIndexed { index, it -> extractContent(it, topLevel = index == 0) }.joinToString("")
+        return content
+                .mapIndexed { index, it -> extractContent(it, topLevel = index == 0) }
+                .joinToString("")
+                .trim()
     }
 
     private fun extractContent(content: ContentNode, topLevel: Boolean): String {
@@ -161,7 +164,9 @@ open class JsonOutputBuilder(
     private fun wrap(prefix: String, suffix: String, body: String): String = "$prefix$body$suffix"
 
     private fun joinChildren(block: ContentBlock): String =
-        block.children.joinToString("") { extractContent(it, topLevel = false) }
+        block.children
+                .joinToString("") { extractContent(it, topLevel = false) }
+                .trim()
 }
 
 open class JsonFormatService @Inject constructor(private val logger: DokkaLogger) : FormatService {

spring-auto-restdocs-dokka-json/src/main/kotlin/capital/scalable/dokka/json/JsonFormatService.kt

@@ -26,12 +26,12 @@ import com.intellij.openapi.util.Disposer
 import com.intellij.openapi.util.io.FileUtil
 import org.jetbrains.dokka.*
 import org.jetbrains.dokka.Utilities.DokkaAnalysisModule
+import org.jetbrains.kotlin.cli.common.config.ContentRoot
+import org.jetbrains.kotlin.cli.common.config.KotlinSourceRoot
 import org.jetbrains.kotlin.cli.common.messages.CompilerMessageLocation
 import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity
 import org.jetbrains.kotlin.cli.common.messages.MessageCollector
 import org.jetbrains.kotlin.cli.jvm.config.JavaSourceRoot
-import org.jetbrains.kotlin.config.ContentRoot
-import org.jetbrains.kotlin.config.KotlinSourceRoot
 import org.jetbrains.kotlin.descriptors.DeclarationDescriptor
 import org.junit.Assert
 import java.io.File

spring-auto-restdocs-dokka-json/src/test/kotlin/capital/scalable/dokka/json/TestAPI.kt

@@ -1,5 +1,5 @@
 {
-  "comment" : "Javadoc on a Java class <p> Next paragraph </p><ul> <li>Item 1</li> <li>Item 2</li> </ul>",
+  "comment" : "Javadoc on a Java class<p>Next paragraph</p><ul><li>Item 1</li> <li>Item 2</li></ul>",
   "fields" : {
     "someField" : {
       "comment" : "A Java field",