David Zhao

add Dokka for documentation

@@ -3,6 +3,7 @@ @@ -3,6 +3,7 @@
3 buildscript { 3 buildscript {
4 ext.kotlin_version = '1.4.31' 4 ext.kotlin_version = '1.4.31'
5 ext.java_version = JavaVersion.VERSION_1_8 5 ext.java_version = JavaVersion.VERSION_1_8
  6 + ext.dokka_version = '1.4.30'
6 repositories { 7 repositories {
7 google() 8 google()
8 mavenCentral() 9 mavenCentral()
@@ -19,6 +20,10 @@ buildscript { @@ -19,6 +20,10 @@ buildscript {
19 } 20 }
20 } 21 }
21 22
  23 +plugins {
  24 + id "org.jetbrains.dokka" version "$dokka_version"
  25 +}
  26 +
22 allprojects { 27 allprojects {
23 repositories { 28 repositories {
24 google() 29 google()
@@ -3,6 +3,9 @@ apply plugin: 'kotlin-android' @@ -3,6 +3,9 @@ apply plugin: 'kotlin-android'
3 apply plugin: 'kotlin-kapt' 3 apply plugin: 'kotlin-kapt'
4 apply plugin: 'kotlinx-serialization' 4 apply plugin: 'kotlinx-serialization'
5 apply plugin: 'com.google.protobuf' 5 apply plugin: 'com.google.protobuf'
  6 +apply plugin: 'org.jetbrains.dokka'
  7 +
  8 +import java.net.URL
6 9
7 android { 10 android {
8 compileSdkVersion 29 11 compileSdkVersion 29
@@ -55,6 +58,27 @@ protobuf { @@ -55,6 +58,27 @@ protobuf {
55 } 58 }
56 } 59 }
57 60
  61 +dokkaHtml {
  62 + moduleName.set("livekit-android-sdk")
  63 + dokkaSourceSets {
  64 + configureEach {
  65 + skipEmptyPackages.set(true)
  66 + includeNonPublic.set(false)
  67 + includes.from("module.md")
  68 +
  69 + sourceLink {
  70 + localDirectory.set(file("src/main/java"))
  71 +
  72 + // URL showing where the source code can be accessed through the web browser
  73 + remoteUrl.set(new URL(
  74 + "https://github.com/livekit/client-sdk-android/tree/master/livekit-android-sdk/src/main/java"))
  75 + // Suffix which is used to append the line number to the URL. Use #L for GitHub
  76 + remoteLineSuffix.set("#L")
  77 + }
  78 + }
  79 + }
  80 +}
  81 +
58 dependencies { 82 dependencies {
59 implementation fileTree(dir: 'libs', include: ['*.jar']) 83 implementation fileTree(dir: 'libs', include: ['*.jar'])
60 implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" 84 implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
  1 +# Module livekit-android-sdk
  2 +
  3 +Android Client SDK to [LiveKit](https://github.com/livekit/livekit-server).
  4 +
  5 +# Package io.livekit.android
  6 +
  7 +This package contains the initial `connect` function.
  8 +
  9 +# Package io.livekit.android.room
  10 +
  11 +Room is the primary class that manages the connection to the LiveKit Room. It exposes listeners that lets you hook into room events
  1 +pluginManagement {
  2 + repositories {
  3 + gradlePluginPortal()
  4 + jcenter()
  5 + }
  6 +}
1 include ':sample-app', ':livekit-android-sdk' 7 include ':sample-app', ':livekit-android-sdk'
2 rootProject.name='livekit-android' 8 rootProject.name='livekit-android'