Merge pull request #487 from NordicSemiconductor/migration/agp2.6

Migration to Dokka 2

Author: philips77

.github/workflows/deploy-all.yml

@@ -14,8 +14,8 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-java@v4
         with:
-          distribution: 'corretto'
-          java-version: '17'
+          distribution: 'jetbrains'
+          java-version: '21'
       - shell: bash
         # The script gets VERSION from the latest tag and replaces {{VERSION}} with it in
         # moustache/README.mo. Then, it commits the change using GitHub Action user.
@@ -38,8 +38,8 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-java@v4
         with:
-          distribution: 'corretto'
-          java-version: '17'
+          distribution: 'jetbrains'
+          java-version: '21'
       - shell: bash
         env:
           # The following env variables are used by Nexus plugin
@@ -62,8 +62,8 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-java@v4
         with:
-          distribution: 'corretto'
-          java-version: '17'
+          distribution: 'jetbrains'
+          java-version: '21'
       - shell: bash
         env:
           KEYSTORE_ALIAS: ${{ secrets.KEYSTORE_ALIAS }}

.github/workflows/deploy-to-nexus.yml

@@ -10,8 +10,8 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-java@v4
         with:
-          distribution: 'corretto'
-          java-version: '17'
+          distribution: 'jetbrains'
+          java-version: '21'
       - shell: bash
         env:
           # The following env variables are used by Nexus plugin

.github/workflows/deploy-to-play-store.yml

@@ -10,8 +10,8 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-java@v4
         with:
-          distribution: 'corretto'
-          java-version: '17'
+          distribution: 'jetbrains'
+          java-version: '21'
       - shell: bash
         env:
           KEYSTORE_ALIAS: ${{ secrets.KEYSTORE_ALIAS }}

.github/workflows/generate-readme.yml

@@ -10,8 +10,8 @@ jobs:
           fetch-depth: 0
       - uses: actions/setup-java@v4
         with:
-          distribution: 'corretto'
-          java-version: '17'
+          distribution: 'jetbrains'
+          java-version: '21'
       - shell: bash
         # The script gets VERSION from the latest tag and replaces {{VERSION}} with it in
         # moustache/README.mo. Then, it commits the change using GitHub Action user.

README.md

@@ -123,6 +123,8 @@ It is compatible with all Bootloader/DFU versions.
 
 See the [documentation](documentation) for more information.
 
+API documentation is located [here](https://nordicsemiconductor.github.io/Android-DFU-Library/html/index.html).
+
 ## Requirements
 
 The library is compatible with nRF51 and nRF52 devices with S-Series Soft Device and the

build.gradle.kts

@@ -1,12 +1,10 @@
 plugins {
     alias(libs.plugins.android.application) apply false
     alias(libs.plugins.kotlin.parcelize) apply false
-    alias(libs.plugins.kotlin.dokka) apply false
     alias(libs.plugins.hilt) apply false
     alias(libs.plugins.compose.compiler) apply false
 
     // Nordic plugins are defined in https://github.com/NordicSemiconductor/Android-Gradle-Plugins
-    alias(libs.plugins.nordic.application) apply false
     alias(libs.plugins.nordic.application.compose) apply false
     alias(libs.plugins.nordic.library) apply false
     alias(libs.plugins.nordic.library.compose) apply false
@@ -15,6 +13,19 @@ plugins {
     alias(libs.plugins.nordic.hilt) apply false
     alias(libs.plugins.nordic.nexus.android) apply false
 
+    // This plugin is used to generate Dokka documentation.
+    alias(libs.plugins.kotlin.dokka) apply false
+    // This applies Nordic look & feel to generated Dokka documentation.
+    // https://github.com/NordicSemiconductor/Android-Gradle-Plugins/blob/main/plugins/src/main/kotlin/NordicDokkaPlugin.kt
+    alias(libs.plugins.nordic.dokka) apply true
+
     alias(libs.plugins.google.services) apply false
     alias(libs.plugins.firebase.crashlytics) apply false
+}
+
+// Configure main Dokka page
+dokka {
+    pluginsConfiguration.html {
+        homepageLink.set("https://github.com/NordicSemiconductor/Android-DFU-Library")
+    }
 }