Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,17 @@ jobs:
working-directory: android
run: ./gradlew assembleDebug

- name: Generate Documentation
working-directory: android
run: ./gradlew :lib:dokkaHtml

- name: Upload Documentation
uses: actions/upload-artifact@v4
with:
name: dokka-html
path: android/lib/build/dokka/html
retention-days: 1

wasm:
runs-on: ubuntu-latest
permissions:
Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,14 @@ Unit tests for the C wrapper logic (e.g., BMP conversion) can be run without Ems
```bash
bash test/run_tests.sh
```

## Generate Documentation

To generate the API documentation (KDoc), run the following command:

```bash
cd android
./gradlew :lib:dokkaHtml
```

The generated documentation will be available in `android/lib/build/dokka/html`.
2 changes: 2 additions & 0 deletions android/gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ composeBom = "2025.12.01"
appcompat = "1.7.1"
material = "1.13.0"
coroutines = "1.10.2"
dokka = "1.9.20"

[libraries]
androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
Expand All @@ -38,3 +39,4 @@ kotlinx-coroutines-test = { group = "org.jetbrains.kotlinx", name = "kotlinx-cor
android-application = { id = "com.android.application", version.ref = "agp" }
kotlin-compose = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
android-library = { id = "com.android.library", version.ref = "agp" }
dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
1 change: 1 addition & 0 deletions android/lib/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
plugins {
alias(libs.plugins.android.library)
alias(libs.plugins.dokka)
}

android {
Expand Down
Loading