diff options
| author | Tobias Thierer <tobiast@google.com> | 2018-03-05 22:55:32 +0000 |
|---|---|---|
| committer | Tobias Thierer <tobiast@google.com> | 2018-03-06 12:05:28 +0000 |
| commit | 97bb6cf371f51549c708cf58a04584968eaf7d5a (patch) | |
| tree | efc934788a668556a7c417158f3af62ef800b851 | |
| parent | e8b557bc08facb3d60b605f3e8cb26b31baaa28b (diff) | |
| download | base-97bb6cf371f51549c708cf58a04584968eaf7d5a.tar.gz | |
Remove com.android.internal{.util} from generated documentation.
com.android.internal.* is meant to be hidden from documentation,
but most of it is erroneously not hidden via @hide or -hidePackage
directives; why documentation is currently generated for Predicate
but not other classes from com.android.internal.util, and why some
but not all classes from that package show up in package-level
documentation (package-summary.html), is not currently understood.
There appears to be a behavior difference between OpenJDK 8 and
OpenJDK 9's javadoc that results in additional classes showing up
in package-summary.html. This CL fixes this by adding -hidePackage
directives for com.android.internal{.util}; other sub-packages of
com.android.internal do not currently show up in documentation and
are not touched by this CL.
Test: Patched this CL into the internal-master branch and ran:
USE_R8=true EXPERIMENTAL_USE_OPENJDK9=true make offline-sdk-docs
Checked that this removes all documentation for com.*
(com.android.internal.util was the only com.* package for which
documentation was previously generated).
In other words: Before this CL, [1] existed, but after
this CL, the entire directory subtree [2] does not exist.
Test: Checked that Predicate was already missing from stubs before this
CL. In other words, [3] already did not exist before this CL.
[1] out/target/common/docs/offline-sdk/reference/com/android/internal/util/Predicate.html
[2] out/target/common/docs/offline-sdk/reference/com
[3] out/target/common/obj/JAVA_LIBRARIES/android_system_stubs_current_intermediates/classes/com
Bug: 69736344
Bug: 69736236
Change-Id: I3243e2820348c338a54e42c72d29bed71389a6c4
| -rw-r--r-- | Android.mk | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/Android.mk b/Android.mk index 2517f6b76319..147d2cf9ded8 100644 --- a/Android.mk +++ b/Android.mk @@ -173,6 +173,8 @@ framework_docs_LOCAL_DROIDDOC_OPTIONS := \ -knowntags ./frameworks/base/docs/knowntags.txt \ -knowntags ./libcore/known_oj_tags.txt \ -manifest ./frameworks/base/core/res/AndroidManifest.xml \ + -hidePackage com.android.internal \ + -hidePackage com.android.internal.util \ -hidePackage com.android.okhttp \ -hidePackage com.android.org.conscrypt \ -hidePackage com.android.server \ |