add dokka android plugin to add the @hide anotation

nicholasala · Oct 28, 2024 · 0255ab1 · 0255ab1
1 parent be71fd0
commit 0255ab1
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -50,6 +50,7 @@ afterEvaluate {
 buildscript {
     dependencies {
         classpath(libs.dokka.base)
+        classpath(libs.dokka.android)
     }
 }
 
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -19,7 +19,6 @@
 
 [versions]
 agp = "8.7.1"
-dokkaBase = "1.9.20"
 kotlin = "2.0.20-Beta2"
 coreKtx = "1.13.1"
 junit = "4.13.2"
@@ -48,11 +47,10 @@ reorderable = "2.4.0-alpha02"
 media3Session = "1.4.1"
 media3ExoplayerDash = "1.4.1"
 adaptiveAndroid = "1.0.0"
-dockaVersion = "1.9.20"
+dokkaVersion = "1.9.20"
 
 [libraries]
 androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
-dokka-base = { module = "org.jetbrains.dokka:dokka-base", version.ref = "dokkaBase" }
 junit = { group = "junit", name = "junit", version.ref = "junit" }
 androidx-junit = { group = "androidx.test.ext", name = "junit", version.ref = "junitVersion" }
 androidx-espresso-core = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "espressoCore" }
@@ -81,14 +79,15 @@ androidx-ui-graphics = { group = "androidx.compose.ui", name = "ui-graphics" }
 androidx-ui-tooling-preview = { group = "androidx.compose.ui", name = "ui-tooling-preview" }
 androidx-ui-test-manifest = { group = "androidx.compose.ui", name = "ui-test-manifest" }
 androidx-ui-test-junit4 = { group = "androidx.compose.ui", name = "ui-test-junit4" }
-newplayer = { group = "com.github.theScrabi.NewPlayer", name = "new-player", version.ref = "newplayer" }
 okhttp-android = { group = "com.squareup.okhttp3", name = "okhttp-android", version.ref = "okhttpAndroid" }
 coil-compose = { group = "io.coil-kt", name = "coil-compose", version.ref = "coil" }
 reorderable = { group = "sh.calvin.reorderable", name = "reorderable", version.ref = "reorderable" }
 androidx-media3-session = { group = "androidx.media3", name = "media3-session", version.ref = "media3Session" }
 androidx-media3-exoplayer-dash = { group = "androidx.media3", name = "media3-exoplayer-dash", version.ref = "media3ExoplayerDash" }
 androidx-adaptive-android = { group = "androidx.compose.material3.adaptive", name = "adaptive-android", version.ref = "adaptiveAndroid" }
-
+dokka-base = { module = "org.jetbrains.dokka:dokka-base", version.ref = "dokkaVersion" }
+dokka-android = {module = "org.jetbrains.dokka:android-documentation-plugin", version.ref = "dokkaVersion" }
+newplayer = { group = "com.github.theScrabi.NewPlayer", name = "new-player", version.ref = "newplayer" }
 
 
 [plugins]
@@ -99,4 +98,4 @@ androidHilt = { id = "com.google.dagger.hilt.android", version.ref = "hiltAndroi
 kotlinAndroidKsp = { id = "com.google.devtools.ksp", version.ref = "kspVersion" }
 kotlinParcelize = { id = "org.jetbrains.kotlin.plugin.parcelize", version.ref = "kotlinParcelize" }
 android-library = { id = "com.android.library", version.ref = "agp" }
-dokka-base = { id = "org.jetbrains.dokka", version.ref = "dockaVersion" }
+dokka-base = { id = "org.jetbrains.dokka", version.ref = "dokkaVersion" }
diff --git a/new-player/src/main/java/net/newpipe/newplayer/uiModel/InternalNewPlayerViewModel.kt b/new-player/src/main/java/net/newpipe/newplayer/uiModel/InternalNewPlayerViewModel.kt
@@ -25,6 +25,7 @@ import androidx.annotation.OptIn
 import androidx.media3.common.util.UnstableApi
 
 @OptIn(UnstableApi::class)
+/** @hide */
 internal interface InternalNewPlayerViewModel : NewPlayerViewModel {
     var minContentRatio: Float
     var maxContentRatio: Float