Dokka 1.9.2

syslogic · syslogic · commit 6be2c87563be · 2025-08-09T22:28:47.000+02:00
diff --git a/.github/workflows/android-ci.yml b/.github/workflows/android-ci.yml
@@ -14,7 +14,7 @@ on:
 
 jobs:
   build:
-    name: 🎉 Gradle Build
+    name: 🎉 Build Android Library
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -33,55 +33,43 @@ jobs:
           distribution: corretto
           java-version: '17'
 
+      # https://github.com/gradle/actions/blob/main/docs/setup-gradle.md
       - name: Setup Gradle
         uses: gradle/actions/setup-gradle@v4
         with:
-          gradle-version: '9.0.0'
-          build-scan-terms-of-use-url: "https://gradle.com/terms-of-service"
-          build-scan-terms-of-use-agree: "yes"
-          build-scan-publish: false
+          cache-encryption-key: ${{ SECRETS.GRADLE_ENCRYPTION_KEY }}
+          cache-cleanup: always
+
+      # Check out the GPR Maintenance plugin source code.
+      # This will replicate the local directory structure.
+      - name: Check out GPR Maintenance plugin
+        run: git clone https://github.com/syslogic/gpr-maintenance-gradle-plugin.git ./buildSrc
 
       # Run Gradle tasks
-      - name: GPR Publication of module :library
+      - name: Publish :library
         env:
           GITHUB_ACTOR: ${{ GITHUB.REPOSITORY_OWNER }}
           GITHUB_TOKEN: ${{ SECRETS.GITHUB_TOKEN }}
         run: |
-          gradle --no-daemon :library:lint :library:assembleRelease :library:publishDefaultPublicationToGitHubPackagesRepository
+          mkdir build
+          chmod +x ./gradlew
+          ./gradlew --max-workers=2 :library:lint :library:publishMavenPublicationToGitHubPackagesRepository
           ls -la ./library/build/outputs/aar | grep aar
 
-      # Run Gradle tasks
-      - name: Build module :mobile
-        if: false
-        run: gradle :mobile:lint :mobile:bundleDebug
-
       # https://github.com/actions/upload-artifact
       - name: 📦 Retain Artifacts (Release AAR)
         id: retain-library-aar
         uses: actions/upload-artifact@v4
         with:
-          name: androidx-github-lib
+          name: androidx-github-api
           path: ./library/build/outputs/aar/*.aar
           retention-days: 14
 
-      # https://github.com/actions/upload-artifact
-      - name: 📦 Retain Artifacts (AAB)
-        id: retain-app-debug-aab
-        uses: actions/upload-artifact@v4
-        with:
-          name: androidx-github
-          path: |
-            ./mobile/build/outputs/bundle/release/*.aab
-            ./mobile/build/outputs/bundle/debug/*.aab
-          retention-days: 14
-
       # https://github.com/actions/upload-artifact
       - name: 📦 Retain Artifacts (Lint Results)
         id: retain-lint-results
         uses: actions/upload-artifact@v4
         with:
           name: androidx-github-lint
-          path: |
-            ./library/build/reports/*
-            ./mobile/build/reports/*
+          path: ./library/build/reports/*
           retention-days: 14
diff --git a/.idea/runConfigurations/testDebugUnitTestCoverage.xml b/.idea/runConfigurations/testDebugUnitTestCoverage.xml
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -5,6 +5,8 @@ import java.io.FileInputStream
 plugins {
     alias(libs.plugins.android.application) apply false
     alias(libs.plugins.android.library) apply false
+    alias(libs.plugins.jetbrains.dokka) apply false
+    alias(libs.plugins.maven.publish) apply false
 }
 
 /* JitPack: use tag as versionName. */
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -9,6 +9,8 @@ android_min_sdk              = '22'
 # Gradle Plugins
 kotlin                       = '2.2.0'
 maven_publish                = '0.34.0'
+jetbrains_dokka              = '1.9.20'
+gpr_maintenance              = '1.0.0'
 android_gradle_plugin        = '8.12.0'
 material_design              = '1.12.0'
 retrofit                     = '3.0.0'
