Make IntelliJ happy, update dependencies

.gitignore

@@ -25,10 +25,12 @@ proguard/
 
 # Intellij
 *.iml
-.idea/workspace.xml
+.idea/
 
 # Keystore files
 *.jks
 
 # Google Analytics
 /**/templates/meta.*
+
+.DS_Store

build.gradle

@@ -60,4 +60,9 @@ ext {
     project_description = 'Wrappers around code documentation CLI tools to produce JSON models, usable as libraries'
 
     license = rootProject.ext.ossLicenses['BSD']
-}
+}
+
+wrapper {
+    gradleVersion = Versions.gradleLatestVersion
+    distributionType = Wrapper.DistributionType.ALL
+}

buildSrc/src/main/kotlin/Libs.kt

@@ -1,108 +1,125 @@
-import kotlin.String
-
 /**
  * Generated by https://github.com/jmfayard/buildSrcVersions
  *
  * Update this file with
- *   `$ ./gradlew buildSrcVersions` */
+ *   `$ ./gradlew buildSrcVersions`
+ */
 object Libs {
-    const val com_eden_orchidplugin_gradle_plugin: String =
-            "com.eden.orchidPlugin:com.eden.orchidPlugin.gradle.plugin:" +
-            Versions.com_eden_orchidplugin_gradle_plugin
-
-    /**
-     * https://javaeden.github.io/Clog/Clog4j */
-    const val clog4j: String = "com.eden:Clog4j:" + Versions.clog4j
-
-    /**
-     * https://javaeden.github.io/Common/Common */
-    const val com_eden_common: String = "com.eden:Common:" + Versions.com_eden_common
-
-    const val shadow: String = "com.github.jengelman.gradle.plugins:shadow:" + Versions.shadow
-
-    const val gradle_bintray_plugin: String = "com.jfrog.bintray.gradle:gradle-bintray-plugin:" +
-            Versions.gradle_bintray_plugin
-
-    const val buildsrcversions: String = "de.fayard:buildSrcVersions:" + Versions.buildsrcversions
-
-    /**
-     * https://javaeden.github.io/Orchid/latest/core/ */
-    const val orchidcopper: String = "io.github.javaeden.orchid:OrchidCopper:" +
-            Versions.io_github_javaeden_orchid
-
-    /**
-     * https://javaeden.github.io/Orchid/latest/core/ */
-    const val orchiddocs: String = "io.github.javaeden.orchid:OrchidDocs:" +
-            Versions.io_github_javaeden_orchid
-
-    /**
-     * https://javaeden.github.io/Orchid/latest/core/ */
-    const val orchidgithub: String = "io.github.javaeden.orchid:OrchidGithub:" +
-            Versions.io_github_javaeden_orchid
-
-    /**
-     * https://javaeden.github.io/Orchid/latest/core/ */
-    const val orchidplugindocs: String = "io.github.javaeden.orchid:OrchidPluginDocs:" +
-            Versions.io_github_javaeden_orchid
-
-    /**
-     * https://strikt.io/ */
-    const val strikt_core: String = "io.strikt:strikt-core:" + Versions.strikt_core
-
-    /**
-     * https://groovy-lang.org */
-    const val groovy_all: String = "org.codehaus.groovy:groovy-all:" + Versions.groovy_all
-
-    const val dokka_fatjar: String = "org.jetbrains.dokka:dokka-fatjar:" + Versions.dokka_fatjar
-
-    /**
-     * https://kotlinlang.org/ */
-    const val kotlin_gradle_plugin: String = "org.jetbrains.kotlin:kotlin-gradle-plugin:" +
-            Versions.org_jetbrains_kotlin
-
-    /**
-     * https://kotlinlang.org/ */
-    const val kotlin_reflect: String = "org.jetbrains.kotlin:kotlin-reflect:" +
-            Versions.org_jetbrains_kotlin
-
-    /**
-     * https://kotlinlang.org/ */
-    const val kotlin_scripting_compiler_embeddable: String =
-            "org.jetbrains.kotlin:kotlin-scripting-compiler-embeddable:" +
-            Versions.org_jetbrains_kotlin
-
-    /**
-     * https://kotlinlang.org/ */
-    const val kotlin_serialization_unshaded: String =
-            "org.jetbrains.kotlin:kotlin-serialization-unshaded:" + Versions.org_jetbrains_kotlin
-
-    /**
-     * https://kotlinlang.org/ */
-    const val kotlin_serialization: String = "org.jetbrains.kotlin:kotlin-serialization:" +
-            Versions.org_jetbrains_kotlin
-
-    /**
-     * https://kotlinlang.org/ */
-    const val kotlin_stdlib_jdk8: String = "org.jetbrains.kotlin:kotlin-stdlib-jdk8:" +
-            Versions.org_jetbrains_kotlin
-
-    /**
-     * https://github.com/Kotlin/kotlinx.serialization */
-    const val kotlinx_serialization_runtime: String =
-            "org.jetbrains.kotlinx:kotlinx-serialization-runtime:" +
-            Versions.kotlinx_serialization_runtime
-
-    /**
-     * https://jsoup.org/ */
-    const val jsoup: String = "org.jsoup:jsoup:" + Versions.jsoup
-
-    /**
-     * https://junit.org/junit5/ */
-    const val junit_jupiter_api: String = "org.junit.jupiter:junit-jupiter-api:" +
-            Versions.org_junit_jupiter
-
-    /**
-     * https://junit.org/junit5/ */
-    const val junit_jupiter_engine: String = "org.junit.jupiter:junit-jupiter-engine:" +
-            Versions.org_junit_jupiter
+  const val com_eden_orchidplugin_gradle_plugin: String =
+      "com.eden.orchidPlugin:com.eden.orchidPlugin.gradle.plugin:" +
+      Versions.com_eden_orchidplugin_gradle_plugin
+
+  /**
+   * https://javaeden.github.io/Clog/Clog4j
+   */
+  const val clog4j: String = "com.eden:Clog4j:" + Versions.clog4j
+
+  /**
+   * https://javaeden.github.io/Common/Common
+   */
+  const val com_eden_common: String = "com.eden:Common:" + Versions.com_eden_common
+
+  const val shadow: String = "com.github.jengelman.gradle.plugins:shadow:" + Versions.shadow
+
+  const val gradle_bintray_plugin: String = "com.jfrog.bintray.gradle:gradle-bintray-plugin:" +
+      Versions.gradle_bintray_plugin
+
+  const val buildsrcversions: String = "de.fayard:buildSrcVersions:" + Versions.buildsrcversions
+
+  /**
+   * https://javaeden.github.io/Orchid/latest/core/
+   */
+  const val orchidcopper: String = "io.github.javaeden.orchid:OrchidCopper:" +
+      Versions.io_github_javaeden_orchid
+
+  /**
+   * https://javaeden.github.io/Orchid/latest/core/
+   */
+  const val orchiddocs: String = "io.github.javaeden.orchid:OrchidDocs:" +
+      Versions.io_github_javaeden_orchid
+
+  /**
+   * https://javaeden.github.io/Orchid/latest/core/
+   */
+  const val orchidgithub: String = "io.github.javaeden.orchid:OrchidGithub:" +
+      Versions.io_github_javaeden_orchid
+
+  /**
+   * https://javaeden.github.io/Orchid/latest/core/
+   */
+  const val orchidplugindocs: String = "io.github.javaeden.orchid:OrchidPluginDocs:" +
+      Versions.io_github_javaeden_orchid
+
+  /**
+   * https://strikt.io/
+   */
+  const val strikt_core: String = "io.strikt:strikt-core:" + Versions.strikt_core
+
+  /**
+   * https://groovy-lang.org
+   */
+  const val groovy_all: String = "org.codehaus.groovy:groovy-all:" + Versions.groovy_all
+
+  const val dokka_fatjar: String = "org.jetbrains.dokka:dokka-fatjar:" +
+      Versions.org_jetbrains_dokka
+
+  const val org_jetbrains_dokka_gradle_plugin: String =
+      "org.jetbrains.dokka:org.jetbrains.dokka.gradle.plugin:" + Versions.org_jetbrains_dokka
+
+  const val kotlin_gradle_plugin: String = "org.jetbrains.kotlin:kotlin-gradle-plugin:" +
+      Versions.org_jetbrains_kotlin
+
+  /**
+   * https://kotlinlang.org/
+   */
+  const val kotlin_reflect: String = "org.jetbrains.kotlin:kotlin-reflect:" +
+      Versions.org_jetbrains_kotlin
+
+  /**
+   * https://kotlinlang.org/
+   */
+  const val kotlin_scripting_compiler_embeddable: String =
+      "org.jetbrains.kotlin:kotlin-scripting-compiler-embeddable:" + Versions.org_jetbrains_kotlin
+
+  /**
+   * https://kotlinlang.org/
+   */
+  const val kotlin_serialization_unshaded: String =
+      "org.jetbrains.kotlin:kotlin-serialization-unshaded:" + Versions.org_jetbrains_kotlin
+
+  /**
+   * https://kotlinlang.org/
+   */
+  const val kotlin_serialization: String = "org.jetbrains.kotlin:kotlin-serialization:" +
+      Versions.org_jetbrains_kotlin
+
+  /**
+   * https://kotlinlang.org/
+   */
+  const val kotlin_stdlib_jdk8: String = "org.jetbrains.kotlin:kotlin-stdlib-jdk8:" +
+      Versions.org_jetbrains_kotlin
+
+  /**
+   * https://github.com/Kotlin/kotlinx.serialization
+   */
+  const val kotlinx_serialization_runtime: String =
+      "org.jetbrains.kotlinx:kotlinx-serialization-runtime:" +
+      Versions.kotlinx_serialization_runtime
+
+  /**
+   * https://jsoup.org/
+   */
+  const val jsoup: String = "org.jsoup:jsoup:" + Versions.jsoup
+
+  /**
+   * https://junit.org/junit5/
+   */
+  const val junit_jupiter_api: String = "org.junit.jupiter:junit-jupiter-api:" +
+      Versions.org_junit_jupiter
+
+  /**
+   * https://junit.org/junit5/
+   */
+  const val junit_jupiter_engine: String = "org.junit.jupiter:junit-jupiter-engine:" +
+      Versions.org_junit_jupiter
 }

