Snap for 7799923 from 85bbc72fd0617a7bfcb19ea8e7457b0fae9bd3d4 to mainline-os-statsd-release
Change-Id: I08f1d91f9096c5a07dad28219b60403f399e24b3
diff --git a/src/main/java/com/android/tools/metalava/Driver.kt b/src/main/java/com/android/tools/metalava/Driver.kt
index 47dac44..20e8756 100644
--- a/src/main/java/com/android/tools/metalava/Driver.kt
+++ b/src/main/java/com/android/tools/metalava/Driver.kt
@@ -276,11 +276,13 @@
ApiGenerator.generate(apiLevelJars, androidApiLevelXml, codebase)
}
- if (options.docStubsDir != null && codebase.supportsDocumentation()) {
+ if (options.docStubsDir != null || options.enhanceDocumentation) {
+ if (!codebase.supportsDocumentation()) {
+ error("Codebase does not support documentation, so it cannot be enhanced.")
+ }
progress("Enhancing docs: ")
val docAnalyzer = DocAnalyzer(codebase)
docAnalyzer.enhance()
-
val applyApiLevelsXml = options.applyApiLevelsXml
if (applyApiLevelsXml != null) {
progress("Applying API levels")
diff --git a/src/main/java/com/android/tools/metalava/Options.kt b/src/main/java/com/android/tools/metalava/Options.kt
index c5ad2fb..7a87d67 100644
--- a/src/main/java/com/android/tools/metalava/Options.kt
+++ b/src/main/java/com/android/tools/metalava/Options.kt
@@ -85,6 +85,7 @@
const val ARG_EXTRACT_ANNOTATIONS = "--extract-annotations"
const val ARG_EXCLUDE_ALL_ANNOTATIONS = "--exclude-all-annotations"
const val ARG_EXCLUDE_DOCUMENTATION_FROM_STUBS = "--exclude-documentation-from-stubs"
+const val ARG_ENHANCE_DOCUMENTATION = "--enhance-documentation"
const val ARG_HIDE_PACKAGE = "--hide-package"
const val ARG_MANIFEST = "--manifest"
const val ARG_MIGRATE_NULLNESS = "--migrate-nullness"
@@ -275,6 +276,12 @@
var includeDocumentationInStubs = true
/**
+ * Enhance documentation in various ways, for example auto-generating documentation based on
+ * source annotations present in the code. This is implied by --doc-stubs.
+ */
+ var enhanceDocumentation = false
+
+ /**
* Whether metalava is invoked as part of updating the API files. When this is true, metalava
* should *cancel* various other flags that are also being passed in, such as --check-compatibility.
* This is there to ease integration in the build system: for a given target, the build system will
@@ -924,6 +931,7 @@
ARG_EXCLUDE_ALL_ANNOTATIONS -> generateAnnotations = false
ARG_EXCLUDE_DOCUMENTATION_FROM_STUBS -> includeDocumentationInStubs = false
+ ARG_ENHANCE_DOCUMENTATION -> enhanceDocumentation = true
// Note that this only affects stub generation, not signature files.
// For signature files, clear the compatibility mode
@@ -2384,6 +2392,9 @@
"annotation classes that must be passed through unchanged.",
"$ARG_EXCLUDE_ANNOTATION <annotation classes>", "A comma separated list of fully qualified names of " +
"annotation classes that must be stripped from metalava's outputs.",
+ ARG_ENHANCE_DOCUMENTATION,
+ "Enhance documentation in various ways, for example auto-generating documentation based on source " +
+ "annotations present in the code. This is implied by --doc-stubs.",
ARG_EXCLUDE_DOCUMENTATION_FROM_STUBS, "Exclude element documentation (javadoc and kdoc) " +
"from the generated stubs. (Copyright notices are not affected by this, they are always included. " +
"Documentation stubs (--doc-stubs) are not affected.)",
diff --git a/src/test/java/com/android/tools/metalava/OptionsTest.kt b/src/test/java/com/android/tools/metalava/OptionsTest.kt
index b2687b9..6c22a59 100644
--- a/src/test/java/com/android/tools/metalava/OptionsTest.kt
+++ b/src/test/java/com/android/tools/metalava/OptionsTest.kt
@@ -235,6 +235,10 @@
--exclude-annotation <annotation classes>
A comma separated list of fully qualified names of annotation classes that
must be stripped from metalava's outputs.
+--enhance-documentation
+ Enhance documentation in various ways, for example auto-generating
+ documentation based on source annotations present in the code. This is
+ implied by --doc-stubs.
--exclude-documentation-from-stubs
Exclude element documentation (javadoc and kdoc) from the generated stubs.
(Copyright notices are not affected by this, they are always included.
