Merge branch '72-javadoc-updates' into dev

Author: greenrobot-team

build.gradle

@@ -22,8 +22,8 @@ buildscript {
         essentials_version = '3.1.0'
         junit_version = '4.13.1'
         mockito_version = '3.3.3'
-        kotlin_version = '1.4.10'
-        dokka_version = '0.10.1'
+        kotlin_version = '1.4.21'
+        dokka_version = '1.4.20'
 
         println "version=$ob_version"
         println "objectboxNativeDependency=$ob_native_dep"

ci/Jenkinsfile-Windows

@@ -1,6 +1,9 @@
+#!/usr/bin/env groovy
+
 String buildsToKeep = '500'
 
 String gradleArgs = '-Dorg.gradle.daemon=false --stacktrace'
+boolean isPublish = BRANCH_NAME == 'publish'
 
 // Note: using single quotes to avoid Groovy String interpolation leaking secrets.
 def internalRepoArgsBat = '-PinternalObjectBoxRepo=%MVN_REPO_URL% ' +
@@ -67,6 +70,18 @@ pipeline {
                 }
             }
         }
+
+        stage('package-javadoc-for-web') {
+            when { expression { return isPublish } }
+            steps {
+                bat "gradlew $gradleArgs $internalRepoArgsBat :objectbox-java:packageJavadocForWeb"
+            }
+            post {
+                always {
+                    archiveArtifacts artifacts: 'objectbox-java/build/dist/objectbox-java-web-api-docs.zip'
+                }
+            }
+        }
     }
 
     // For global vars see /jenkins/pipeline-syntax/globals

objectbox-java/build.gradle

@@ -38,11 +38,15 @@ javadoc {
 }
 
 // Note: use packageJavadocForWeb to get as ZIP.
-// Note: the style changes only work if using JDK 10+.
 task javadocForWeb(type: Javadoc) {
     group = 'documentation'
     description = 'Builds Javadoc incl. objectbox-java-api classes with web tweaks.'
 
+    javadocTool = javaToolchains.javadocToolFor {
+        // Note: the style changes only work if using JDK 10+, 11 is latest LTS.
+        languageVersion = JavaLanguageVersion.of(11)
+    }
+
     def srcApi = project(':objectbox-java-api').file('src/main/java/')
     if (!srcApi.directory) throw new GradleScriptException("Not a directory: ${srcApi}", null)
     // Hide internal API from javadoc artifact.

objectbox-kotlin/build.gradle

@@ -1,5 +1,5 @@
 buildscript {
-    ext.javadocDir = "$buildDir/docs/javadoc"
+    ext.javadocDir = file("$buildDir/docs/javadoc")
 }
 
 apply plugin: 'kotlin'
@@ -15,28 +15,32 @@ tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).configureEach {
     }
 }
 
-dokka {
-    outputFormat = 'html'
-    outputDirectory = javadocDir
+tasks.named("dokkaHtml") {
+    outputDirectory.set(javadocDir)
 
-    // Fix "Can't find node by signature": have to manually point to dependencies.
-    // https://github.com/Kotlin/dokka/wiki/faq#dokka-complains-about-cant-find-node-by-signature-
-    configuration{
-        externalDocumentationLink {
-            // Point to web javadoc for objectbox-java packages.
-            url = new URL("https://objectbox.io/docfiles/java/current/")
-            // Note: Using JDK 9+ package-list is now called element-list.
-            packageListUrl = new URL(url, "element-list")
+    dokkaSourceSets {
+        configureEach {
+            // Fix "Can't find node by signature": have to manually point to dependencies.
+            // https://github.com/Kotlin/dokka/wiki/faq#dokka-complains-about-cant-find-node-by-signature-
+            externalDocumentationLink {
+                // Point to web javadoc for objectbox-java packages.
+                url.set(new URL("https://objectbox.io/docfiles/java/current/"))
+                // Note: Using JDK 9+ package-list is now called element-list.
+                packageListUrl.set(new URL(url, "element-list"))
+            }
         }
     }
 }
 
-task javadocJar(type: Jar, dependsOn: dokka) {
+task javadocJar(type: Jar) {
+    dependsOn tasks.named("dokkaHtml")
+    group = 'build'
     archiveClassifier.set('javadoc')
     from "$javadocDir"
 }
 
 task sourcesJar(type: Jar) {
+    group = 'build'
     archiveClassifier.set('sources')
     from sourceSets.main.allSource
 }

objectbox-rxjava3/build.gradle

@@ -1,5 +1,5 @@
 buildscript {
-    ext.javadocDir = "$buildDir/docs/javadoc"
+    ext.javadocDir = file("$buildDir/docs/javadoc")
 }
 
 apply plugin: 'java-library'
@@ -16,18 +16,19 @@ tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).configureEach {
     }
 }
 
-dokka {
-    outputFormat = 'html'
-    outputDirectory = javadocDir
+tasks.named("dokkaHtml") {
+    outputDirectory.set(javadocDir)
 
-    // Fix "Can't find node by signature": have to manually point to dependencies.
-    // https://github.com/Kotlin/dokka/wiki/faq#dokka-complains-about-cant-find-node-by-signature-
-    configuration{
-        externalDocumentationLink {
-            // Point to web javadoc for objectbox-java packages.
-            url = new URL("https://objectbox.io/docfiles/java/current/")
-            // Note: Using JDK 9+ package-list is now called element-list.
-            packageListUrl = new URL(url, "element-list")
+    dokkaSourceSets {
+        configureEach {
+            // Fix "Can't find node by signature": have to manually point to dependencies.
+            // https://github.com/Kotlin/dokka/wiki/faq#dokka-complains-about-cant-find-node-by-signature-
+            externalDocumentationLink {
+                // Point to web javadoc for objectbox-java packages.
+                url.set(new URL("https://objectbox.io/docfiles/java/current/"))
+                // Note: Using JDK 9+ package-list is now called element-list.
+                packageListUrl.set(new URL(url, "element-list"))
+            }
         }
     }
 }
@@ -42,12 +43,15 @@ dependencies {
     testImplementation "org.mockito:mockito-core:$mockito_version"
 }
 
-task javadocJar(type: Jar, dependsOn: dokka) {
+task javadocJar(type: Jar) {
+    dependsOn tasks.named("dokkaHtml")
+    group = 'build'
     archiveClassifier.set('javadoc')
     from "$javadocDir"
 }
 
 task sourcesJar(type: Jar) {
+    group = 'build'
     archiveClassifier.set('sources')
     from sourceSets.main.allSource
 }