@@ -41,6 +43,11 @@ android_application          = { id = "com.android.application", version.ref = "
 android_library              = { id = "com.android.library", version.ref = "android_gradle_plugin" }
 androidx_room                = { id = "androidx.room", version.ref = "androidx_room" }
 maven_publish                = { id = "com.vanniktech.maven.publish", version.ref = "maven_publish" }
+jetbrains_dokka              = { id = "org.jetbrains.dokka", version.ref = "jetbrains_dokka" }
+
+# git clone https://github.com/syslogic/gpr-maintenance-gradle-plugin.git ./buildSrc
+gpr_maintenance              = { id = "io.syslogic.gpr.maintenance" }
+
 [libraries]
 material_design              = { module = "com.google.android.material:material", version.ref = "material_design" }
 gson                         = { module = "com.google.code.gson:gson", version.ref = "gson" }
diff --git a/library/build.gradle b/library/build.gradle
@@ -1,8 +1,9 @@
 plugins {
     alias(libs.plugins.android.library)
     alias(libs.plugins.androidx.room)
+    alias(libs.plugins.jetbrains.dokka)
     alias(libs.plugins.maven.publish)
-    // id("io.syslogic.gpr.maintenance")
+    alias(libs.plugins.gpr.maintenance)
 }
 
 group = "io.syslogic"
@@ -58,6 +59,13 @@ android {
         abortOnError = false
         showAll = false
     }
+
+    publishing {
+        singleVariant("library") {
+            withSourcesJar()
+            withJavadocJar()
+        }
+    }
 }
 
 dependencies {
@@ -108,16 +116,15 @@ tasks.register("javadoc", Javadoc) {
     classpath += fileTree(dir: project.file("build/tmp/aarsToJars/").absolutePath)
     classpath += implCls
     exclude("**/BuildConfig.java", "**/R.java", "**/*.kt")
-    exclude("androidx.sqlite.db.SupportSQLiteDatabase")
     failOnError = false
 
     // options.verbose()
     // javadoc: warning - The code being documented uses modules but the packages
     // defined in https://developer.android.com/reference/ are in the unnamed module.
     options.links "https://docs.oracle.com/en/java/javase/17/docs/api/"
     options.linksOffline "https://developer.android.com/reference", "${android.sdkDirectory}/docs/reference"
-    options.linkSource true
-    options.author true
+    options.linkSource = true
+    options.author = true
 
     onlyIf {
         project.file("build/intermediates/aar_main_jar").exists()
@@ -130,19 +137,19 @@ tasks.register("javadoc", Javadoc) {
                 .filter { it.name.endsWith(".aar") }
                 .each { aar ->
                     copy {
-                        from zipTree(aar)
-                        include "**/classes.jar"
-                        into project.file("build/tmp/aarsToJars/${aar.name.replace(".aar", "")}/")
+                        from(zipTree(aar))
+                        include("**/classes.jar")
+                        into(project.file("build/tmp/aarsToJars/${aar.name.replace(".aar", "")}/"))
                     }
         }
 
         // provide JAR, which contains the generated data-binding classes
-        def aar_main = project.file("build/intermediates/aar_main_jar")
-        if (aar_main.exists()) {
+        def aarMain = project.file("build/intermediates/aar_main_jar")
+        if (aarMain.exists()) {
             copy {
-                from aar_main
-                include "**/classes.jar"
-                into project.file("build/tmp/aarsToJars/aar_main_jar/")
+                from(aarMain)
+                include("**/classes.jar")
+                into(project.file("build/tmp/aarsToJars/aar_main_jar/"))
             }
         }
     }
@@ -163,16 +170,32 @@ tasks.register('sourcesJar', Jar) {
     archiveClassifier.set('sources')
 }
 
-artifacts {
-    archives(javadocJar)
-    archives(sourcesJar)
-}
-
 afterEvaluate {
     publishing {
-
+        publications {
+            register(MavenPublication) {
+                from components["release"]
+                groupId = "${group_id}"
+                artifactId = "${artifact_id}"
+                version = libs.versions.app.version.name.get()
+                artifacts {
+                    archives(javadocJar)
+                    archives(sourcesJar)
+                }
+                pom {
+                    name = "${plugin_name}"
+                    description = "${plugin_desc}"
+                    url = "https://github.com/${github_handle}/${artifact_id}"
+                    scm {
+                        connection = "scm:git:git://github.com/${github_handle}/${artifact_id}.git"
+                        developerConnection = "scm:git:ssh://github.com/${github_handle}/${artifact_id}.git"
+                        url = "https://github.com/${github_handle}/${artifact_id}/"
+                    }
+                }
+            }
+        }
         repositories {
-             maven {
+            maven {
                 name = "GitHubPackages"
                 url = uri("https://maven.pkg.github.com/${project.ext.get("github_handle")}/${project.ext.get("artifact_id")}")
                 if (System.getenv("GITHUB_ACTOR") != null && System.getenv("GITHUB_ACTOR") != null) {
@@ -183,25 +206,6 @@ afterEvaluate {
                 }
             }
         }
-
-        publications {
-            Default(MavenPublication) {
-                from(components.getByName("release"))
-                groupId = "${project.ext.get("group_id")}"
-                artifactId = "${project.ext.get("artifact_id")}"
-                version = libs.versions.app.version.name.get()
-                pom {
-                    name = "${project.ext.get("plugin_name")}"
-                    description = "${project.ext.get("plugin_desc")}"
-                    url = "https://github.com/${project.ext.get("github_handle")}/${project.ext.get("artifact_id")}"
-                    scm {
-                        connection = "scm:git:git://github.com/${project.ext.get("github_handle")}/${project.ext.get("artifact_id")}.git"
-                        developerConnection = "scm:git:ssh://github.com/${project.ext.get("github_handle")}/${project.ext.get("artifact_id")}.git"
-                        url = "https://github.com/${project.ext.get("github_handle")}/${project.ext.get("artifact_id")}/"
-                    }
-                }
-            }
-        }
     }
 }
 
@@ -210,7 +214,7 @@ if (pluginManager.hasPlugin("io.syslogic.gpr.maintenance")) {
     gpr {
         groupId = project.ext.get("group_id")        // group
         packageName = project.ext.get("artifact_id") // repo
-        listPackagesAfterPublish = true
+        listPackagesAfterPublish = false
         deleteLastVersion = true
     }
-}
+}
diff --git a/library/src/main/java/io/syslogic/github/api/room/Abstraction.java b/library/src/main/java/io/syslogic/github/api/room/Abstraction.java
@@ -7,7 +7,6 @@
 import androidx.room.Database;
 import androidx.room.Room;
 import androidx.room.RoomDatabase;
-import androidx.sqlite.db.SupportSQLiteDatabase;
 
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
@@ -82,13 +81,7 @@ public static Abstraction getInstance(@NonNull Context context) {
         if (sInstance == null) {
             Builder<Abstraction> builder = Room
                 .databaseBuilder(context.getApplicationContext(), Abstraction.class, fileName)
-                .createFromAsset(fileName)
-                .addCallback(new Callback() {
-                    @Override
-                    public void onCreate(@NonNull SupportSQLiteDatabase db) {
-                        super.onCreate(db);
-                    }
-                });
+                .createFromAsset(fileName);
             sInstance = builder.build();
         }
         return sInstance;

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,8 @@ import java.io.FileInputStream`
`5`	`5`	`plugins {`
`6`	`6`	`alias(libs.plugins.android.application) apply false`
`7`	`7`	`alias(libs.plugins.android.library) apply false`
	`8`	`+ alias(libs.plugins.jetbrains.dokka) apply false`
	`9`	`+ alias(libs.plugins.maven.publish) apply false`
`8`	`10`	`}`
`9`	`11`
`10`	`12`	`/* JitPack: use tag as versionName. */`