aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>2020-03-17 02:02:05 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>2020-03-17 02:02:05 +0000
commit2c478e4b6d2bd1d5c31de310c3930b94636e9230 (patch)
tree5509feb9c45718ed6f8507c2f00f001bf895783b
parent463e524f2a2662f6e710f595dfde165d940ee028 (diff)
parent303c65f6c5ba3b1b9552c4e830227a23953b509b (diff)
downloadplatform_external_dokka-2c478e4b6d2bd1d5c31de310c3930b94636e9230.tar.gz
platform_external_dokka-2c478e4b6d2bd1d5c31de310c3930b94636e9230.tar.bz2
platform_external_dokka-2c478e4b6d2bd1d5c31de310c3930b94636e9230.zip
Add noGenerate{Pacakge,Classes}IndexPage cli arguments. am: 06d88ea6f5 am: 303c65f6c5
Change-Id: Ib396ac05b57d0f9de067f08ba95d62f9e4bc5245
-rw-r--r--runners/cli/src/main/kotlin/cli/main.kt18
1 files changed, 14 insertions, 4 deletions
diff --git a/runners/cli/src/main/kotlin/cli/main.kt b/runners/cli/src/main/kotlin/cli/main.kt
index e7fb76f0..37be6e28 100644
--- a/runners/cli/src/main/kotlin/cli/main.kt
+++ b/runners/cli/src/main/kotlin/cli/main.kt
@@ -72,12 +72,22 @@ class DokkaArguments {
@set:Argument(value = "collectInheritedExtensionsFromLibraries", description = "Search for applicable extensions in libraries")
var collectInheritedExtensionsFromLibraries: Boolean = false
- @set:Argument(value = "generateClassIndexPage", description = "Generate classes.html index page.")
+ @set:Argument(value = "generateClassIndexPage", description = "Generate classes.html index page. [Deprecated]: use noGenerateClassIndexPage instead.")
+ @Deprecated("There is no way to set this to false.", replaceWith = ReplaceWith(
+ expression ="noGenerateClassIndexPage"))
var generateClassIndexPage: Boolean = true
- @set:Argument(value = "generatePackageIndexPage", description = "Generate packages.html index page.")
+ @set:Argument(value = "generatePackageIndexPage", description = "Generate packages.html index page. [Deprecated]: use noGeneratePackageIndexPage instead.")
+ @Deprecated("There is no way to set this to false.", replaceWith = ReplaceWith(
+ expression ="noGeneratePackageIndexPage"))
var generatePackageIndexPage: Boolean = true
+ @set:Argument(value = "noGenerateClassIndexPage", description = "Disable classes.html index page.")
+ var noGenerateClassIndexPage: Boolean = false
+
+ @set:Argument(value = "noGeneratePackageIndexPage", description = "Disable packages.html index page.")
+ var noGeneratePackageIndexPage: Boolean = false
+
@set:Argument(value = "outlineRoot", description = "Relative root directory the outline files. I.e. androidx/core/")
var outlineRoot: String = ""
@@ -142,8 +152,8 @@ object MainKt {
languageVersion = arguments.languageVersion,
apiVersion = arguments.apiVersion,
collectInheritedExtensionsFromLibraries = arguments.collectInheritedExtensionsFromLibraries,
- generateClassIndexPage = arguments.generateClassIndexPage,
- generatePackageIndexPage = arguments.generatePackageIndexPage,
+ generateClassIndexPage = !arguments.noGenerateClassIndexPage,
+ generatePackageIndexPage = !arguments.noGeneratePackageIndexPage,
outlineRoot = arguments.outlineRoot,
dacRoot = arguments.dacRoot,
noJdkLink = arguments.noJdkLink