Documentation

This commit is contained in:
Oupson 2020-09-20 11:23:25 +02:00
parent 2606646ecb
commit 8dfe6cca47
2 changed files with 17 additions and 0 deletions

16
apng_library/Module.md Normal file
View File

@ -0,0 +1,16 @@
# Module apng_library
# Package oupson.apng
Use [oupson.apng.decoder.ApngDecoder] and [oupson.apng.encoder.ApngEncoder] for better performances.
# Package oupson.apng.chunks
Contain things related to chunk parsing.
# Package oupson.apng.decoder
Contain class for decode APNG.
a
# Package oupson.apng.encoder
Contain class for encoding APNG.
# Package oupson.apng.exceptions
Contain the custom exceptions thrown by this library.

View File

@ -47,6 +47,7 @@ repositories {
dokkaHtml.configure {
dokkaSourceSets {
named("main") {
includes.from("Module.md")
noAndroidSdkLink.set(false)
}
}