drgreen/android_frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
android_frameworks_base/ApiDocs.bp

531 lines
17 KiB
Plaintext
Raw Normal View History

Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
// Copyright (C) 2019 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// How API docs are generated:
//
// raw source files --(metalava)--> stub source files --(doclava)--> API doc
//
// The metalava conversion is done by droidstub modules framework-doc-*-stubs.
// The API doc generation is done by the various droiddoc modules each of which
// is for different format.
/////////////////////////////////////////////////////////////////////
// stub source files are generated using metalava
/////////////////////////////////////////////////////////////////////
framework_docs_only_libs = [
"voip-common",
"android.test.mock",
"android-support-annotations",
"android-support-compat",
"android-support-core-ui",
"android-support-core-utils",
"android-support-design",
"android-support-dynamic-animation",
"android-support-exifinterface",
"android-support-fragment",
"android-support-media-compat",
"android-support-percent",
"android-support-transition",
"android-support-v7-cardview",
"android-support-v7-gridlayout",
"android-support-v7-mediarouter",
"android-support-v7-palette",
"android-support-v7-preference",
"android-support-v13",
"android-support-v14-preference",
"android-support-v17-leanback",
"android-support-vectordrawable",
"android-support-animatedvectordrawable",
"android-support-v7-appcompat",
"android-support-v7-recyclerview",
"android-support-v8-renderscript",
"android-support-multidex",
"android-support-multidex-instrumentation",
]
Add targets to build doc-stubs for non-updatable Like the jar stubs, the doc stubs need modularization to avoid depending on module sources and instead being assembled by merging the doc stubs of the constituent modules. This will allow generating e.g. the lint database, annotation zips, and the documentation itself from prebuilts (which in turn allows mixing e.g. non-updatable R with the latest modules). Move the defaults for the non-updatable jar stubs to the shared bp file and reuse it for the non-updatable doc stubs, and add two targets for the public and the system stubs. Bug: 186197911 Test: m android-non-updatable-doc-stubs{,-system} Change-Id: Ic2cef748c42c141ea42b8cd7b4afd7ee78a1399d
2021-05-05 10:32:31 +01:00
stubs_defaults {
name: "android-non-updatable-doc-stubs-defaults",
defaults: ["android-non-updatable-stubs-defaults"],
srcs: [
// No longer part of the stubs, but are included in the docs.
"test-base/src/**/*.java",
"test-mock/src/**/*.java",
"test-runner/src/**/*.java",
],
libs: framework_docs_only_libs,
create_doc_stubs: true,
write_sdk_values: true,
}
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
stubs_defaults {
name: "framework-doc-stubs-default",
srcs: [
Add targets to build doc-stubs for non-updatable Like the jar stubs, the doc stubs need modularization to avoid depending on module sources and instead being assembled by merging the doc stubs of the constituent modules. This will allow generating e.g. the lint database, annotation zips, and the documentation itself from prebuilts (which in turn allows mixing e.g. non-updatable R with the latest modules). Move the defaults for the non-updatable jar stubs to the shared bp file and reuse it for the non-updatable doc stubs, and add two targets for the public and the system stubs. Bug: 186197911 Test: m android-non-updatable-doc-stubs{,-system} Change-Id: Ic2cef748c42c141ea42b8cd7b4afd7ee78a1399d
2021-05-05 10:32:31 +01:00
":android-non-updatable-stub-sources",
Delete framework-updatable-sources filegroup Inline these sources in the only place it is used. Bug: 184125529 Test: presubmit Change-Id: I42e7044471262bf901b8c130a50e1a8a8170c600
2021-03-30 10:46:48 +01:00
// Module sources
Use ART stubs source generated by java_sdk_library Bug: 168301990 Test: Built offline-sdk-docs with and without the change and diffed them. There were some changes other than the timestamp.js file. With these changes classes that implemented the Object.equals(Object) method had some extra documentation that explained that the parameter could be null. The reason for this change is that the stubs generated with this change includes android.annotation.Nullable whereas previously they included androidx.annotation.Nullable. The change is a very minor improvement over what is currently uploaded to developer.android.com/reference so not worth backporting. Diffed api/public/current.txt against frameworks/base/api/current.txt and made sure that the latter was a superset of the former and there were no differences in the area that overlapped. Change-Id: I3767948b4659b18b813c8eed66258af98ac4a241
2020-09-16 14:26:47 +01:00
":art.module.public.api{.public.stubs.source}",
Use tags to access conscrypt sources Avoids direct access to the stub sources and instead access them via tags passed to the java_sdk_library. Bug: 155164730 Test: m checkapi Change-Id: I93dfb8bfac60bd7ab628292667c8d7a9d5e8eb82
2020-05-14 17:55:46 +01:00
":conscrypt.module.public.api{.public.stubs.source}",
Unbundle i18n API from android-non-updatable This removes the i18n source from the non-updatable stubs which removes them from the frameworks/base/core/api files too. The API is still protected by both the build and Gerrit review as the API is specified in the external/icu/android_icu4j/api/public/ directory. The i18n stubs source is used instead of the implementation source for generating the JavaDoc. That revealed a minor issue with metalava which is fixed in this topic. The i18n stubs library was statically included alongside the conscrypt stubs library so it will still appear in the monolothic android.jar. Bug: 174344410 Test: m offline-sdk-docs - check that i18n classes are present m android_stubs_current android_system_stubs_current android_test_stubs_current - check that i18n classes are present in each jar m droid Change-Id: I744c8bac54a8a5518ca0eca2a7700abbfa0997f4
2020-11-25 15:45:43 +00:00
":i18n.module.public.api{.public.stubs.source}",
Delete framework-updatable-sources filegroup Inline these sources in the only place it is used. Bug: 184125529 Test: presubmit Change-Id: I42e7044471262bf901b8c130a50e1a8a8170c600
2021-03-30 10:46:48 +01:00
// No longer part of the stubs, but are included in the docs.
Use filegroups for test-{base,mock,runner} srcs This allows soong to infer the package of the given srcs, which in turns make it able to filter the inputs to metalava to exclude unwanted packages. This is part of a larger topic of changes intended to remove undesired classes from the public documentation. Bug: 187386774 Test: m Change-Id: I8196c306b743ce6ca8a6452d212f3d7c0b5b2b82
2021-05-10 12:40:05 +01:00
":android-test-base-sources",
":android-test-mock-sources",
":android-test-runner-sources",
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
],
Add doc stubs target that uses module stub source The framework-doc-stubs target currently takes the module source code as input. Work is being done to change that over to use module sdk artifacts, primarily the jar stub source code. Check in a work-in-progress target that does so, to avoid it breaking and to simplify iterating on improvements. Bug: 186197911 Test: m framework-doc-stubs{,-module-stubs} Change-Id: I1a275b3f44632e6655dc84d711a58fc0c5b3a46a
2021-09-17 16:09:08 +01:00
arg_files: [
"core/res/AndroidManifest.xml",
],
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
libs: framework_docs_only_libs,
create_doc_stubs: true,
annotations_enabled: true,
Apply the same filtering for docstubs and jarstubs A package filter was previously applied to just the jarstubs package, but not the docstubs. This lead to various internal classes appearing in the public documentation. Fix that to apply the same filter for both. This removes the following classes from the docs: android/telephony/PackageChangeReceiver com/android/net/module/util/CollectionUtils com/android/net/module/util/ConnectivityUtils com/android/net/module/util/NetworkCapabilitiesUtils com/android/net/module/util/NetworkIdentityUtils com/google/android/collect/Lists com/google/android/collect/Maps com/google/android/collect/Sets com/google/android/gles_jni/EGLConfigImpl com/google/android/gles_jni/EGLContextImpl com/google/android/gles_jni/EGLDisplayImpl com/google/android/gles_jni/EGLImpl com/google/android/gles_jni/EGLSurfaceImpl com/google/android/gles_jni/GLImpl com/google/android/util/AbstractMessageParser com/google/android/util/AbstractMessageParser$Acronym com/google/android/util/AbstractMessageParser$FlickrPhoto com/google/android/util/AbstractMessageParser$Format com/google/android/util/AbstractMessageParser$Html com/google/android/util/AbstractMessageParser$Link com/google/android/util/AbstractMessageParser$MusicTrack com/google/android/util/AbstractMessageParser$Part com/google/android/util/AbstractMessageParser$Photo com/google/android/util/AbstractMessageParser$Resources com/google/android/util/AbstractMessageParser$Smiley com/google/android/util/AbstractMessageParser$Token com/google/android/util/AbstractMessageParser$Token$Type com/google/android/util/AbstractMessageParser$TrieNode com/google/android/util/AbstractMessageParser$Video com/google/android/util/AbstractMessageParser$YouTubeVideo com/google/android/util/Procedure com/google/android/util/SmileyParser com/google/android/util/SmileyResources Bug: 187386774 Test: diff framework-doc-stubs/../api-versions.xml before and after Change-Id: I85b1485b4c5bc1b30a5d537e96d961382f298fb7
2021-05-05 19:22:52 +01:00
filter_packages: packages_to_document,
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
api_levels_annotations_enabled: true,
api_levels_annotations_dirs: [
"sdk-dir",
"api-versions-jars-dir",
],
Change last-released filegroup There were two different filegroups referencing the same last released APIs. Delete the manually defined one and switch references over to use the one defined by prebuilt_apis. Bug: 155197156 Test: m Change-Id: Ib15d2c08e6400546ca03de6bfd4e5cbcc938c992 Merged-In: Ib15d2c08e6400546ca03de6bfd4e5cbcc938c992
2020-05-02 17:49:26 +01:00
previous_api: ":android.api.public.latest",
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
merge_annotations_dirs: [
"metalava-manual",
],
Add doc stubs target that uses module stub source The framework-doc-stubs target currently takes the module source code as input. Work is being done to change that over to use module sdk artifacts, primarily the jar stub source code. Check in a work-in-progress target that does so, to avoid it breaking and to simplify iterating on improvements. Bug: 186197911 Test: m framework-doc-stubs{,-module-stubs} Change-Id: I1a275b3f44632e6655dc84d711a58fc0c5b3a46a
2021-09-17 16:09:08 +01:00
write_sdk_values: true,
Separate AIDL packages This moves the android.media.audio.common, android.media.permission and android.media.soundtrigger_middleware AIDL files to a their own separate aidl_interface module for Java. Previously, because of how the framework JAR is configured, those files were automatically compiled into it and we had to disable Java for this target, creating a discrepancy between C++ and Java, which would require us to similarly diverge any dependent targets if we want cross-language support. As part of this change, we also had to switch from using the FileDescriptor type to ParcelFileDescriptor, as this is the only type supported outside of the framework JAR and is also the recommended practice. Test: Manual verification of basic soundtrigger functionality. Change-Id: Ib65c19dd7c7f5433cfa527fa74bb61ac677f5cf5
2020-09-16 13:04:31 -07:00
// TODO(b/169090544): remove below aidl includes.
aidl: {
local_include_dirs: ["media/aidl"],
Pass metadata as AttributionSourceSource. These two PermissionManager methods are using AttributionSource as metadata only, and aren't interested in the remote caller enforcing that the claimed UID matches the caller, since they're not actually being used for permission enforcement. Thus we pass the metadata using the AttributionSourceState holder object and reconstruct on the remote side, entirely avoiding the enforceCallingUid() check. Bug: 193842956 Test: atest CtsPermission5TestCases Change-Id: I576b6feb8cc2b0586b4341268866d8027689293f
2021-07-26 15:41:01 -06:00
include_dirs: [
"frameworks/av/aidl",
"frameworks/native/libs/permission/aidl",
],
Separate AIDL packages This moves the android.media.audio.common, android.media.permission and android.media.soundtrigger_middleware AIDL files to a their own separate aidl_interface module for Java. Previously, because of how the framework JAR is configured, those files were automatically compiled into it and we had to disable Java for this target, creating a discrepancy between C++ and Java, which would require us to similarly diverge any dependent targets if we want cross-language support. As part of this change, we also had to switch from using the FileDescriptor type to ParcelFileDescriptor, as this is the only type supported outside of the framework JAR and is also the recommended practice. Test: Manual verification of basic soundtrigger functionality. Change-Id: Ib65c19dd7c7f5433cfa527fa74bb61ac677f5cf5
2020-09-16 13:04:31 -07:00
},
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
}
Add doc stubs target that uses module stub source The framework-doc-stubs target currently takes the module source code as input. Work is being done to change that over to use module sdk artifacts, primarily the jar stub source code. Check in a work-in-progress target that does so, to avoid it breaking and to simplify iterating on improvements. Bug: 186197911 Test: m framework-doc-stubs{,-module-stubs} Change-Id: I1a275b3f44632e6655dc84d711a58fc0c5b3a46a
2021-09-17 16:09:08 +01:00
// Defaults module for doc-stubs targets that use module source code as input.
// This is the default/normal.
stubs_defaults {
name: "framework-doc-stubs-sources-default",
defaults: ["framework-doc-stubs-default"],
srcs: [
":framework-appsearch-sources",
":framework-connectivity-sources",
":framework-graphics-srcs",
":framework-mediaprovider-sources",
":framework-permission-sources",
":framework-permission-s-sources",
":framework-scheduling-sources",
":framework-sdkextensions-sources",
":framework-statsd-sources",
":framework-tethering-srcs",
":framework-wifi-updatable-sources",
":ike-srcs",
":updatable-media-srcs",
],
}
Add targets to build doc-stubs for non-updatable Like the jar stubs, the doc stubs need modularization to avoid depending on module sources and instead being assembled by merging the doc stubs of the constituent modules. This will allow generating e.g. the lint database, annotation zips, and the documentation itself from prebuilts (which in turn allows mixing e.g. non-updatable R with the latest modules). Move the defaults for the non-updatable jar stubs to the shared bp file and reuse it for the non-updatable doc stubs, and add two targets for the public and the system stubs. Bug: 186197911 Test: m android-non-updatable-doc-stubs{,-system} Change-Id: Ic2cef748c42c141ea42b8cd7b4afd7ee78a1399d
2021-05-05 10:32:31 +01:00
droidstubs {
name: "android-non-updatable-doc-stubs",
defaults: ["android-non-updatable-doc-stubs-defaults"],
args: metalava_framework_docs_args,
}
droidstubs {
name: "android-non-updatable-doc-stubs-system",
defaults: ["android-non-updatable-doc-stubs-defaults"],
args: metalava_framework_docs_args +
" --show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.PRIVILEGED_APPS\\) ",
}
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
droidstubs {
name: "framework-doc-stubs",
Add doc stubs target that uses module stub source The framework-doc-stubs target currently takes the module source code as input. Work is being done to change that over to use module sdk artifacts, primarily the jar stub source code. Check in a work-in-progress target that does so, to avoid it breaking and to simplify iterating on improvements. Bug: 186197911 Test: m framework-doc-stubs{,-module-stubs} Change-Id: I1a275b3f44632e6655dc84d711a58fc0c5b3a46a
2021-09-17 16:09:08 +01:00
defaults: ["framework-doc-stubs-sources-default"],
Remove --ignore-classes-on-classpath argument This argument doesn't appear to alter the output. Bug: 186197911 Test: diff metadata.zip, stubs.srcjar, annotations.zip before and after Change-Id: I5147cf1f0658c78e5ab24952285c8fc1c036a55d
2021-05-05 11:11:57 +01:00
args: metalava_framework_docs_args,
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
}
droidstubs {
name: "framework-doc-system-stubs",
Add doc stubs target that uses module stub source The framework-doc-stubs target currently takes the module source code as input. Work is being done to change that over to use module sdk artifacts, primarily the jar stub source code. Check in a work-in-progress target that does so, to avoid it breaking and to simplify iterating on improvements. Bug: 186197911 Test: m framework-doc-stubs{,-module-stubs} Change-Id: I1a275b3f44632e6655dc84d711a58fc0c5b3a46a
2021-09-17 16:09:08 +01:00
defaults: ["framework-doc-stubs-sources-default"],
Stop ignoring classes on the classpath for stubs We're working on moving the libcore classes away from srcs and into the classpath, and ignoring classes on the classpath will cause incorrect API signatures once that happens (several libcore classes appear in public API signatures). Keep the docs building in the same way they were before. They will be addressed in separate CLs. Bug: 173606718 Test: m checkapi Change-Id: I471327c3657662d7a093e9baa2fb6e08d640f895
2020-12-17 14:56:06 +00:00
args: metalava_framework_docs_args +
" --show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.PRIVILEGED_APPS\\) ",
Build framework-doc-system-stubs with system stubs. Specifing the new property makes soong pass system stub jars for metalava to process. Bug: 190665366 Test: m framework-doc-system-stubs Change-Id: I0da0a0aa79d0128d81a5a6df7f9ce4a190a2b650
2021-06-29 22:27:06 +01:00
api_levels_sdk_type: "system",
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
}
Add doc stubs target that uses module stub source The framework-doc-stubs target currently takes the module source code as input. Work is being done to change that over to use module sdk artifacts, primarily the jar stub source code. Check in a work-in-progress target that does so, to avoid it breaking and to simplify iterating on improvements. Bug: 186197911 Test: m framework-doc-stubs{,-module-stubs} Change-Id: I1a275b3f44632e6655dc84d711a58fc0c5b3a46a
2021-09-17 16:09:08 +01:00
// Experimental target building doc stubs with module stub source code as input.
// This is intended to eventually replace framework-doc-stubs, once all diffs
// have been eliminated.
droidstubs {
name: "framework-doc-stubs-module-stubs",
defaults: ["framework-doc-stubs-default"],
args: metalava_framework_docs_args,
srcs: [
":android.net.ipsec.ike{.public.stubs.source}",
":framework-appsearch{.public.stubs.source}",
":framework-connectivity{.public.stubs.source}",
":framework-graphics{.public.stubs.source}",
":framework-media{.public.stubs.source}",
":framework-mediaprovider{.public.stubs.source}",
":framework-permission{.public.stubs.source}",
":framework-permission-s{.public.stubs.source}",
":framework-scheduling{.public.stubs.source}",
":framework-sdkextensions{.public.stubs.source}",
":framework-statsd{.public.stubs.source}",
":framework-tethering{.public.stubs.source}",
":framework-wifi{.public.stubs.source}",
],
aidl: {
local_include_dirs: [
"apex/media/aidl/stable",
],
include_dirs: [
"packages/modules/Connectivity/framework/aidl-export",
],
},
}
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
/////////////////////////////////////////////////////////////////////
// API docs are created from the generated stub source files
// using droiddoc
/////////////////////////////////////////////////////////////////////
framework_docs_only_args = " -android -manifest $(location core/res/AndroidManifest.xml) " +
"-werror -lerror -hide 111 -hide 113 -hide 125 -hide 126 -hide 127 -hide 128 " +
"-overview $(location core/java/overview.html) " +
// Federate Support Library references against local API file.
"-federate SupportLib https://developer.android.com " +
"-federationapi SupportLib $(location :current-support-api) " +
// Federate Support Library references against local API file.
"-federate AndroidX https://developer.android.com " +
"-federationapi AndroidX $(location :current-androidx-api) "
doc_defaults {
name: "framework-docs-default",
Use android.compat.annotation.UnsupportedAppUsage everywhere. The new annotation replaces existing two annotations in libcore/ and frameworks/base/. This helps avoid human confusion and allows better and correct tool support. Bug: 145132366 Test: m Change-Id: I9078b124ddf0273250c645fe17f27088092c8b18
2020-01-13 16:16:27 +00:00
libs: framework_docs_only_libs + [
"stub-annotations",
"unsupportedappusage",
],
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
html_dirs: [
"docs/html",
],
knowntags: [
"docs/knowntags.txt",
Get ART public API doctag information from java_sdk_library Uses an output tag to access the doctag_files exposed by the art.module.public.api java_sdk_library. This ensures that the doctags will be available from the ART prebuilts as well. Bug: 168301990 Test: Built offline-sdk-docs with and without the change and diffed them. The only difference was the timestamp.js file. Change-Id: Ibd51899e4aeb9b11727a54644330bbbe8b7e86a7
2020-09-08 20:22:49 +01:00
":art.module.public.api{.doctags}",
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
],
custom_template: "droiddoc-templates-sdk",
resourcesdir: "docs/html/reference/images/",
resourcesoutdir: "reference/android/images/",
hdf: [
"dac true",
"sdk.codename O",
"sdk.preview.version 1",
"sdk.version 7.0",
"sdk.rel.id 1",
"sdk.preview 0",
],
arg_files: [
"core/res/AndroidManifest.xml",
"core/java/overview.html",
":current-support-api",
":current-androidx-api",
],
Separate AIDL packages This moves the android.media.audio.common, android.media.permission and android.media.soundtrigger_middleware AIDL files to a their own separate aidl_interface module for Java. Previously, because of how the framework JAR is configured, those files were automatically compiled into it and we had to disable Java for this target, creating a discrepancy between C++ and Java, which would require us to similarly diverge any dependent targets if we want cross-language support. As part of this change, we also had to switch from using the FileDescriptor type to ParcelFileDescriptor, as this is the only type supported outside of the framework JAR and is also the recommended practice. Test: Manual verification of basic soundtrigger functionality. Change-Id: Ib65c19dd7c7f5433cfa527fa74bb61ac677f5cf5
2020-09-16 13:04:31 -07:00
// TODO(b/169090544): remove below aidl includes.
aidl: {
local_include_dirs: ["media/aidl"],
Pass metadata as AttributionSourceSource. These two PermissionManager methods are using AttributionSource as metadata only, and aren't interested in the remote caller enforcing that the claimed UID matches the caller, since they're not actually being used for permission enforcement. Thus we pass the metadata using the AttributionSourceState holder object and reconstruct on the remote side, entirely avoiding the enforceCallingUid() check. Bug: 193842956 Test: atest CtsPermission5TestCases Change-Id: I576b6feb8cc2b0586b4341268866d8027689293f
2021-07-26 15:41:01 -06:00
include_dirs: [
"frameworks/av/aidl",
"frameworks/native/libs/permission/aidl",
],
Separate AIDL packages This moves the android.media.audio.common, android.media.permission and android.media.soundtrigger_middleware AIDL files to a their own separate aidl_interface module for Java. Previously, because of how the framework JAR is configured, those files were automatically compiled into it and we had to disable Java for this target, creating a discrepancy between C++ and Java, which would require us to similarly diverge any dependent targets if we want cross-language support. As part of this change, we also had to switch from using the FileDescriptor type to ParcelFileDescriptor, as this is the only type supported outside of the framework JAR and is also the recommended practice. Test: Manual verification of basic soundtrigger functionality. Change-Id: Ib65c19dd7c7f5433cfa527fa74bb61ac677f5cf5
2020-09-16 13:04:31 -07:00
},
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
}
doc_defaults {
name: "framework-dokka-docs-default",
}
droiddoc {
name: "doc-comment-check-docs",
defaults: ["framework-docs-default"],
srcs: [
":framework-doc-stubs",
],
args: framework_docs_only_args + " -referenceonly -parsecomments",
installable: false,
}
droiddoc {
name: "offline-sdk-docs",
defaults: ["framework-docs-default"],
srcs: [
":framework-doc-stubs",
],
hdf: [
"android.whichdoc offline",
],
Build rules for compat config docs. Add compat_config to offline SDK docs for now, to generate the compatibility changes documentation. Test: m -j offline-sdk-docs Bug: 144927670 Change-Id: I856a0972212cb23ff97800243671e9c8280d5287
2020-02-03 11:03:16 +00:00
compat_config: ":global-compat-config",
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
proofread_file: "offline-sdk-docs-proofrerad.txt",
args: framework_docs_only_args + " -offlinemode -title \"Android SDK\"",
static_doc_index_redirect: "docs/docs-preview-index.html",
}
droiddoc {
// Please sync with android-api-council@ before making any changes for the name property below.
// Since there's cron jobs that fetch offline-sdk-referenceonly-docs-docs.zip periodically.
// See b/116221385 for reference.
name: "offline-sdk-referenceonly-docs",
defaults: ["framework-docs-default"],
srcs: [
":framework-doc-stubs",
],
hdf: [
"android.whichdoc offline",
],
proofread_file: "offline-sdk-referenceonly-docs-proofrerad.txt",
args: framework_docs_only_args + " -offlinemode -title \"Android SDK\" -referenceonly",
static_doc_index_redirect: "docs/docs-documentation-redirect.html",
static_doc_properties: "docs/source.properties",
}
droiddoc {
// Please sync with android-api-council@ before making any changes for the name property below.
// Since there's cron jobs that fetch offline-system-sdk-referenceonly-docs-docs.zip periodically.
// See b/116221385 for reference.
name: "offline-system-sdk-referenceonly-docs",
defaults: ["framework-docs-default"],
srcs: [
":framework-doc-system-stubs",
],
hdf: [
"android.whichdoc offline",
],
proofread_file: "offline-system-sdk-referenceonly-docs-proofrerad.txt",
args: framework_docs_only_args + " -hide 101 -hide 104 -hide 108" +
" -offlinemode -title \"Android System SDK\" -referenceonly",
static_doc_index_redirect: "docs/docs-documentation-redirect.html",
static_doc_properties: "docs/source.properties",
}
droiddoc {
name: "online-sdk-docs",
defaults: ["framework-docs-default"],
srcs: [
":framework-doc-stubs",
],
hdf: [
"android.whichdoc online",
"android.hasSamples true",
],
proofread_file: "online-sdk-docs-proofrerad.txt",
args: framework_docs_only_args +
" -toroot / -samplegroup Admin " +
" -samplegroup Background " +
" -samplegroup Connectivity " +
" -samplegroup Content " +
" -samplegroup Input " +
" -samplegroup Media " +
" -samplegroup Notification " +
" -samplegroup RenderScript " +
" -samplegroup Security " +
" -samplegroup Sensors " +
" -samplegroup System " +
" -samplegroup Testing " +
" -samplegroup UI " +
" -samplegroup Views " +
" -samplegroup Wearable -samplesdir development/samples/browseable ",
}
droiddoc {
name: "online-system-api-sdk-docs",
defaults: ["framework-docs-default"],
srcs: [
":framework-doc-system-stubs",
],
hdf: [
"android.whichdoc online",
"android.hasSamples true",
],
proofread_file: "online-system-api-sdk-docs-proofrerad.txt",
args: framework_docs_only_args +
" -referenceonly " +
" -title \"Android SDK - Including system APIs.\" " +
" -hide 101 " +
" -hide 104 " +
" -hide 108 " +
" -toroot / -samplegroup Admin " +
" -samplegroup Background " +
" -samplegroup Connectivity " +
" -samplegroup Content " +
" -samplegroup Input " +
" -samplegroup Media " +
" -samplegroup Notification " +
" -samplegroup RenderScript " +
" -samplegroup Security " +
" -samplegroup Sensors " +
" -samplegroup System " +
" -samplegroup Testing " +
" -samplegroup UI " +
" -samplegroup Views " +
" -samplegroup Wearable -samplesdir development/samples/browseable ",
installable: false,
}
droiddoc {
name: "ds-docs-java",
defaults: ["framework-docs-default"],
srcs: [
":framework-doc-stubs",
],
hdf: [
"android.whichdoc online",
"android.hasSamples true",
],
proofread_file: "ds-docs-proofrerad.txt",
args: framework_docs_only_args +
" -toroot / -yamlV2 -metalavaApiSince -samplegroup Admin " +
" -samplegroup Background " +
" -samplegroup Connectivity " +
" -samplegroup Content " +
" -samplegroup Input " +
" -samplegroup Media " +
" -samplegroup Notification " +
" -samplegroup RenderScript " +
" -samplegroup Security " +
" -samplegroup Sensors " +
" -samplegroup System " +
" -samplegroup Testing " +
" -samplegroup UI " +
" -samplegroup Views " +
" -samplegroup Wearable -devsite -samplesdir development/samples/browseable ",
}
droiddoc {
name: "ds-docs-kt",
defaults: ["framework-dokka-docs-default"],
srcs: [
":framework-doc-stubs",
],
args: "-noJdkLink -links https://kotlinlang.org/api/latest/jvm/stdlib/^external/dokka/package-list " +
Remove proofread files that aren't created These would cause these actions (and any that depended upon them) to re-run during every incremental build. These now produce warnings: ninja: output file missing after successful execution: out/soong/.intermediates/frameworks/base/ds-ref-navtree-docs/android_common/ds-ref-navtree-docs-proofrerad.txt It turns out that the -proofread argument to doclava is ignored with the following argument combinations: * -static -devsite * -navtreeonly Test: m docs; m docs (nothing to do) Change-Id: I21b939951f5a2f33914e9fc9414df8206091d262
2020-04-20 22:32:45 -07:00
"-noStdlibLink",
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
proofread_file: "ds-dokka-proofread.txt",
dokka_enabled: true,
}
java_genrule {
name: "ds-docs",
tools: [
"zip2zip",
"merge_zips",
],
srcs: [
":ds-docs-java{.docs.zip}",
":ds-docs-kt{.docs.zip}",
],
out: ["ds-docs.zip"],
dist: {
targets: ["docs"],
},
cmd: "$(location zip2zip) -i $(location :ds-docs-kt{.docs.zip}) -o $(genDir)/ds-docs-kt-moved.zip **/*:en/reference/kotlin && " +
Remove proofread files that aren't created These would cause these actions (and any that depended upon them) to re-run during every incremental build. These now produce warnings: ninja: output file missing after successful execution: out/soong/.intermediates/frameworks/base/ds-ref-navtree-docs/android_common/ds-ref-navtree-docs-proofrerad.txt It turns out that the -proofread argument to doclava is ignored with the following argument combinations: * -static -devsite * -navtreeonly Test: m docs; m docs (nothing to do) Change-Id: I21b939951f5a2f33914e9fc9414df8206091d262
2020-04-20 22:32:45 -07:00
"$(location merge_zips) $(out) $(location :ds-docs-java{.docs.zip}) $(genDir)/ds-docs-kt-moved.zip",
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
}
java_genrule {
name: "ds-docs-switched",
tools: [
"switcher4",
"soong_zip",
],
srcs: [
":ds-docs-java{.docs.zip}",
":ds-docs-kt{.docs.zip}",
],
out: ["ds-docs-switched.zip"],
dist: {
targets: ["docs"],
},
Quiet ds-docs-switched The ds-docs-switched genrule was producing 18947 lines of output, including a single line with 266986 bytes. Quiet all the tools used in the genrule. Test: m ds-docs-switched Change-Id: I5549c34f6310469e7791b56190d5b7c1f386a5f7
2020-02-26 13:04:57 -08:00
cmd: "unzip -q $(location :ds-docs-java{.docs.zip}) -d $(genDir) && " +
Remove proofread files that aren't created These would cause these actions (and any that depended upon them) to re-run during every incremental build. These now produce warnings: ninja: output file missing after successful execution: out/soong/.intermediates/frameworks/base/ds-ref-navtree-docs/android_common/ds-ref-navtree-docs-proofrerad.txt It turns out that the -proofread argument to doclava is ignored with the following argument combinations: * -static -devsite * -navtreeonly Test: m docs; m docs (nothing to do) Change-Id: I21b939951f5a2f33914e9fc9414df8206091d262
2020-04-20 22:32:45 -07:00
"unzip -q $(location :ds-docs-kt{.docs.zip}) -d $(genDir)/en/reference/kotlin && " +
"SWITCHER=$$(cd $$(dirname $(location switcher4)) && pwd)/$$(basename $(location switcher4)) && " +
"(cd $(genDir)/en/reference && $$SWITCHER --work platform) > /dev/null && " +
"$(location soong_zip) -o $(out) -C $(genDir) -D $(genDir)",
Separate modules for API docs and API stubs frameworks/base/Android.bp became too big. Modularize it into multiple files for better readability and extensibility. droidstubs and java_library modules for API stub libraries are moved to StubLibraries.bp. droidstubs and droiddoc modules for API documents are moved to ApiDocs.bp Also, added some documentation to explain the roles of the many modules and how they are related with each other. Bug: N/A Test: m Exempt-From-Owner-Approval: cherry-pick from internal Merged-In: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7 (cherry picked from commit 0d7e86d03c8443cee90096ff0447fd50541d77c3) Change-Id: I285e8c82078d5bd3ed85b0343db2f6375ce7ffb7
2019-12-20 14:35:43 +09:00
}
droiddoc {
name: "ds-static-docs",
defaults: ["framework-docs-default"],
srcs: [
":framework-doc-stubs",
],
hdf: [
"android.whichdoc online",
],
args: framework_docs_only_args +
" -staticonly " +
" -toroot / " +
" -devsite " +
" -ignoreJdLinks ",
}
droiddoc {
name: "ds-ref-navtree-docs",
defaults: ["framework-docs-default"],
srcs: [
":framework-doc-stubs",
],
hdf: [
"android.whichdoc online",
],
args: framework_docs_only_args +
" -toroot / " +
" -atLinksNavtree " +
" -navtreeonly ",
}
droiddoc {
name: "online-sdk-dev-docs",
defaults: ["framework-docs-default"],
srcs: [
":framework-doc-stubs",
],
hdf: [
"android.whichdoc online",
"android.hasSamples true",
],
proofread_file: "online-sdk-dev-docs-proofrerad.txt",
args: framework_docs_only_args +
" -toroot / -samplegroup Admin " +
" -samplegroup Background " +
" -samplegroup Connectivity " +
" -samplegroup Content " +
" -samplegroup Input " +
" -samplegroup Media " +
" -samplegroup Notification " +
" -samplegroup RenderScript " +
" -samplegroup Security " +
" -samplegroup Sensors " +
" -samplegroup System " +
" -samplegroup Testing " +
" -samplegroup UI " +
" -samplegroup Views " +
" -samplegroup Wearable -samplesdir development/samples/browseable ",
}
droiddoc {
name: "hidden-docs",
defaults: ["framework-docs-default"],
srcs: [
":framework-doc-stubs",
],
proofread_file: "hidden-docs-proofrerad.txt",
args: framework_docs_only_args +
" -referenceonly " +
" -title \"Android SDK - Including hidden APIs.\"",
}
Reference in New Issue Copy Permalink