David Zhao

add Dokka for documentation

... ... @@ -3,6 +3,7 @@
buildscript {
ext.kotlin_version = '1.4.31'
ext.java_version = JavaVersion.VERSION_1_8
ext.dokka_version = '1.4.30'
repositories {
google()
mavenCentral()
... ... @@ -19,6 +20,10 @@ buildscript {
}
}
plugins {
id "org.jetbrains.dokka" version "$dokka_version"
}
allprojects {
repositories {
google()
... ...
... ... @@ -3,6 +3,9 @@ apply plugin: 'kotlin-android'
apply plugin: 'kotlin-kapt'
apply plugin: 'kotlinx-serialization'
apply plugin: 'com.google.protobuf'
apply plugin: 'org.jetbrains.dokka'
import java.net.URL
android {
compileSdkVersion 29
... ... @@ -55,6 +58,27 @@ protobuf {
}
}
dokkaHtml {
moduleName.set("livekit-android-sdk")
dokkaSourceSets {
configureEach {
skipEmptyPackages.set(true)
includeNonPublic.set(false)
includes.from("module.md")
sourceLink {
localDirectory.set(file("src/main/java"))
// URL showing where the source code can be accessed through the web browser
remoteUrl.set(new URL(
"https://github.com/livekit/client-sdk-android/tree/master/livekit-android-sdk/src/main/java"))
// Suffix which is used to append the line number to the URL. Use #L for GitHub
remoteLineSuffix.set("#L")
}
}
}
}
dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
... ... @@ -74,4 +98,4 @@ dependencies {
testImplementation 'junit:junit:4.12'
androidTestImplementation 'androidx.test.ext:junit:1.1.2'
androidTestImplementation 'androidx.test.espresso:espresso-core:3.3.0'
}
\ No newline at end of file
}
... ...
# Module livekit-android-sdk
Android Client SDK to [LiveKit](https://github.com/livekit/livekit-server).
# Package io.livekit.android
This package contains the initial `connect` function.
# Package io.livekit.android.room
Room is the primary class that manages the connection to the LiveKit Room. It exposes listeners that lets you hook into room events
... ...
pluginManagement {
repositories {
gradlePluginPortal()
jcenter()
}
}
include ':sample-app', ':livekit-android-sdk'
rootProject.name='livekit-android'
... ...