blob: bb37fa21c4637c2cfe87337fe9cb123f4028abab [file] [log] [blame]
Bart Searsa8cc0582015-05-07 03:23:20 +00001#
2# Copyright (C) 2008 The Android Open Source Project
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15#
16LOCAL_PATH := $(call my-dir)
17
Colin Crosscf3a0b52017-11-16 00:15:28 -080018# Load framework-specific path mappings used later in the build.
19include $(LOCAL_PATH)/pathmap.mk
Bart Searsa8cc0582015-05-07 03:23:20 +000020
21# Build the master framework library.
22# The framework contains too many method references (>64K) for poor old DEX.
23# So we first build the framework as a monolithic static library then split it
24# up into smaller pieces.
25# ============================================================
26
27# embedded builds use nothing in frameworks/base
28ifneq ($(ANDROID_BUILD_EMBEDDED),true)
29
Bart Searsa8cc0582015-05-07 03:23:20 +000030# Copy AIDL files to be preprocessed and included in the SDK,
31# specified relative to the root of the build tree.
32# ============================================================
33include $(CLEAR_VARS)
34
Colin Cross77ebd082017-12-15 17:30:33 -080035aidl_parcelables :=
36define stubs-to-aidl-parcelables
37 gen := $(TARGET_OUT_COMMON_INTERMEDIATES)/$1.aidl
38 aidl_parcelables += $$(gen)
Colin Crossfdbe7d12018-02-09 11:24:14 -080039 $$(gen): $(call java-lib-header-files,$1) $(HOST_OUT_EXECUTABLES)/sdkparcelables
Colin Cross77ebd082017-12-15 17:30:33 -080040 @echo Extract SDK parcelables: $$@
41 rm -f $$@
42 $(HOST_OUT_EXECUTABLES)/sdkparcelables $$< $$@
43endef
44
45$(foreach stubs,android_stubs_current android_test_stubs_current android_system_stubs_current,\
46 $(eval $(call stubs-to-aidl-parcelables,$(stubs))))
47
Bart Searsa8cc0582015-05-07 03:23:20 +000048gen := $(TARGET_OUT_COMMON_INTERMEDIATES)/framework.aidl
Colin Cross77ebd082017-12-15 17:30:33 -080049.KATI_RESTAT: $(gen)
50$(gen): $(aidl_parcelables)
51 @echo Combining SDK parcelables: $@
52 rm -f $@.tmp
53 cat $^ | sort -u > $@.tmp
54 $(call commit-change-for-toc,$@)
Bart Searsa8cc0582015-05-07 03:23:20 +000055
56# the documentation
57# ============================================================
58
59# TODO: deal with com/google/android/googleapps
60packages_to_document := \
Colin Crosscf3a0b52017-11-16 00:15:28 -080061 android \
62 javax/microedition/khronos \
63 org/apache/http/conn \
64 org/apache/http/params \
Bart Searsa8cc0582015-05-07 03:23:20 +000065
66# include definition of libcore_to_document
67include libcore/Docs.mk
68
Bart Searsa8cc0582015-05-07 03:23:20 +000069non_base_dirs := \
Colin Crosscf3a0b52017-11-16 00:15:28 -080070 ../opt/telephony/src/java/android/telephony \
71 ../opt/telephony/src/java/android/telephony/gsm \
72 ../opt/net/voip/src/java/android/net/rtp \
73 ../opt/net/voip/src/java/android/net/sip \
Bart Searsa8cc0582015-05-07 03:23:20 +000074
Colin Crosscf3a0b52017-11-16 00:15:28 -080075# Find all files in specific directories (relative to frameworks/base)
76# to document and check apis
77files_to_check_apis := \
78 $(call find-other-java-files, \
Colin Crosscf3a0b52017-11-16 00:15:28 -080079 $(non_base_dirs) \
80 )
Bart Searsa8cc0582015-05-07 03:23:20 +000081
Colin Crosscf3a0b52017-11-16 00:15:28 -080082# Find all files in specific packages that were used to compile
83# framework.jar to document and check apis
84files_to_check_apis += \
85 $(addprefix ../../,\
86 $(filter \
87 $(foreach dir,$(FRAMEWORKS_BASE_JAVA_SRC_DIRS),\
88 $(foreach package,$(packages_to_document),\
89 $(dir)/$(package)/%.java)),\
90 $(SOONG_FRAMEWORK_SRCS)))
91
92# Find all generated files that were used to compile framework.jar
Colin Crossbd200ce2017-12-04 13:45:19 -080093files_to_check_apis_generated := \
94 $(filter $(OUT_DIR)/%,\
95 $(SOONG_FRAMEWORK_SRCS))
George Mountf6be9932015-12-03 07:39:55 -080096
Bart Searsa8cc0582015-05-07 03:23:20 +000097# These are relative to frameworks/base
98# FRAMEWORKS_BASE_SUBDIRS comes from build/core/pathmap.mk
Colin Crosscf3a0b52017-11-16 00:15:28 -080099files_to_document := \
100 $(files_to_check_apis) \
101 $(call find-other-java-files,\
Paul Duffin187a48d2017-12-13 14:34:31 +0000102 test-base/src \
Paul Duffin9f6282d2017-12-15 15:49:08 +0000103 test-mock/src \
Colin Crosscf3a0b52017-11-16 00:15:28 -0800104 test-runner/src)
George Mountf6be9932015-12-03 07:39:55 -0800105
Bart Searsa8cc0582015-05-07 03:23:20 +0000106# These are relative to frameworks/base
107html_dirs := \
108 $(FRAMEWORKS_BASE_SUBDIRS) \
Colin Crosscf3a0b52017-11-16 00:15:28 -0800109 $(non_base_dirs) \
Bart Searsa8cc0582015-05-07 03:23:20 +0000110
111# Common sources for doc check and api check
112common_src_files := \
113 $(call find-other-html-files, $(html_dirs)) \
Colin Crosscf3a0b52017-11-16 00:15:28 -0800114 $(addprefix ../../, $(libcore_to_document)) \
Bart Searsa8cc0582015-05-07 03:23:20 +0000115
116# These are relative to frameworks/base
117framework_docs_LOCAL_SRC_FILES := \
Colin Crosscf3a0b52017-11-16 00:15:28 -0800118 $(files_to_document) \
119 $(common_src_files) \
Bart Searsa8cc0582015-05-07 03:23:20 +0000120
121# These are relative to frameworks/base
122framework_docs_LOCAL_API_CHECK_SRC_FILES := \
Colin Crosscf3a0b52017-11-16 00:15:28 -0800123 $(files_to_check_apis) \
124 $(common_src_files) \
Bart Searsa8cc0582015-05-07 03:23:20 +0000125
126# This is used by ide.mk as the list of source files that are
127# always included.
128INTERNAL_SDK_SOURCE_DIRS := $(addprefix $(LOCAL_PATH)/,$(dirs_to_document))
129
130framework_docs_LOCAL_DROIDDOC_SOURCE_PATH := \
131 $(FRAMEWORKS_BASE_JAVA_SRC_DIRS)
132
Colin Crosscf3a0b52017-11-16 00:15:28 -0800133framework_docs_LOCAL_SRCJARS := $(SOONG_FRAMEWORK_SRCJARS)
134
Colin Crossbd200ce2017-12-04 13:45:19 -0800135framework_docs_LOCAL_GENERATED_SOURCES := \
136 $(libcore_to_document_generated) \
137 $(files_to_check_apis_generated) \
Bart Searsa8cc0582015-05-07 03:23:20 +0000138
139framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES := \
Piotr Jastrzebskicfa292e2015-02-17 16:58:52 +0000140 core-oj \
Bart Searsa8cc0582015-05-07 03:23:20 +0000141 core-libart \
142 conscrypt \
143 bouncycastle \
144 okhttp \
145 ext \
146 framework \
Paul Duffinc08090f2017-06-29 14:58:43 +0100147 voip-common \
Bart Searsa8cc0582015-05-07 03:23:20 +0000148
Alan Viverette9ca513e2017-04-05 10:21:58 -0400149# Platform docs can refer to Support Library APIs, but we don't actually build
150# them as part of the docs target, so we need to include them on the classpath.
Bart Searsa8cc0582015-05-07 03:23:20 +0000151framework_docs_LOCAL_JAVA_LIBRARIES := \
152 $(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES) \
153 $(FRAMEWORKS_SUPPORT_JAVA_LIBRARIES)
154
155framework_docs_LOCAL_MODULE_CLASS := JAVA_LIBRARIES
156framework_docs_LOCAL_DROIDDOC_HTML_DIR := docs/html
157# The since flag (-since N.xml API_LEVEL) is used to add API Level information
158# to the reference documentation. Must be in order of oldest to newest.
159#
160# Conscrypt (com.android.org.conscrypt) is an implementation detail and should
161# not be referenced in the documentation.
162framework_docs_LOCAL_DROIDDOC_OPTIONS := \
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -0600163 -android \
Bart Searsa8cc0582015-05-07 03:23:20 +0000164 -knowntags ./frameworks/base/docs/knowntags.txt \
Narayan Kamath2c4f2842015-07-27 14:02:11 +0100165 -knowntags ./libcore/known_oj_tags.txt \
Jeff Sharkeybfc4fcd2017-06-05 17:38:17 -0600166 -manifest ./frameworks/base/core/res/AndroidManifest.xml \
Tobias Thiererdda16e82018-03-05 22:55:32 +0000167 -hidePackage com.android.internal \
168 -hidePackage com.android.internal.util \
Neil Fuller57157fb2017-11-24 15:58:38 +0000169 -hidePackage com.android.okhttp \
Bart Searsa8cc0582015-05-07 03:23:20 +0000170 -hidePackage com.android.org.conscrypt \
Neil Fuller371c08c2017-11-27 10:32:07 +0000171 -hidePackage com.android.server \
Bart Searsa8cc0582015-05-07 03:23:20 +0000172 -since $(SRC_API_DIR)/1.xml 1 \
173 -since $(SRC_API_DIR)/2.xml 2 \
174 -since $(SRC_API_DIR)/3.xml 3 \
175 -since $(SRC_API_DIR)/4.xml 4 \
176 -since $(SRC_API_DIR)/5.xml 5 \
177 -since $(SRC_API_DIR)/6.xml 6 \
178 -since $(SRC_API_DIR)/7.xml 7 \
179 -since $(SRC_API_DIR)/8.xml 8 \
180 -since $(SRC_API_DIR)/9.xml 9 \
181 -since $(SRC_API_DIR)/10.xml 10 \
182 -since $(SRC_API_DIR)/11.xml 11 \
183 -since $(SRC_API_DIR)/12.xml 12 \
184 -since $(SRC_API_DIR)/13.xml 13 \
185 -since $(SRC_API_DIR)/14.txt 14 \
186 -since $(SRC_API_DIR)/15.txt 15 \
187 -since $(SRC_API_DIR)/16.txt 16 \
188 -since $(SRC_API_DIR)/17.txt 17 \
189 -since $(SRC_API_DIR)/18.txt 18 \
190 -since $(SRC_API_DIR)/19.txt 19 \
191 -since $(SRC_API_DIR)/20.txt 20 \
192 -since $(SRC_API_DIR)/21.txt 21 \
193 -since $(SRC_API_DIR)/22.txt 22 \
Joe Fernandez1827e322015-08-12 19:45:22 -0700194 -since $(SRC_API_DIR)/23.txt 23 \
Dirk Dougherty5f60f7c2016-06-14 16:26:28 -0700195 -since $(SRC_API_DIR)/24.txt 24 \
Dirk Dougherty3376f582016-10-14 10:27:08 -0700196 -since $(SRC_API_DIR)/25.txt 25 \
Dirk Doughertyfdad0ba2017-06-09 14:43:32 -0700197 -since $(SRC_API_DIR)/26.txt 26 \
Andrew Solovaya6019b22017-10-06 14:27:20 -0700198 -since $(SRC_API_DIR)/27.txt 27 \
Anton Hansson092d9b82018-04-19 14:04:32 +0100199 -since $(SRC_API_DIR)/28.txt 28 \
Jeff Sharkeyc204c222017-11-27 15:02:10 -0700200 -werror -lerror -hide 111 -hide 113 -hide 125 -hide 126 -hide 127 -hide 128 \
Jeff Sharkey0f3f60b2017-04-24 18:06:20 -0600201 -overview $(LOCAL_PATH)/core/java/overview.html \
Bart Searsa8cc0582015-05-07 03:23:20 +0000202
203framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR:= \
204 $(call intermediates-dir-for,JAVA_LIBRARIES,framework,,COMMON)
205
206framework_docs_LOCAL_ADDITIONAL_JAVA_DIR:= \
Alan Viverette9ca513e2017-04-05 10:21:58 -0400207 $(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
Bart Searsa8cc0582015-05-07 03:23:20 +0000208
209framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES := \
Narayan Kamathc21739a2015-07-14 13:39:23 +0100210 frameworks/base/docs/knowntags.txt \
Colin Cross72d359f2017-10-27 10:46:53 -0700211 $(libcore_to_document_generated)
Bart Searsa8cc0582015-05-07 03:23:20 +0000212
213samples_dir := development/samples/browseable
214
215# Whitelist of valid groups, used for default TOC grouping. Each sample must
216# belong to one (and only one) group. Assign samples to groups by setting
217# a sample.group var to one of these groups in the sample's _index.jd.
218sample_groups := -samplegroup Admin \
219 -samplegroup Background \
220 -samplegroup Connectivity \
221 -samplegroup Content \
222 -samplegroup Input \
223 -samplegroup Media \
224 -samplegroup Notification \
225 -samplegroup RenderScript \
226 -samplegroup Security \
227 -samplegroup Sensors \
Trevor Johns4cbe3592015-05-27 14:50:51 -0700228 -samplegroup System \
Bart Searsa8cc0582015-05-07 03:23:20 +0000229 -samplegroup Testing \
230 -samplegroup UI \
231 -samplegroup Views \
232 -samplegroup Wearable
233
234## SDK version identifiers used in the published docs
235 # major[.minor] version for current SDK. (full releases only)
smain@google.comdde8deb2016-08-29 18:36:50 -0700236framework_docs_SDK_VERSION:=7.0
Bart Searsa8cc0582015-05-07 03:23:20 +0000237 # release version (ie "Release x") (full releases only)
238framework_docs_SDK_REL_ID:=1
239
240framework_docs_LOCAL_DROIDDOC_OPTIONS += \
Billy Lamberta75dbc8f2017-03-03 13:09:15 -0800241 -hdf dac true \
Scott Mainf8cdfc82017-03-21 13:43:31 -0700242 -hdf sdk.codename O \
243 -hdf sdk.preview.version 1 \
Bart Searsa8cc0582015-05-07 03:23:20 +0000244 -hdf sdk.version $(framework_docs_SDK_VERSION) \
245 -hdf sdk.rel.id $(framework_docs_SDK_REL_ID) \
Scott Mainf8cdfc82017-03-21 13:43:31 -0700246 -hdf sdk.preview 0 \
247 -resourcesdir $(LOCAL_PATH)/docs/html/reference/images/ \
248 -resourcesoutdir reference/android/images/
Bart Searsa8cc0582015-05-07 03:23:20 +0000249
Alan Viverette9ca513e2017-04-05 10:21:58 -0400250# Federate Support Library references against local API file.
251framework_docs_LOCAL_DROIDDOC_OPTIONS += \
252 -federate SupportLib https://developer.android.com \
253 -federationapi SupportLib prebuilts/sdk/current/support-api.txt
254
Alan Viverette67b51d42018-03-28 17:10:20 -0400255# Federate AndroidX references against local API file.
256framework_docs_LOCAL_DROIDDOC_OPTIONS += \
257 -federate AndroidX https://developer.android.com \
258 -federationapi AndroidX prebuilts/sdk/current/androidx-api.txt
259
Jeff Sharkeyd2bf31c2017-11-29 13:14:27 -0700260# ==== Public API diff ===========================
Alan Viverette6b7354c2017-07-13 17:10:14 -0400261include $(CLEAR_VARS)
262
263LOCAL_SRC_FILES := $(framework_docs_LOCAL_API_CHECK_SRC_FILES)
Colin Crossbd200ce2017-12-04 13:45:19 -0800264LOCAL_GENERATED_SOURCES := $(framework_docs_LOCAL_GENERATED_SOURCES)
Colin Crosscf3a0b52017-11-16 00:15:28 -0800265LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
Alan Viverette6b7354c2017-07-13 17:10:14 -0400266LOCAL_JAVA_LIBRARIES := $(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
267LOCAL_MODULE_CLASS := $(framework_docs_LOCAL_MODULE_CLASS)
268LOCAL_ADDITIONAL_JAVA_DIR := $(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
269LOCAL_ADDITIONAL_DEPENDENCIES := \
270 $(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES) \
271 $(INTERNAL_PLATFORM_API_FILE)
272
273LOCAL_MODULE := offline-sdk-referenceonly
274
275last_released_sdk_version := $(lastword $(call numerically_sort, \
276 $(filter-out current, \
277 $(patsubst $(SRC_API_DIR)/%.txt,%, $(wildcard $(SRC_API_DIR)/*.txt)) \
278 )\
279 ))
280
281LOCAL_APIDIFF_OLDAPI := $(LOCAL_PATH)/../../$(SRC_API_DIR)/$(last_released_sdk_version)
282LOCAL_APIDIFF_NEWAPI := $(LOCAL_PATH)/../../$(basename $(INTERNAL_PLATFORM_API_FILE))
283
284include $(BUILD_APIDIFF)
285
Jeff Sharkeyc8dc2542017-12-08 14:52:37 -0700286# Hack to get diffs included in docs output
287out_zip := $(OUT_DOCS)/$(LOCAL_MODULE)-docs.zip
288$(out_zip): $(full_target)
289
Jeff Sharkeyd2bf31c2017-11-29 13:14:27 -0700290# ==== System API diff ===========================
291include $(CLEAR_VARS)
292
293LOCAL_SRC_FILES := $(framework_docs_LOCAL_API_CHECK_SRC_FILES)
Colin Crossbd200ce2017-12-04 13:45:19 -0800294LOCAL_GENERATED_SOURCES := $(framework_docs_LOCAL_GENERATED_SOURCES)
Colin Crosscf3a0b52017-11-16 00:15:28 -0800295LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
Jeff Sharkeyd2bf31c2017-11-29 13:14:27 -0700296LOCAL_JAVA_LIBRARIES := $(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
297LOCAL_MODULE_CLASS := $(framework_docs_LOCAL_MODULE_CLASS)
298LOCAL_ADDITIONAL_JAVA_DIR := $(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
299LOCAL_ADDITIONAL_DEPENDENCIES := \
300 $(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES) \
301 $(INTERNAL_PLATFORM_SYSTEM_API_FILE)
302
303LOCAL_MODULE := offline-system-sdk-referenceonly
304
305last_released_sdk_version := $(lastword $(call numerically_sort, \
306 $(filter-out current, \
307 $(patsubst $(SRC_SYSTEM_API_DIR)/%.txt,%, $(wildcard $(SRC_SYSTEM_API_DIR)/*.txt)) \
308 )\
309 ))
310
311LOCAL_APIDIFF_OLDAPI := $(LOCAL_PATH)/../../$(SRC_SYSTEM_API_DIR)/$(last_released_sdk_version)
312LOCAL_APIDIFF_NEWAPI := $(LOCAL_PATH)/../../$(basename $(INTERNAL_PLATFORM_SYSTEM_API_FILE))
313
314include $(BUILD_APIDIFF)
315
Jeff Sharkeyc8dc2542017-12-08 14:52:37 -0700316# Hack to get diffs included in docs output
317out_zip := $(OUT_DOCS)/$(LOCAL_MODULE)-docs.zip
318$(out_zip): $(full_target)
319
Bart Searsa8cc0582015-05-07 03:23:20 +0000320# ==== the api stubs and current.xml ===========================
321include $(CLEAR_VARS)
322
323LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
Colin Crossbd200ce2017-12-04 13:45:19 -0800324LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
Colin Crosscf3a0b52017-11-16 00:15:28 -0800325LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
Bart Searsa8cc0582015-05-07 03:23:20 +0000326LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
327LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
328LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
329LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
330LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
331LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
332
333LOCAL_MODULE := api-stubs
334
Ying Wang0f92a2e2015-07-16 14:20:22 -0700335LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/android_stubs_current_intermediates/src
336
Bart Searsa8cc0582015-05-07 03:23:20 +0000337LOCAL_DROIDDOC_OPTIONS:=\
338 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
smain@google.com534bfe12016-09-01 19:52:17 -0700339 -referenceonly \
Bart Searsa8cc0582015-05-07 03:23:20 +0000340 -api $(INTERNAL_PLATFORM_API_FILE) \
341 -removedApi $(INTERNAL_PLATFORM_REMOVED_API_FILE) \
342 -nodocs
343
Scott Main15b85172017-02-21 14:30:58 -0800344LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
Bart Searsa8cc0582015-05-07 03:23:20 +0000345
346LOCAL_UNINSTALLABLE_MODULE := true
347
348include $(BUILD_DROIDDOC)
349
David Brazdila793f3f2018-01-16 15:03:20 +0000350$(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_API_FILE) \
David Brazdil68e1c1d2018-03-08 14:32:27 +0000351 $(INTERNAL_PLATFORM_REMOVED_API_FILE)
Bart Searsa8cc0582015-05-07 03:23:20 +0000352$(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_API_FILE))
353
354# ==== the system api stubs ===================================
355include $(CLEAR_VARS)
356
357LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
Colin Crossbd200ce2017-12-04 13:45:19 -0800358LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
Colin Crosscf3a0b52017-11-16 00:15:28 -0800359LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
Bart Searsa8cc0582015-05-07 03:23:20 +0000360LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
361LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
362LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
363LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
364LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
365LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
366
367LOCAL_MODULE := system-api-stubs
368
Ying Wang0f92a2e2015-07-16 14:20:22 -0700369LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/android_system_stubs_current_intermediates/src
370
Bart Searsa8cc0582015-05-07 03:23:20 +0000371LOCAL_DROIDDOC_OPTIONS:=\
372 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
smain@google.com534bfe12016-09-01 19:52:17 -0700373 -referenceonly \
Bart Searsa8cc0582015-05-07 03:23:20 +0000374 -showAnnotation android.annotation.SystemApi \
375 -api $(INTERNAL_PLATFORM_SYSTEM_API_FILE) \
376 -removedApi $(INTERNAL_PLATFORM_SYSTEM_REMOVED_API_FILE) \
Jeff Sharkey05461c02017-05-09 19:01:09 -0600377 -exactApi $(INTERNAL_PLATFORM_SYSTEM_EXACT_API_FILE) \
Bart Searsa8cc0582015-05-07 03:23:20 +0000378 -nodocs
379
Scott Main15b85172017-02-21 14:30:58 -0800380LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
Bart Searsa8cc0582015-05-07 03:23:20 +0000381
382LOCAL_UNINSTALLABLE_MODULE := true
383
384include $(BUILD_DROIDDOC)
385
David Brazdila793f3f2018-01-16 15:03:20 +0000386$(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_SYSTEM_API_FILE) \
David Brazdil68e1c1d2018-03-08 14:32:27 +0000387 $(INTERNAL_PLATFORM_SYSTEM_REMOVED_API_FILE) \
388 $(INTERNAL_PLATFORM_SYSTEM_EXACT_API_FILE)
Bart Searsa8cc0582015-05-07 03:23:20 +0000389$(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_SYSTEM_API_FILE))
390
Michael Wrightb2b2c0e2015-11-06 15:21:13 +0000391# ==== the test api stubs ===================================
392include $(CLEAR_VARS)
393
394LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
Colin Crossbd200ce2017-12-04 13:45:19 -0800395LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
Colin Crosscf3a0b52017-11-16 00:15:28 -0800396LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
Michael Wrightb2b2c0e2015-11-06 15:21:13 +0000397LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
398LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
399LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
400LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
401LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
402LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
403
404LOCAL_MODULE := test-api-stubs
405
406LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/android_test_stubs_current_intermediates/src
407
408LOCAL_DROIDDOC_OPTIONS:=\
409 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
smain@google.com534bfe12016-09-01 19:52:17 -0700410 -referenceonly \
Michael Wrightb2b2c0e2015-11-06 15:21:13 +0000411 -stubs $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/android_test_stubs_current_intermediates/src \
412 -showAnnotation android.annotation.TestApi \
413 -api $(INTERNAL_PLATFORM_TEST_API_FILE) \
414 -removedApi $(INTERNAL_PLATFORM_TEST_REMOVED_API_FILE) \
Jeff Sharkey05461c02017-05-09 19:01:09 -0600415 -exactApi $(INTERNAL_PLATFORM_TEST_EXACT_API_FILE) \
Michael Wrightb2b2c0e2015-11-06 15:21:13 +0000416 -nodocs
417
Scott Main15b85172017-02-21 14:30:58 -0800418LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
Michael Wrightb2b2c0e2015-11-06 15:21:13 +0000419
420LOCAL_UNINSTALLABLE_MODULE := true
421
422include $(BUILD_DROIDDOC)
423
David Brazdil68e1c1d2018-03-08 14:32:27 +0000424$(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_TEST_API_FILE) \
425 $(INTERNAL_PLATFORM_TEST_REMOVED_API_FILE) \
426 $(INTERNAL_PLATFORM_TEST_EXACT_API_FILE)
Michael Wrightb2b2c0e2015-11-06 15:21:13 +0000427$(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_TEST_API_FILE))
428
David Brazdil68e1c1d2018-03-08 14:32:27 +0000429# ==== the complete hidden api list ===================================
430include $(CLEAR_VARS)
431
432LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
433LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
434LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
435LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
436LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
437LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
438LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
439LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
440LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
441
442LOCAL_MODULE := hidden-api-list
443
444LOCAL_DROIDDOC_OPTIONS:=\
445 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
446 -referenceonly \
447 -showUnannotated \
448 -showAnnotation android.annotation.SystemApi \
449 -showAnnotation android.annotation.TestApi \
450 -privateDexApi $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE) \
David Brazdil0f0abb22018-04-26 16:10:35 +0100451 -removedDexApi $(INTERNAL_PLATFORM_REMOVED_DEX_API_FILE) \
David Brazdil68e1c1d2018-03-08 14:32:27 +0000452 -nodocs
453
454LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
455
456LOCAL_UNINSTALLABLE_MODULE := true
457
458include $(BUILD_DROIDDOC)
459
David Brazdil0f0abb22018-04-26 16:10:35 +0100460$(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE) \
461 $(INTERNAL_PLATFORM_REMOVED_DEX_API_FILE)
David Brazdil68e1c1d2018-03-08 14:32:27 +0000462
Bart Searsa8cc0582015-05-07 03:23:20 +0000463# ==== check javadoc comments but don't generate docs ========
464include $(CLEAR_VARS)
465
466LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
Colin Crossbd200ce2017-12-04 13:45:19 -0800467LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
Colin Crosscf3a0b52017-11-16 00:15:28 -0800468LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
Bart Searsa8cc0582015-05-07 03:23:20 +0000469LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
470LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
471LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
472LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
473LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
474LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
475
476LOCAL_MODULE := doc-comment-check
477
478LOCAL_DROIDDOC_OPTIONS:=\
479 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
smain@google.com534bfe12016-09-01 19:52:17 -0700480 -referenceonly \
Bart Searsa8cc0582015-05-07 03:23:20 +0000481 -parsecomments
482
Scott Main15b85172017-02-21 14:30:58 -0800483LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
Bart Searsa8cc0582015-05-07 03:23:20 +0000484
485LOCAL_UNINSTALLABLE_MODULE := true
486
487include $(BUILD_DROIDDOC)
488
Bart Searsa8cc0582015-05-07 03:23:20 +0000489# Run this for checkbuild
490checkbuild: doc-comment-check-docs
491# Check comment when you are updating the API
492update-api: doc-comment-check-docs
493
494# ==== static html in the sdk ==================================
495include $(CLEAR_VARS)
496
497LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
Colin Crossbd200ce2017-12-04 13:45:19 -0800498LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
Colin Crosscf3a0b52017-11-16 00:15:28 -0800499LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
Bart Searsa8cc0582015-05-07 03:23:20 +0000500LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
501LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
502LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
503LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
504LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
505LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
506
507LOCAL_MODULE := offline-sdk
508
509LOCAL_DROIDDOC_OPTIONS:=\
510 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
511 -offlinemode \
512 -title "Android SDK" \
513 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-proofread.txt \
smain@google.com00de8c52016-03-07 18:38:08 -0800514 -sdkvalues $(OUT_DOCS) \
smain@google.com8562ab52016-06-14 17:11:57 -0700515 -hdf android.whichdoc offline
516
Scott Main15b85172017-02-21 14:30:58 -0800517LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
smain@google.com8562ab52016-06-14 17:11:57 -0700518
519include $(BUILD_DROIDDOC)
520
521static_doc_index_redirect := $(out_dir)/index.html
522$(static_doc_index_redirect): \
523 $(LOCAL_PATH)/docs/docs-preview-index.html | $(ACP)
524 $(hide) mkdir -p $(dir $@)
525 $(hide) $(ACP) $< $@
526
527$(full_target): $(static_doc_index_redirect)
smain@google.com8562ab52016-06-14 17:11:57 -0700528
529
Jeff Sharkeyd2bf31c2017-11-29 13:14:27 -0700530# ==== Public API static reference docs ==================================
smain@google.com8562ab52016-06-14 17:11:57 -0700531include $(CLEAR_VARS)
532
533LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
Colin Crossbd200ce2017-12-04 13:45:19 -0800534LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
Colin Crosscf3a0b52017-11-16 00:15:28 -0800535LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
smain@google.com8562ab52016-06-14 17:11:57 -0700536LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
537LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
538LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
539LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
540LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
541LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
542
543LOCAL_MODULE := offline-sdk-referenceonly
544
545LOCAL_DROIDDOC_OPTIONS:=\
546 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
547 -offlinemode \
548 -title "Android SDK" \
549 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-proofread.txt \
550 -sdkvalues $(OUT_DOCS) \
smain@google.com00de8c52016-03-07 18:38:08 -0800551 -hdf android.whichdoc offline \
Scott Mainf8cdfc82017-03-21 13:43:31 -0700552 -referenceonly
smain@google.com00de8c52016-03-07 18:38:08 -0800553
Scott Main15b85172017-02-21 14:30:58 -0800554LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
smain@google.com00de8c52016-03-07 18:38:08 -0800555
556include $(BUILD_DROIDDOC)
557
558static_doc_index_redirect := $(out_dir)/index.html
smain@google.com151833a2016-08-31 08:42:09 -0700559$(static_doc_index_redirect): $(LOCAL_PATH)/docs/docs-documentation-redirect.html
Dan Willemsen98ff0b72016-03-23 00:42:44 -0700560 $(copy-file-to-target)
smain@google.com00de8c52016-03-07 18:38:08 -0800561
smain@google.com2f2365d2016-09-21 14:05:50 -0700562static_doc_properties := $(out_dir)/source.properties
563$(static_doc_properties): \
564 $(LOCAL_PATH)/docs/source.properties | $(ACP)
565 $(hide) mkdir -p $(dir $@)
566 $(hide) $(ACP) $< $@
567
smain@google.com00de8c52016-03-07 18:38:08 -0800568$(full_target): $(static_doc_index_redirect)
smain@google.com2f2365d2016-09-21 14:05:50 -0700569$(full_target): $(static_doc_properties)
smain@google.com00de8c52016-03-07 18:38:08 -0800570
smain@google.com7aca8be2016-03-10 14:13:30 -0800571
Jeff Sharkeyd2bf31c2017-11-29 13:14:27 -0700572# ==== System API static reference docs ==================================
573include $(CLEAR_VARS)
574
575LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
Colin Crossbd200ce2017-12-04 13:45:19 -0800576LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
Colin Crosscf3a0b52017-11-16 00:15:28 -0800577LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
Jeff Sharkeyd2bf31c2017-11-29 13:14:27 -0700578LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
579LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
580LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
581LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
582LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
583LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
584
585LOCAL_MODULE := offline-system-sdk-referenceonly
586
587LOCAL_DROIDDOC_OPTIONS:=\
588 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
589 -hide 101 -hide 104 -hide 108 \
590 -showAnnotation android.annotation.SystemApi \
591 -offlinemode \
592 -title "Android System SDK" \
593 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-proofread.txt \
594 -sdkvalues $(OUT_DOCS) \
595 -hdf android.whichdoc offline \
596 -referenceonly
597
598LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
599
600include $(BUILD_DROIDDOC)
601
602static_doc_index_redirect := $(out_dir)/index.html
603$(static_doc_index_redirect): $(LOCAL_PATH)/docs/docs-documentation-redirect.html
604 $(copy-file-to-target)
605
606static_doc_properties := $(out_dir)/source.properties
607$(static_doc_properties): \
608 $(LOCAL_PATH)/docs/source.properties | $(ACP)
609 $(hide) mkdir -p $(dir $@)
610 $(hide) $(ACP) $< $@
611
612$(full_target): $(static_doc_index_redirect)
613$(full_target): $(static_doc_properties)
614$(full_target): $(framework_built)
615
616
Bart Searsa8cc0582015-05-07 03:23:20 +0000617# ==== docs for the web (on the androiddevdocs app engine server) =======================
618include $(CLEAR_VARS)
619
620LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
Colin Crossbd200ce2017-12-04 13:45:19 -0800621LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
Colin Crosscf3a0b52017-11-16 00:15:28 -0800622LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
Bart Searsa8cc0582015-05-07 03:23:20 +0000623LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
624LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
625LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
626LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
627LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
628LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
629LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
630LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
631
632LOCAL_MODULE := online-sdk
633
634LOCAL_DROIDDOC_OPTIONS:= \
635 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
636 -toroot / \
637 -hdf android.whichdoc online \
638 $(sample_groups) \
639 -hdf android.hasSamples true \
640 -samplesdir $(samples_dir)
641
Scott Main15b85172017-02-21 14:30:58 -0800642LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
Bart Searsa8cc0582015-05-07 03:23:20 +0000643
644include $(BUILD_DROIDDOC)
645
646# ==== docs for the web (on the androiddevdocs app engine server) =======================
Bart Searsa8cc0582015-05-07 03:23:20 +0000647include $(CLEAR_VARS)
648
649LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
Colin Crossbd200ce2017-12-04 13:45:19 -0800650LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
Colin Crosscf3a0b52017-11-16 00:15:28 -0800651LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
Bart Searsa8cc0582015-05-07 03:23:20 +0000652LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
653LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
654LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
655LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
656LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
657LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
658LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
659LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
660
661LOCAL_MODULE := online-system-api-sdk
662
663LOCAL_DROIDDOC_OPTIONS:= \
664 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
smain@google.com534bfe12016-09-01 19:52:17 -0700665 -referenceonly \
Bart Searsa8cc0582015-05-07 03:23:20 +0000666 -showAnnotation android.annotation.SystemApi \
667 -title "Android SDK - Including system APIs." \
668 -toroot / \
Gina Dimino98ad8882016-05-31 17:25:48 -0700669 -hide 101 \
670 -hide 104 \
671 -hide 108 \
Bart Searsa8cc0582015-05-07 03:23:20 +0000672 -hdf android.whichdoc online \
673 $(sample_groups) \
674 -hdf android.hasSamples true \
675 -samplesdir $(samples_dir)
676
Scott Main15b85172017-02-21 14:30:58 -0800677LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
Jeff Sharkey05461c02017-05-09 19:01:09 -0600678
Bart Searsa8cc0582015-05-07 03:23:20 +0000679LOCAL_UNINSTALLABLE_MODULE := true
680
681include $(BUILD_DROIDDOC)
Bart Searsa8cc0582015-05-07 03:23:20 +0000682
683# ==== docs for the web (on the devsite app engine server) =======================
684include $(CLEAR_VARS)
685LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
Colin Crossbd200ce2017-12-04 13:45:19 -0800686LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
Colin Crosscf3a0b52017-11-16 00:15:28 -0800687LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
Bart Searsa8cc0582015-05-07 03:23:20 +0000688LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
689LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
690LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
691LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
692LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
693LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
694LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
695# specify a second html input dir and an output path relative to OUT_DIR)
Dirk Dougherty3852c1f2016-04-10 02:05:09 -0700696LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
Bart Searsa8cc0582015-05-07 03:23:20 +0000697
698LOCAL_MODULE := ds
699
700LOCAL_DROIDDOC_OPTIONS:= \
701 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
Bart Searsa8cc0582015-05-07 03:23:20 +0000702 -toroot / \
703 -hdf android.whichdoc online \
Dirk Doughertyb042ab12016-06-14 16:26:28 -0700704 -devsite \
Scott Main4f9b48c2017-12-19 13:43:45 -0800705 -yamlV2 \
Dirk Dougherty3852c1f2016-04-10 02:05:09 -0700706 $(sample_groups) \
Dirk Dougherty3852c1f2016-04-10 02:05:09 -0700707 -hdf android.hasSamples true \
708 -samplesdir $(samples_dir)
Bart Searsa8cc0582015-05-07 03:23:20 +0000709
Scott Main15b85172017-02-21 14:30:58 -0800710LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
Bart Searsa8cc0582015-05-07 03:23:20 +0000711
712include $(BUILD_DROIDDOC)
713
Dirk Doughertyb042ab12016-06-14 16:26:28 -0700714# ==== docs for the web (on the devsite app engine server) =======================
715include $(CLEAR_VARS)
716LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
Colin Crossbd200ce2017-12-04 13:45:19 -0800717LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
Colin Crosscf3a0b52017-11-16 00:15:28 -0800718LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
Dirk Doughertyb042ab12016-06-14 16:26:28 -0700719LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
720LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
721LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
722LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
723LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
724LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
725LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
726# specify a second html input dir and an output path relative to OUT_DIR)
727LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
728
729LOCAL_MODULE := ds-static
730
731LOCAL_DROIDDOC_OPTIONS:= \
732 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
733 -hdf android.whichdoc online \
734 -staticonly \
735 -toroot / \
736 -devsite \
737 -ignoreJdLinks
738
Scott Main15b85172017-02-21 14:30:58 -0800739LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
Dirk Doughertyb042ab12016-06-14 16:26:28 -0700740
741include $(BUILD_DROIDDOC)
742
Dirk Dougherty7d47b552016-09-13 16:44:25 -0700743# ==== generates full navtree for resolving @links in ds postprocessing ====
744include $(CLEAR_VARS)
745
746LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
Colin Crossbd200ce2017-12-04 13:45:19 -0800747LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
Colin Crosscf3a0b52017-11-16 00:15:28 -0800748LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
Dirk Dougherty7d47b552016-09-13 16:44:25 -0700749LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
750LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
751LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
752LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
753LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
754LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
755
756LOCAL_MODULE := ds-ref-navtree
757
758LOCAL_DROIDDOC_OPTIONS:= \
759 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
760 -hdf android.whichdoc online \
761 -toroot / \
762 -atLinksNavtree \
763 -navtreeonly
764
Scott Main15b85172017-02-21 14:30:58 -0800765LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
Dirk Dougherty7d47b552016-09-13 16:44:25 -0700766
767include $(BUILD_DROIDDOC)
768
Dirk Dougherty31ae1c512015-11-07 13:18:02 -0800769# ==== site updates for docs (on the androiddevdocs app engine server) =======================
Bart Searsa8cc0582015-05-07 03:23:20 +0000770include $(CLEAR_VARS)
Dirk Dougherty31ae1c512015-11-07 13:18:02 -0800771
Bart Searsa8cc0582015-05-07 03:23:20 +0000772LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
Colin Crossbd200ce2017-12-04 13:45:19 -0800773LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
Colin Crosscf3a0b52017-11-16 00:15:28 -0800774LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
Bart Searsa8cc0582015-05-07 03:23:20 +0000775LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
776LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
777LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
778LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
Dirk Dougherty31ae1c512015-11-07 13:18:02 -0800779LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
Bart Searsa8cc0582015-05-07 03:23:20 +0000780LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
781LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
Dirk Dougherty31ae1c512015-11-07 13:18:02 -0800782LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
Bart Searsa8cc0582015-05-07 03:23:20 +0000783
Dirk Dougherty31ae1c512015-11-07 13:18:02 -0800784LOCAL_MODULE := online-sdk-dev
Bart Searsa8cc0582015-05-07 03:23:20 +0000785
786LOCAL_DROIDDOC_OPTIONS:= \
787 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
788 -toroot / \
789 -hdf android.whichdoc online \
790 $(sample_groups) \
791 -hdf android.hasSamples true \
792 -samplesdir $(samples_dir)
793
Scott Main15b85172017-02-21 14:30:58 -0800794LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
Bart Searsa8cc0582015-05-07 03:23:20 +0000795
796include $(BUILD_DROIDDOC)
797
Bart Searsa8cc0582015-05-07 03:23:20 +0000798# ==== docs that have all of the stuff that's @hidden =======================
799include $(CLEAR_VARS)
800
801LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
Colin Crossbd200ce2017-12-04 13:45:19 -0800802LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
Colin Crosscf3a0b52017-11-16 00:15:28 -0800803LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
Bart Searsa8cc0582015-05-07 03:23:20 +0000804LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
805LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
806LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
807LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
808LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
809LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
810
811LOCAL_MODULE := hidden
812LOCAL_DROIDDOC_OPTIONS:=\
813 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
smain@google.com534bfe12016-09-01 19:52:17 -0700814 -referenceonly \
Bart Searsa8cc0582015-05-07 03:23:20 +0000815 -title "Android SDK - Including hidden APIs."
816# -hidden
817
Scott Main15b85172017-02-21 14:30:58 -0800818LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
Bart Searsa8cc0582015-05-07 03:23:20 +0000819
820include $(BUILD_DROIDDOC)
821
Joe Onorato1754d742016-11-21 17:51:35 -0800822# ==== java proto host library ==============================
823include $(CLEAR_VARS)
824LOCAL_MODULE := platformprotos
825LOCAL_PROTOC_OPTIMIZE_TYPE := full
826LOCAL_PROTOC_FLAGS := \
827 -Iexternal/protobuf/src
828LOCAL_SOURCE_FILES_ALL_GENERATED := true
829LOCAL_SRC_FILES := \
Mike Mada3a2952017-11-13 12:06:45 -0800830 cmds/am/proto/instrumentation_data.proto \
Primiano Tuccie4d44912018-01-10 12:14:50 +0000831 cmds/statsd/src/perfetto/perfetto_config.proto \
Joe Onorato1754d742016-11-21 17:51:35 -0800832 $(call all-proto-files-under, core/proto) \
Chenjie Yu15176cd2017-11-22 12:36:41 -0800833 $(call all-proto-files-under, libs/incident/proto) \
834 $(call all-proto-files-under, cmds/statsd/src)
Andreas Gampe3e429f32018-02-15 15:12:38 -0800835# b/72714520
836LOCAL_ERROR_PRONE_FLAGS := -Xep:MissingOverride:OFF
Joe Onorato1754d742016-11-21 17:51:35 -0800837include $(BUILD_HOST_JAVA_LIBRARY)
838
Steven Timotius7ece0422017-08-03 13:37:26 -0700839# ==== java proto device library (for test only) ==============================
840include $(CLEAR_VARS)
841LOCAL_MODULE := platformprotosnano
Joe Onorato62c220b2017-11-18 20:32:56 -0800842LOCAL_MODULE_TAGS := tests
Steven Timotius7ece0422017-08-03 13:37:26 -0700843LOCAL_PROTOC_OPTIMIZE_TYPE := nano
844LOCAL_PROTOC_FLAGS := \
845 -Iexternal/protobuf/src
846LOCAL_PROTO_JAVA_OUTPUT_PARAMS := \
847 store_unknown_fields = true
Jiyong Parkf0048392018-02-12 21:57:59 +0900848LOCAL_SDK_VERSION := current
Steven Timotius7ece0422017-08-03 13:37:26 -0700849LOCAL_SRC_FILES := \
Yi Jin437aa6e2018-01-10 11:34:26 -0800850 $(call all-proto-files-under, core/proto) \
851 $(call all-proto-files-under, libs/incident/proto/android/os)
Steven Timotius7ece0422017-08-03 13:37:26 -0700852include $(BUILD_STATIC_JAVA_LIBRARY)
853
Bart Searsa8cc0582015-05-07 03:23:20 +0000854
Joe Onorato62c220b2017-11-18 20:32:56 -0800855# ==== java proto device library (for test only) ==============================
856include $(CLEAR_VARS)
857LOCAL_MODULE := platformprotoslite
858LOCAL_MODULE_TAGS := tests
859LOCAL_PROTOC_OPTIMIZE_TYPE := lite
860LOCAL_PROTOC_FLAGS := \
861 -Iexternal/protobuf/src
862LOCAL_SRC_FILES := \
Yi Jin437aa6e2018-01-10 11:34:26 -0800863 $(call all-proto-files-under, core/proto) \
864 $(call all-proto-files-under, libs/incident/proto/android/os)
Andreas Gampe93b64c92018-01-30 18:50:34 -0800865# Protos have lots of MissingOverride and similar.
866LOCAL_ERROR_PRONE_FLAGS := -XepDisableAllChecks
Joe Onorato62c220b2017-11-18 20:32:56 -0800867include $(BUILD_STATIC_JAVA_LIBRARY)
868
David Brazdil0649c8d2018-01-22 22:23:13 +0000869# ==== hiddenapi lists =======================================
870
David Brazdil36bbf122018-03-28 11:28:39 +0100871# Copy light and dark greylist over into the build folder.
David Brazdilf16ac002018-01-26 11:13:35 +0000872# This is for ART buildbots which need to mock these lists and have alternative
873# rules for building them. Other rules in the build system should depend on the
874# files in the build folder.
875
David Brazdil05855332018-04-25 11:15:07 +0100876# Merge light greylist from multiple files:
877# (1) manual light greylist
878# (2) list of usages from vendor apps
879# (3) list of removed APIs
880# @removed does not imply private in Doclava. We must take the subset also
881# in PRIVATE_API.
882# (4) list of serialization APIs
883# Automatically adds all methods which match the signatures in
884# REGEX_SERIALIZATION. These are greylisted in order to allow applications
885# to write their own serializers.
David Brazdil357170b12018-03-26 16:02:23 +0100886$(INTERNAL_PLATFORM_HIDDENAPI_LIGHT_GREYLIST): REGEX_SERIALIZATION := \
887 "readObject\(Ljava/io/ObjectInputStream;\)V" \
888 "readObjectNoData\(\)V" \
889 "readResolve\(\)Ljava/lang/Object;" \
890 "serialVersionUID:J" \
891 "serialPersistentFields:\[Ljava/io/ObjectStreamField;" \
892 "writeObject\(Ljava/io/ObjectOutputStream;\)V" \
893 "writeReplace\(\)Ljava/lang/Object;"
894$(INTERNAL_PLATFORM_HIDDENAPI_LIGHT_GREYLIST): PRIVATE_API := $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE)
David Brazdil05855332018-04-25 11:15:07 +0100895$(INTERNAL_PLATFORM_HIDDENAPI_LIGHT_GREYLIST): REMOVED_API := $(INTERNAL_PLATFORM_REMOVED_DEX_API_FILE)
David Brazdil873d1d32018-03-13 09:41:23 +0000896$(INTERNAL_PLATFORM_HIDDENAPI_LIGHT_GREYLIST): frameworks/base/config/hiddenapi-light-greylist.txt \
David Brazdil357170b12018-03-26 16:02:23 +0100897 frameworks/base/config/hiddenapi-vendor-list.txt \
David Brazdil05855332018-04-25 11:15:07 +0100898 $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE) \
899 $(INTERNAL_PLATFORM_REMOVED_DEX_API_FILE)
David Brazdil357170b12018-03-26 16:02:23 +0100900 sort frameworks/base/config/hiddenapi-light-greylist.txt \
901 frameworks/base/config/hiddenapi-vendor-list.txt \
902 <(grep -E "\->("$(subst $(space),"|",$(REGEX_SERIALIZATION))")$$" $(PRIVATE_API)) \
David Brazdil05855332018-04-25 11:15:07 +0100903 <(comm -12 <(sort $(REMOVED_API)) <(sort $(PRIVATE_API))) \
David Brazdil357170b12018-03-26 16:02:23 +0100904 > $@
David Brazdilf16ac002018-01-26 11:13:35 +0000905
David Brazdil36bbf122018-03-28 11:28:39 +0100906$(eval $(call copy-one-file,frameworks/base/config/hiddenapi-dark-greylist.txt,\
907 $(INTERNAL_PLATFORM_HIDDENAPI_DARK_GREYLIST)))
908
Nicolas Geoffray90fa8ef2018-02-08 17:27:15 +0000909# Generate dark greylist as private API minus (blacklist plus light greylist).
David Brazdil0649c8d2018-01-22 22:23:13 +0000910
David Brazdil36bbf122018-03-28 11:28:39 +0100911$(INTERNAL_PLATFORM_HIDDENAPI_BLACKLIST): PRIVATE_API := $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE)
912$(INTERNAL_PLATFORM_HIDDENAPI_BLACKLIST): LIGHT_GREYLIST := $(INTERNAL_PLATFORM_HIDDENAPI_LIGHT_GREYLIST)
913$(INTERNAL_PLATFORM_HIDDENAPI_BLACKLIST): DARK_GREYLIST := $(INTERNAL_PLATFORM_HIDDENAPI_DARK_GREYLIST)
914$(INTERNAL_PLATFORM_HIDDENAPI_BLACKLIST): $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE) \
915 $(INTERNAL_PLATFORM_HIDDENAPI_LIGHT_GREYLIST) \
916 $(INTERNAL_PLATFORM_HIDDENAPI_DARK_GREYLIST)
917 if [ ! -z "`comm -12 <(sort $(LIGHT_GREYLIST)) <(sort $(DARK_GREYLIST))`" ]; then \
918 echo "There should be no overlap between $(LIGHT_GREYLIST) and $(DARK_GREYLIST)" 1>&2; \
919 comm -12 <(sort $(LIGHT_GREYLIST)) <(sort $(DARK_GREYLIST)) 1>&2; \
David Brazdil0649c8d2018-01-22 22:23:13 +0000920 exit 1; \
David Brazdilb43351f2018-01-31 14:43:36 +0000921 elif [ ! -z "`comm -13 <(sort $(PRIVATE_API)) <(sort $(LIGHT_GREYLIST))`" ]; then \
922 echo "$(LIGHT_GREYLIST) must be a subset of $(PRIVATE_API)" 1>&2; \
David Brazdil36bbf122018-03-28 11:28:39 +0100923 comm -13 <(sort $(PRIVATE_API)) <(sort $(LIGHT_GREYLIST)) 1>&2; \
924 exit 2; \
925 elif [ ! -z "`comm -13 <(sort $(PRIVATE_API)) <(sort $(DARK_GREYLIST))`" ]; then \
926 echo "$(DARK_GREYLIST) must be a subset of $(PRIVATE_API)" 1>&2; \
927 comm -13 <(sort $(PRIVATE_API)) <(sort $(DARK_GREYLIST)) 1>&2; \
David Brazdil0649c8d2018-01-22 22:23:13 +0000928 exit 3; \
929 fi
David Brazdil36bbf122018-03-28 11:28:39 +0100930 comm -23 <(sort $(PRIVATE_API)) <(sort $(LIGHT_GREYLIST) $(DARK_GREYLIST)) > $@
David Brazdil0649c8d2018-01-22 22:23:13 +0000931
Bart Searsa8cc0582015-05-07 03:23:20 +0000932# Include subdirectory makefiles
933# ============================================================
934
935# If we're building with ONE_SHOT_MAKEFILE (mm, mmm), then what the framework
936# team really wants is to build the stuff defined by this makefile.
937ifeq (,$(ONE_SHOT_MAKEFILE))
938include $(call first-makefiles-under,$(LOCAL_PATH))
939endif
940
Holly Jiuyu Sunbbc85802017-12-21 18:44:59 -0800941endif # ANDROID_BUILD_EMBEDDED
942