Merge pull request #182 from NordicSemiconductor/documentation

Documentation regenerated using Dokka 2

Author: philips77

README.md

@@ -41,7 +41,9 @@ Current status:
     - [ ] GATT operations
     - [ ] Mock implementation
 
-## Usage
+## Documentation
+
+Dokka documentation can be found [here](https://nordicsemiconductor.github.io/Kotlin-BLE-Library/html/index.html).
 
 ### Scanning
 
@@ -143,7 +145,7 @@ remoteService.characteristics.forEach { remoteCharacteristic ->
 }
 ```
 
-#### Subscibing to value changes
+#### Subscribing to value changes
 
 ```kotlin
 remoteService.characteristics.forEach { remoteCharacteristic ->

advertiser-android-mock/Module.md

@@ -0,0 +1,10 @@
+# Module advertiser-android-mock
+
+A mock implementation for the Bluetooth Low Energy advertiser on Android.
+
+This module provides a mock version of the Bluetooth LE advertiser, which can be used for testing 
+purposes without requiring actual Bluetooth hardware.
+
+# Package no.nordicsemi.kotlin.ble.advertiser.android.mock
+
+This package contains a Factory method to create a mock Android implementation for the Bluetooth LE Advertiser.

advertiser-android-mock/build.gradle.kts

@@ -37,7 +37,7 @@ plugins {
 group = "no.nordicsemi.kotlin.ble"
 
 nordicNexusPublishing {
-    POM_ARTIFACT_ID = "advertiser-mock"
+    POM_ARTIFACT_ID = "advertiser-android-mock"
     POM_NAME = "Nordic Kotlin BLE library"
     POM_DESCRIPTION = "Nordic Kotlin BLE library"
     POM_URL = "https://github.com/NordicSemiconductor/Kotlin-BLE-Library"
@@ -52,3 +52,9 @@ dependencies {
 
     implementation(libs.slf4j)
 }
+
+dokka {
+    dokkaSourceSets.named("main") {
+        includes.from("Module.md")
+    }
+}

advertiser-android/Module.md

@@ -0,0 +1,7 @@
+# Module advertiser-android
+
+Android implementation for the Bluetooth Low Energy advertiser.
+
+# Package no.nordicsemi.kotlin.ble.advertiser.android
+
+This package contains a Factory method to create an Android implementation for the Bluetooth LE Advertiser.

advertiser-android/build.gradle.kts

@@ -59,4 +59,10 @@ dependencies {
     api(libs.kotlinx.coroutines.android)
 
     implementation(libs.slf4j)
+}
+
+dokka {
+    dokkaSourceSets.named("main") {
+        includes.from("Module.md")
+    }
 }

advertiser-core-android/Module.md

@@ -0,0 +1,8 @@
+# Module advertiser-core-android
+
+Set of core classes providing the common functionality for Bluetooth Low Energy advertising on Android.
+
+# Package no.nordicsemi.kotlin.ble.advertiser.android
+
+This package contains the common Android implementation for the Bluetooth LE Advertiser functionality,
+used by the Android native and mock implementations.

advertiser-core-android/build.gradle.kts

@@ -50,3 +50,13 @@ dependencies {
     api(project(":advertiser-core"))
     api(project(":core-android"))
 }
+
+dokka {
+    dokkaSourceSets.named("main") {
+        includes.from("Module.md")
+        perPackageOption {
+            matchingRegex.set("no.nordicsemi.kotlin.ble.advertiser.android.internal")
+            suppress.set(true)
+        }
+    }
+}

advertiser-core/Module.md

@@ -0,0 +1,11 @@
+# Module advertiser-core
+
+Platform independent classes providing the core functionality for Bluetooth Low Energy advertising.
+
+# Package no.nordicsemi.kotlin.ble.advertiser
+
+This package contains the common interface for the Bluetooth LE Advertiser.
+
+# Package no.nordicsemi.kotlin.ble.advertiser.exception
+
+A package containing exceptions related to Bluetooth LE advertising operations.

advertiser-core/build.gradle.kts

@@ -49,3 +49,9 @@ nordicNexusPublishing {
 dependencies {
     api(project(":core"))
 }
+
+dokka {
+    dokkaSourceSets.named("main") {
+        includes.from("Module.md")
+    }
+}

build.gradle.kts

@@ -38,9 +38,14 @@ plugins {
     alias(libs.plugins.kotlin.serialization) apply false
     alias(libs.plugins.kotlin.parcelize) apply false
     alias(libs.plugins.kotlin.android) apply false
-    alias(libs.plugins.kotlin.dokka)
     alias(libs.plugins.compose.compiler) 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
+
     // 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
@@ -54,10 +59,9 @@ plugins {
     alias(libs.plugins.nordic.nexus.jvm) apply false
 }
 
-subprojects {
-    apply(plugin = "org.jetbrains.dokka")
-}
-
-tasks.dokkaHtmlMultiModule.configure {
-    outputDirectory.set(rootDir.resolve("docs"))
-}
+// Configure main Dokka page
+dokka {
+    pluginsConfiguration.html {
+        homepageLink.set("https://github.com/NordicSemiconductor/Kotlin-BLE-Library")
+    }
+}