From 82eef15abe01b4c1078e453ee448789486ee0235 Mon Sep 17 00:00:00 2001 From: Anton Hansson Date: Fri, 20 Oct 2023 13:06:43 +0000 Subject: Explain the -hide params passed to doclava The reason certain checks are disabled in doclava is that they have been implemented in metalava instead. Clarify that. Test: presubmit Change-Id: I32c32783dea59a63d95d14b4ad636159536c2944 --- api/ApiDocs.bp | 17 +++++++++++++++-- 1 file 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 " + -- cgit v1.2.3-59-g8ed1b