buildSrc/src/main/kotlin/Versions.kt

@@ -1,50 +1,49 @@
+import kotlin.String
+
 /**
+ * Generated by https://github.com/jmfayard/buildSrcVersions
+ *
  * Find which updates are available by running
  *     `$ ./gradlew buildSrcVersions`
  * This will only update the comments.
  *
- * YOU are responsible for updating manually the dependency version. */
+ * YOU are responsible for updating manually the dependency version.
+ */
 object Versions {
-    const val com_eden_orchidplugin_gradle_plugin: String = "0.17.1" 
-
-    const val clog4j: String = "2.0.7" 
-
-    const val com_eden_common: String = "1.11.4" 
+  const val com_eden_orchidplugin_gradle_plugin: String = "0.17.1" // available: "0.17.4"
 
-    const val shadow: String = "5.1.0" 
+  const val clog4j: String = "2.0.7"
 
-    const val gradle_bintray_plugin: String = "1.8.4" 
+  const val com_eden_common: String = "1.11.4"
 
-    const val buildsrcversions: String = "0.3.2" 
+  const val shadow: String = "5.1.0"
 
-    const val io_github_javaeden_orchid: String = "0.17.1" 
+  const val gradle_bintray_plugin: String = "1.8.4"
 
-    const val strikt_core: String = "0.21.1" 
+  const val buildsrcversions: String = "0.4.2"
 
-    const val groovy_all: String = "2.5.7" 
+  const val io_github_javaeden_orchid: String = "0.17.4"
 
-    const val dokka_fatjar: String = "0.9.18" 
+  const val strikt_core: String = "0.21.1"
 
-    const val org_jetbrains_kotlin: String = "1.3.41" 
+  const val groovy_all: String = "2.5.8"
 
-    const val kotlinx_serialization_runtime: String = "0.11.0" // available: "0.11.2-1.3.50-eap-5"
+  const val org_jetbrains_dokka: String = "0.9.18"
 
-    const val jsoup: String = "1.12.1" 
+  const val org_jetbrains_kotlin: String = "1.3.50"
 
-    const val org_junit_jupiter: String = "5.5.1" 
+  const val kotlinx_serialization_runtime: String = "0.12.0"
 
-    /**
-     *
-     *   To update Gradle, edit the wrapper file at path:
-     *      ./gradle/wrapper/gradle-wrapper.properties
-     */
-    object Gradle {
-        const val runningVersion: String = "5.5.1"
+  const val jsoup: String = "1.12.1"
 
-        const val currentVersion: String = "5.5.1"
+  const val org_junit_jupiter: String = "5.5.1"
 
-        const val nightlyVersion: String = "5.7-20190726220034+0000"
+  /**
+   *
+   * See issue 19: How to update Gradle itself?
+   * https://github.com/jmfayard/buildSrcVersions/issues/19
+   */
+  const val gradleLatestVersion: String = "5.6.1"
 
-        const val releaseCandidate: String = ""
-    }
+  const val gradleCurrentVersion: String = "5.6"
 }

