summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author Anton Hansson <hansson@google.com> 2023-10-20 16:28:10 +0000
committer Gerrit Code Review <noreply-gerritcodereview@google.com> 2023-10-20 16:28:10 +0000
commita8b4f6f7afb3c6b3f2337b86dee94adc083573df (patch)
tree5f4a9fca25035faa2e975ac8a6b1b190e2c56dec
parent1b18e3d1da3c212734c85439a97ca30f4ed22362 (diff)
parent82eef15abe01b4c1078e453ee448789486ee0235 (diff)
Merge "Explain the -hide params passed to doclava" into main
-rw-r--r--api/ApiDocs.bp17
1 files changed, 15 insertions, 2 deletions
diff --git a/api/ApiDocs.bp b/api/ApiDocs.bp
index e1621008cc33..e086bfe5cbb2 100644
--- a/api/ApiDocs.bp
+++ b/api/ApiDocs.bp
@@ -139,9 +139,22 @@ droidstubs {
// using droiddoc
/////////////////////////////////////////////////////////////////////
-framework_docs_only_args = " -android -manifest $(location :frameworks-base-core-AndroidManifest.xml) " +
+// doclava contains checks for a few issues that are have been migrated to metalava.
+// disable them in doclava, to avoid mistriggering or double triggering.
+ignore_doclava_errors_checked_by_metalava = "" +
+ "-hide 111 " + // HIDDEN_SUPERCLASS
+ "-hide 113 " + // DEPRECATION_MISMATCH
+ "-hide 125 " + // REQUIRES_PERMISSION
+ "-hide 126 " + // BROADCAST_BEHAVIOR
+ "-hide 127 " + // SDK_CONSTANT
+ "-hide 128 " // TODO
+
+framework_docs_only_args = "-android " +
+ "-manifest $(location :frameworks-base-core-AndroidManifest.xml) " +
"-metalavaApiSince " +
- "-werror -lerror -hide 111 -hide 113 -hide 125 -hide 126 -hide 127 -hide 128 " +
+ "-werror " +
+ "-lerror " +
+ ignore_doclava_errors_checked_by_metalava +
"-overview $(location :frameworks-base-java-overview) " +
// Federate Support Library references against local API file.
"-federate SupportLib https://developer.android.com " +