From be3322a34ec905375710bdce828c1164e388128e Mon Sep 17 00:00:00 2001 From: Oupson Date: Sun, 20 Sep 2020 01:25:51 +0200 Subject: [PATCH] Added dokka for generating documentation. --- apng_library/build.gradle | 10 ++++++++++ .../src/main/java/oupson/apng/decoder/ApngDecoder.kt | 5 +++++ build.gradle | 2 ++ 3 files changed, 17 insertions(+) diff --git a/apng_library/build.gradle b/apng_library/build.gradle index 8c0ede3..326290a 100644 --- a/apng_library/build.gradle +++ b/apng_library/build.gradle @@ -1,6 +1,7 @@ apply plugin: 'com.android.library' apply plugin: 'kotlin-android' apply plugin: 'kotlin-android-extensions' +apply plugin: "org.jetbrains.dokka" android { compileSdkVersion 29 @@ -40,4 +41,13 @@ dependencies { repositories { mavenCentral() +} + + +dokkaHtml.configure { + dokkaSourceSets { + named("main") { + noAndroidSdkLink.set(false) + } + } } \ No newline at end of file diff --git a/apng_library/src/main/java/oupson/apng/decoder/ApngDecoder.kt b/apng_library/src/main/java/oupson/apng/decoder/ApngDecoder.kt index d1a05ac..8921836 100644 --- a/apng_library/src/main/java/oupson/apng/decoder/ApngDecoder.kt +++ b/apng_library/src/main/java/oupson/apng/decoder/ApngDecoder.kt @@ -19,6 +19,7 @@ import oupson.apng.BuildConfig import oupson.apng.Loader import oupson.apng.chunks.IHDR import oupson.apng.chunks.fcTL +import oupson.apng.decoder.ApngDecoder.Companion.decodeApng import oupson.apng.exceptions.BadApng import oupson.apng.exceptions.BadCRC import oupson.apng.utils.Utils @@ -28,6 +29,10 @@ import java.net.URL import java.nio.ByteBuffer import java.util.zip.CRC32 +/** + * An APNG Decoder. + * Call [decodeApng] + */ class ApngDecoder { interface Callback { /** diff --git a/build.gradle b/build.gradle index dfcbe45..4007085 100644 --- a/build.gradle +++ b/build.gradle @@ -3,6 +3,7 @@ buildscript { ext.kotlin_version = '1.4.10' ext.anko_version = '0.10.8' + ext.dokka_version = '1.4.0' repositories { google() jcenter() @@ -12,6 +13,7 @@ buildscript { classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" // NOTE: Do not place your application dependencies here; they belong // in the individual module build.gradle files + classpath "org.jetbrains.dokka:dokka-gradle-plugin:${dokka_version}" } }