common/common-models/src/main/kotlin/CommentComponent.kt

@@ -19,5 +19,7 @@ data class CommentComponent(
     companion object {
         const val TEXT = "text"
         const val TYPE_NAME = "typeName"
+        const val LINK = "link"
+        const val PUNCTUATION = "punctuation"
     }
 }

common/common-runner/src/main/kotlin/BaseDocInvoker.kt

@@ -10,7 +10,7 @@ import java.nio.file.StandardCopyOption
 import java.util.concurrent.Executors
 
 abstract class BaseDocInvoker<T : ModuleDoc>(
-    private val cacheDir: Path
+    protected val cacheDir: Path
 ) : DocInvoker<T> {
 
     protected abstract val formatterJarName: String

gradle/groups/formatters.gradle

@@ -1,4 +1,5 @@
 apply plugin: 'kotlin'
+apply plugin: 'kotlinx-serialization'
 apply plugin: 'com.jfrog.bintray'
 apply plugin: 'maven-publish'
 
@@ -16,6 +17,7 @@ repositories {
 dependencies {
     api(Libs.com_eden_common)
     api(Libs.clog4j)
+    api(Libs.kotlin_reflect)
 
     // testing
     testRuntimeOnly(Libs.junit_jupiter_engine)
@@ -43,4 +45,4 @@ test {
 }
 test.outputs.upToDateWhen {false}
 
-apply from: "${rootProject.rootDir}/gradle/actions/publish.gradle"
+apply from: "${rootProject.rootDir}/gradle/actions/publish.gradle"

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,5 @@
-#Thu Jun 06 10:28:52 CDT 2019
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.1-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.5.1-all.zip