2 # Copyright (C) 2008 The Android Open Source Project
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
8 # http://www.apache.org/licenses/LICENSE-2.0
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.
16 LOCAL_PATH := $(call my-dir)
18 # Load framework-specific path mappings used later in the build.
19 include $(LOCAL_PATH)/pathmap.mk
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 # ============================================================
27 # embedded builds use nothing in frameworks/base
28 ifneq ($(ANDROID_BUILD_EMBEDDED),true)
30 # Copy AIDL files to be preprocessed and included in the SDK,
31 # specified relative to the root of the build tree.
32 # ============================================================
36 define stubs-to-aidl-parcelables
37 gen := $(TARGET_OUT_COMMON_INTERMEDIATES)/$1.aidl
38 aidl_parcelables += $$(gen)
39 $$(gen): $(call java-lib-header-files,$1) $(HOST_OUT_EXECUTABLES)/sdkparcelables
40 @echo Extract SDK parcelables: $$@
42 $(HOST_OUT_EXECUTABLES)/sdkparcelables $$< $$@
45 $(foreach stubs,android_stubs_current android_test_stubs_current android_system_stubs_current,\
46 $(eval $(call stubs-to-aidl-parcelables,$(stubs))))
48 gen := $(TARGET_OUT_COMMON_INTERMEDIATES)/framework.aidl
50 $(gen): $(aidl_parcelables)
51 @echo Combining SDK parcelables: $@
53 cat $^ | sort -u > $@.tmp
54 $(call commit-change-for-toc,$@)
57 # ============================================================
59 # TODO: deal with com/google/android/googleapps
60 packages_to_document := \
62 javax/microedition/khronos \
63 org/apache/http/conn \
64 org/apache/http/params \
66 # include definition of libcore_to_document
67 include libcore/Docs.mk
70 ../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 \
75 # Find all files in specific directories (relative to frameworks/base)
76 # to document and check apis
77 files_to_check_apis := \
78 $(call find-other-java-files, \
82 # Find all files in specific packages that were used to compile
83 # framework.jar to document and check apis
84 files_to_check_apis += \
87 $(foreach dir,$(FRAMEWORKS_BASE_JAVA_SRC_DIRS),\
88 $(foreach package,$(packages_to_document),\
89 $(dir)/$(package)/%.java)),\
90 $(SOONG_FRAMEWORK_SRCS)))
92 # Find all generated files that were used to compile framework.jar
93 files_to_check_apis_generated := \
94 $(filter $(OUT_DIR)/%,\
95 $(SOONG_FRAMEWORK_SRCS))
97 # These are relative to frameworks/base
98 # FRAMEWORKS_BASE_SUBDIRS comes from build/core/pathmap.mk
99 files_to_document := \
100 $(files_to_check_apis) \
101 $(call find-other-java-files,\
106 # These are relative to frameworks/base
108 $(FRAMEWORKS_BASE_SUBDIRS) \
111 # Common sources for doc check and api check
112 common_src_files := \
113 $(call find-other-html-files, $(html_dirs)) \
114 $(addprefix ../../, $(libcore_to_document)) \
116 # These are relative to frameworks/base
117 framework_docs_LOCAL_SRC_FILES := \
118 $(files_to_document) \
119 $(common_src_files) \
121 # These are relative to frameworks/base
122 framework_docs_LOCAL_API_CHECK_SRC_FILES := \
123 $(files_to_check_apis) \
124 $(common_src_files) \
126 # This is used by ide.mk as the list of source files that are
128 INTERNAL_SDK_SOURCE_DIRS := $(addprefix $(LOCAL_PATH)/,$(dirs_to_document))
130 framework_docs_LOCAL_DROIDDOC_SOURCE_PATH := \
131 $(FRAMEWORKS_BASE_JAVA_SRC_DIRS)
133 framework_docs_LOCAL_SRCJARS := $(SOONG_FRAMEWORK_SRCJARS)
135 framework_docs_LOCAL_GENERATED_SOURCES := \
136 $(libcore_to_document_generated) \
137 $(files_to_check_apis_generated) \
139 framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES := \
149 # 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.
151 framework_docs_LOCAL_JAVA_LIBRARIES := \
152 $(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES) \
153 $(FRAMEWORKS_SUPPORT_JAVA_LIBRARIES)
155 framework_docs_LOCAL_MODULE_CLASS := JAVA_LIBRARIES
156 framework_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.
160 # Conscrypt (com.android.org.conscrypt) is an implementation detail and should
161 # not be referenced in the documentation.
162 framework_docs_LOCAL_DROIDDOC_OPTIONS := \
164 -knowntags ./frameworks/base/docs/knowntags.txt \
165 -knowntags ./libcore/known_oj_tags.txt \
166 -manifest ./frameworks/base/core/res/AndroidManifest.xml \
167 -hidePackage com.android.internal \
168 -hidePackage com.android.internal.util \
169 -hidePackage com.android.okhttp \
170 -hidePackage com.android.org.conscrypt \
171 -hidePackage com.android.server \
172 -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 \
194 -since $(SRC_API_DIR)/23.txt 23 \
195 -since $(SRC_API_DIR)/24.txt 24 \
196 -since $(SRC_API_DIR)/25.txt 25 \
197 -since $(SRC_API_DIR)/26.txt 26 \
198 -since $(SRC_API_DIR)/27.txt 27 \
199 -since $(SRC_API_DIR)/28.txt 28 \
200 -werror -lerror -hide 111 -hide 113 -hide 125 -hide 126 -hide 127 -hide 128 \
201 -overview $(LOCAL_PATH)/core/java/overview.html \
203 framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR:= \
204 $(call intermediates-dir-for,JAVA_LIBRARIES,framework,,COMMON)
206 framework_docs_LOCAL_ADDITIONAL_JAVA_DIR:= \
207 $(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
209 framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES := \
210 frameworks/base/docs/knowntags.txt \
211 $(libcore_to_document_generated)
213 samples_dir := development/samples/browseable
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.
218 sample_groups := -samplegroup Admin \
219 -samplegroup Background \
220 -samplegroup Connectivity \
221 -samplegroup Content \
224 -samplegroup Notification \
225 -samplegroup RenderScript \
226 -samplegroup Security \
227 -samplegroup Sensors \
228 -samplegroup System \
229 -samplegroup Testing \
232 -samplegroup Wearable
234 ## SDK version identifiers used in the published docs
235 # major[.minor] version for current SDK. (full releases only)
236 framework_docs_SDK_VERSION:=7.0
237 # release version (ie "Release x") (full releases only)
238 framework_docs_SDK_REL_ID:=1
240 framework_docs_LOCAL_DROIDDOC_OPTIONS += \
242 -hdf sdk.codename O \
243 -hdf sdk.preview.version 1 \
244 -hdf sdk.version $(framework_docs_SDK_VERSION) \
245 -hdf sdk.rel.id $(framework_docs_SDK_REL_ID) \
247 -resourcesdir $(LOCAL_PATH)/docs/html/reference/images/ \
248 -resourcesoutdir reference/android/images/
250 # Federate Support Library references against local API file.
251 framework_docs_LOCAL_DROIDDOC_OPTIONS += \
252 -federate SupportLib https://developer.android.com \
253 -federationapi SupportLib prebuilts/sdk/current/support-api.txt
255 # Federate AndroidX references against local API file.
256 framework_docs_LOCAL_DROIDDOC_OPTIONS += \
257 -federate AndroidX https://developer.android.com \
258 -federationapi AndroidX prebuilts/sdk/current/androidx-api.txt
260 framework_metalava_docs_LOCAL_DROIDDOC_OPTIONS := \
261 --manifest ./frameworks/base/core/res/AndroidManifest.xml \
262 --hide-package com.android.okhttp \
263 --hide-package com.android.org.conscrypt --hide-package com.android.server \
264 --hide RequiresPermission \
265 --hide MissingPermission --hide BroadcastBehavior \
266 --hide HiddenSuperclass --hide DeprecationMismatch --hide UnavailableSymbol \
267 --hide SdkConstant --hide HiddenTypeParameter --hide Todo --hide Typo
269 # ==== Public API diff ===========================
270 include $(CLEAR_VARS)
272 LOCAL_SRC_FILES := $(framework_docs_LOCAL_API_CHECK_SRC_FILES)
273 LOCAL_GENERATED_SOURCES := $(framework_docs_LOCAL_GENERATED_SOURCES)
274 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
275 LOCAL_JAVA_LIBRARIES := $(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
276 LOCAL_MODULE_CLASS := $(framework_docs_LOCAL_MODULE_CLASS)
277 LOCAL_ADDITIONAL_JAVA_DIR := $(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
278 LOCAL_ADDITIONAL_DEPENDENCIES := \
279 $(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES) \
280 $(INTERNAL_PLATFORM_API_FILE)
282 LOCAL_MODULE := offline-sdk-referenceonly
284 last_released_sdk_version := $(lastword $(call numerically_sort, \
285 $(filter-out current, \
286 $(patsubst $(SRC_API_DIR)/%.txt,%, $(wildcard $(SRC_API_DIR)/*.txt)) \
290 LOCAL_APIDIFF_OLDAPI := $(LOCAL_PATH)/../../$(SRC_API_DIR)/$(last_released_sdk_version)
291 LOCAL_APIDIFF_NEWAPI := $(LOCAL_PATH)/../../$(basename $(INTERNAL_PLATFORM_API_FILE))
293 include $(BUILD_APIDIFF)
295 # Hack to get diffs included in docs output
296 out_zip := $(OUT_DOCS)/$(LOCAL_MODULE)-docs.zip
297 $(out_zip): $(full_target)
299 # ==== System API diff ===========================
300 include $(CLEAR_VARS)
302 LOCAL_SRC_FILES := $(framework_docs_LOCAL_API_CHECK_SRC_FILES)
303 LOCAL_GENERATED_SOURCES := $(framework_docs_LOCAL_GENERATED_SOURCES)
304 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
305 LOCAL_JAVA_LIBRARIES := $(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
306 LOCAL_MODULE_CLASS := $(framework_docs_LOCAL_MODULE_CLASS)
307 LOCAL_ADDITIONAL_JAVA_DIR := $(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
308 LOCAL_ADDITIONAL_DEPENDENCIES := \
309 $(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES) \
310 $(INTERNAL_PLATFORM_SYSTEM_API_FILE)
312 LOCAL_MODULE := offline-system-sdk-referenceonly
314 last_released_sdk_version := $(lastword $(call numerically_sort, \
315 $(filter-out current, \
316 $(patsubst $(SRC_SYSTEM_API_DIR)/%.txt,%, $(wildcard $(SRC_SYSTEM_API_DIR)/*.txt)) \
320 LOCAL_APIDIFF_OLDAPI := $(LOCAL_PATH)/../../$(SRC_SYSTEM_API_DIR)/$(last_released_sdk_version)
321 LOCAL_APIDIFF_NEWAPI := $(LOCAL_PATH)/../../$(basename $(INTERNAL_PLATFORM_SYSTEM_API_FILE))
323 include $(BUILD_APIDIFF)
325 # Hack to get diffs included in docs output
326 out_zip := $(OUT_DOCS)/$(LOCAL_MODULE)-docs.zip
327 $(out_zip): $(full_target)
329 # ==== the api stubs and current.xml ===========================
330 include $(CLEAR_VARS)
332 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
333 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
334 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
335 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
336 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
337 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
338 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
339 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
340 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
342 LOCAL_MODULE := api-stubs
344 LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/android_stubs_current_intermediates/src
346 LOCAL_DROIDDOC_OPTIONS:=\
347 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
349 -api $(INTERNAL_PLATFORM_API_FILE) \
350 -removedApi $(INTERNAL_PLATFORM_REMOVED_API_FILE) \
353 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
355 LOCAL_UNINSTALLABLE_MODULE := true
357 include $(BUILD_DROIDDOC)
359 $(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_API_FILE) \
360 $(INTERNAL_PLATFORM_REMOVED_API_FILE)
361 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_API_FILE))
363 # ==== the metalava api stubs and current.xml ===========================
364 include $(CLEAR_VARS)
366 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
367 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
368 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
369 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
370 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
371 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
372 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
373 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
375 LOCAL_MODULE := metalava-api-stubs
376 LOCAL_DROIDDOC_USE_METALAVA := true
377 LOCAL_DROIDDOC_METALAVA_PREVIOUS_API := prebuilts/sdk/api/27.txt
378 LOCAL_DROIDDOC_METALAVA_ANNOTATIONS_ENABLED := true
379 LOCAL_DROIDDOC_METALAVA_MERGE_ANNOTATIONS_DIR := tools/metalava/manual
381 LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/metalava_android_stubs_current_intermediates/src
383 INTERNAL_PLATFORM_METALAVA_PUBLIC_API_FILE := $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/metalava_public_api.txt
384 INTERNAL_PLATFORM_METALAVA_PUBLIC_REMOVED_API_FILE := $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/metalava_removed.txt
386 LOCAL_DROIDDOC_OPTIONS:=\
387 $(framework_metalava_docs_LOCAL_DROIDDOC_OPTIONS) \
388 --api $(INTERNAL_PLATFORM_METALAVA_PUBLIC_API_FILE) \
389 --removed-api $(INTERNAL_PLATFORM_METALAVA_PUBLIC_REMOVED_API_FILE) \
392 LOCAL_UNINSTALLABLE_MODULE := true
394 include $(BUILD_DROIDDOC)
396 $(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_METALAVA_PUBLIC_API_FILE) \
397 $(INTERNAL_PLATFORM_METALAVA_PUBLIC_REMOVED_API_FILE)
398 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_METALAVA_PUBLIC_API_FILE))
400 # ==== the system api stubs ===================================
401 include $(CLEAR_VARS)
403 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
404 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
405 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
406 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
407 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
408 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
409 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
410 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
411 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
413 LOCAL_MODULE := system-api-stubs
415 LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/android_system_stubs_current_intermediates/src
417 LOCAL_DROIDDOC_OPTIONS:=\
418 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
420 -showAnnotation android.annotation.SystemApi \
421 -api $(INTERNAL_PLATFORM_SYSTEM_API_FILE) \
422 -removedApi $(INTERNAL_PLATFORM_SYSTEM_REMOVED_API_FILE) \
423 -exactApi $(INTERNAL_PLATFORM_SYSTEM_EXACT_API_FILE) \
426 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
428 LOCAL_UNINSTALLABLE_MODULE := true
430 include $(BUILD_DROIDDOC)
432 $(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_SYSTEM_API_FILE) \
433 $(INTERNAL_PLATFORM_SYSTEM_REMOVED_API_FILE) \
434 $(INTERNAL_PLATFORM_SYSTEM_EXACT_API_FILE)
435 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_SYSTEM_API_FILE))
437 # ==== the metalava system api stubs ===================================
438 include $(CLEAR_VARS)
440 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
441 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
442 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
443 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
444 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
445 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
446 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
447 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
449 LOCAL_MODULE := metalava-system-api-stubs
450 LOCAL_DROIDDOC_USE_METALAVA := true
451 LOCAL_DROIDDOC_METALAVA_PREVIOUS_API := prebuilts/sdk/api/27.txt
452 LOCAL_DROIDDOC_METALAVA_ANNOTATIONS_ENABLED := true
453 LOCAL_DROIDDOC_METALAVA_MERGE_ANNOTATIONS_DIR := tools/metalava/manual
455 LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/metalava_android_system_stubs_current_intermediates/src
457 INTERNAL_PLATFORM_METALAVA_SYSTEM_API_FILE := $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/metalava-system-api.txt
458 INTERNAL_PLATFORM_METALAVA_SYSTEM_REMOVED_API_FILE := $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/metalava-system-removed.txt
460 LOCAL_DROIDDOC_OPTIONS:=\
461 $(framework_metalava_docs_LOCAL_DROIDDOC_OPTIONS) \
462 --show-annotation android.annotation.SystemApi \
463 --api $(INTERNAL_PLATFORM_METALAVA_SYSTEM_API_FILE) \
464 --removed-api $(INTERNAL_PLATFORM_METALAVA_SYSTEM_REMOVED_API_FILE) \
467 LOCAL_UNINSTALLABLE_MODULE := true
469 include $(BUILD_DROIDDOC)
471 $(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_METALAVA_SYSTEM_API_FILE) \
472 $(INTERNAL_PLATFORM_METALAVA_SYSTEM_REMOVED_API_FILE) \
473 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_METALAVA_SYSTEM_API_FILE))
475 # ==== the test api stubs ===================================
476 include $(CLEAR_VARS)
478 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
479 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
480 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
481 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
482 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
483 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
484 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
485 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
486 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
488 LOCAL_MODULE := test-api-stubs
490 LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/android_test_stubs_current_intermediates/src
492 LOCAL_DROIDDOC_OPTIONS:=\
493 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
495 -stubs $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/android_test_stubs_current_intermediates/src \
496 -showAnnotation android.annotation.TestApi \
497 -api $(INTERNAL_PLATFORM_TEST_API_FILE) \
498 -removedApi $(INTERNAL_PLATFORM_TEST_REMOVED_API_FILE) \
499 -exactApi $(INTERNAL_PLATFORM_TEST_EXACT_API_FILE) \
502 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
504 LOCAL_UNINSTALLABLE_MODULE := true
506 include $(BUILD_DROIDDOC)
508 $(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_TEST_API_FILE) \
509 $(INTERNAL_PLATFORM_TEST_REMOVED_API_FILE) \
510 $(INTERNAL_PLATFORM_TEST_EXACT_API_FILE)
511 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_TEST_API_FILE))
513 # ==== the metalava test api stubs ===================================
514 include $(CLEAR_VARS)
516 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
517 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
518 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
519 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
520 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
521 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
522 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
523 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
525 LOCAL_MODULE := metalava-test-api-stubs
526 LOCAL_DROIDDOC_USE_METALAVA := true
527 LOCAL_DROIDDOC_METALAVA_PREVIOUS_API := prebuilts/sdk/api/27.txt
528 LOCAL_DROIDDOC_METALAVA_ANNOTATIONS_ENABLED := true
529 LOCAL_DROIDDOC_METALAVA_MERGE_ANNOTATIONS_DIR := tools/metalava/manual
531 LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/metalava_android_test_stubs_current_intermediates/src
533 INTERNAL_PLATFORM_METALAVA_TEST_API_FILE := $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/metalava-test-api.txt
534 INTERNAL_PLATFORM_METALAVA_TEST_REMOVED_API_FILE := $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/metalava-test-removed.txt
536 LOCAL_DROIDDOC_OPTIONS:=\
537 $(framework_metalava_docs_LOCAL_DROIDDOC_OPTIONS) \
538 --show-annotation android.annotation.TestApi \
539 --api $(INTERNAL_PLATFORM_METALAVA_TEST_API_FILE) \
540 --removed-api $(INTERNAL_PLATFORM_METALAVA_TEST_REMOVED_API_FILE) \
543 LOCAL_UNINSTALLABLE_MODULE := true
545 include $(BUILD_DROIDDOC)
547 $(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_METALAVA_TEST_API_FILE) \
548 $(INTERNAL_PLATFORM_METALAVA_TEST_REMOVED_API_FILE) \
549 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_METALAVA_TEST_API_FILE))
551 # ==== the complete hidden api list ===================================
552 include $(CLEAR_VARS)
554 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
555 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
556 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
557 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
558 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
559 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
560 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
561 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
562 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
564 LOCAL_MODULE := hidden-api-list
566 LOCAL_DROIDDOC_OPTIONS:=\
567 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
570 -showAnnotation android.annotation.SystemApi \
571 -showAnnotation android.annotation.TestApi \
572 -dexApi $(INTERNAL_PLATFORM_DEX_API_FILE) \
573 -privateDexApi $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE) \
574 -removedDexApi $(INTERNAL_PLATFORM_REMOVED_DEX_API_FILE) \
577 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
579 LOCAL_UNINSTALLABLE_MODULE := true
581 include $(BUILD_DROIDDOC)
583 $(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_DEX_API_FILE) \
584 $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE) \
585 $(INTERNAL_PLATFORM_REMOVED_DEX_API_FILE)
587 # ==== check javadoc comments but don't generate docs ========
588 include $(CLEAR_VARS)
590 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
591 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
592 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
593 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
594 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
595 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
596 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
597 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
598 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
600 LOCAL_MODULE := doc-comment-check
602 LOCAL_DROIDDOC_OPTIONS:=\
603 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
607 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
609 LOCAL_UNINSTALLABLE_MODULE := true
611 include $(BUILD_DROIDDOC)
613 # Run this for checkbuild
614 checkbuild: doc-comment-check-docs
615 # Check comment when you are updating the API
616 update-api: doc-comment-check-docs
618 # ==== static html in the sdk ==================================
619 include $(CLEAR_VARS)
621 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
622 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
623 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
624 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
625 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
626 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
627 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
628 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
629 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
631 LOCAL_MODULE := offline-sdk
633 LOCAL_DROIDDOC_OPTIONS:=\
634 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
636 -title "Android SDK" \
637 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-proofread.txt \
638 -sdkvalues $(OUT_DOCS) \
639 -hdf android.whichdoc offline
641 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
643 include $(BUILD_DROIDDOC)
645 static_doc_index_redirect := $(out_dir)/index.html
646 $(static_doc_index_redirect): \
647 $(LOCAL_PATH)/docs/docs-preview-index.html | $(ACP)
648 $(hide) mkdir -p $(dir $@)
651 $(full_target): $(static_doc_index_redirect)
653 # ==== Metalava static html in the sdk ==================================
654 include $(CLEAR_VARS)
656 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
657 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
658 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
659 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
660 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
661 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
662 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
663 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
664 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
666 LOCAL_MODULE := metalava-offline-sdk
667 LOCAL_DROIDDOC_USE_METALAVA := true
669 # TODO(nanzhang): Remove -hide, and -since flags for this module.
670 LOCAL_DROIDDOC_OPTIONS:=\
671 $(framework_metalava_docs_LOCAL_DROIDDOC_OPTIONS) \
672 --generate-api-levels $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/api-versions.xml \
673 --apply-api-levels $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/api-versions.xml \
674 --android-jar-pattern prebuilts/tools/common/api-versions/android-%/android.jar \
675 --android-jar-pattern prebuilts/sdk/%/android.jar \
676 --current-version $(PLATFORM_SDK_VERSION) \
677 --current-codename $(PLATFORM_VERSION_CODENAME) \
678 --generate-documentation \
679 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
681 -title "Android SDK" \
682 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-proofread.txt \
683 -sdkvalues $(OUT_DOCS) \
684 -hdf android.whichdoc offline
686 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
688 include $(BUILD_DROIDDOC)
690 # ==== Public API static reference docs ==================================
691 include $(CLEAR_VARS)
693 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
694 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
695 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
696 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
697 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
698 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
699 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
700 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
701 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
703 LOCAL_MODULE := offline-sdk-referenceonly
705 LOCAL_DROIDDOC_OPTIONS:=\
706 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
708 -title "Android SDK" \
709 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-proofread.txt \
710 -sdkvalues $(OUT_DOCS) \
711 -hdf android.whichdoc offline \
714 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
716 include $(BUILD_DROIDDOC)
718 static_doc_index_redirect := $(out_dir)/index.html
719 $(static_doc_index_redirect): $(LOCAL_PATH)/docs/docs-documentation-redirect.html
720 $(copy-file-to-target)
722 static_doc_properties := $(out_dir)/source.properties
723 $(static_doc_properties): \
724 $(LOCAL_PATH)/docs/source.properties | $(ACP)
725 $(hide) mkdir -p $(dir $@)
728 $(full_target): $(static_doc_index_redirect)
729 $(full_target): $(static_doc_properties)
732 # ==== System API static reference docs ==================================
733 include $(CLEAR_VARS)
735 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
736 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
737 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
738 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
739 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
740 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
741 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
742 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
743 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
745 LOCAL_MODULE := offline-system-sdk-referenceonly
747 LOCAL_DROIDDOC_OPTIONS:=\
748 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
749 -hide 101 -hide 104 -hide 108 \
750 -showAnnotation android.annotation.SystemApi \
752 -title "Android System SDK" \
753 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-proofread.txt \
754 -sdkvalues $(OUT_DOCS) \
755 -hdf android.whichdoc offline \
758 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
760 include $(BUILD_DROIDDOC)
762 static_doc_index_redirect := $(out_dir)/index.html
763 $(static_doc_index_redirect): $(LOCAL_PATH)/docs/docs-documentation-redirect.html
764 $(copy-file-to-target)
766 static_doc_properties := $(out_dir)/source.properties
767 $(static_doc_properties): \
768 $(LOCAL_PATH)/docs/source.properties | $(ACP)
769 $(hide) mkdir -p $(dir $@)
772 $(full_target): $(static_doc_index_redirect)
773 $(full_target): $(static_doc_properties)
774 $(full_target): $(framework_built)
777 # ==== docs for the web (on the androiddevdocs app engine server) =======================
778 include $(CLEAR_VARS)
780 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
781 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
782 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
783 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
784 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
785 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
786 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
787 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
788 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
789 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
790 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
792 LOCAL_MODULE := online-sdk
794 LOCAL_DROIDDOC_OPTIONS:= \
795 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
797 -hdf android.whichdoc online \
799 -hdf android.hasSamples true \
800 -samplesdir $(samples_dir)
802 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
804 include $(BUILD_DROIDDOC)
806 # ==== Metalava docs for the web (on the androiddevdocs app engine server) =======================
807 include $(CLEAR_VARS)
809 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
810 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
811 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
812 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
813 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
814 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
815 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
816 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
817 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
818 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
819 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
821 LOCAL_MODULE := metalava-online-sdk
822 LOCAL_DROIDDOC_USE_METALAVA := true
824 LOCAL_DROIDDOC_OPTIONS:= \
825 $(framework_metalava_docs_LOCAL_DROIDDOC_OPTIONS) \
826 --generate-api-levels $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/api-versions.xml \
827 --apply-api-levels $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/api-versions.xml \
828 --android-jar-pattern prebuilts/tools/common/api-versions/android-%/android.jar \
829 --android-jar-pattern prebuilts/sdk/%/android.jar \
830 --current-version $(PLATFORM_SDK_VERSION) \
831 --current-codename $(PLATFORM_VERSION_CODENAME) \
832 --generate-documentation \
833 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
835 -hdf android.whichdoc online \
837 -hdf android.hasSamples true \
838 -samplesdir $(samples_dir)
840 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
842 include $(BUILD_DROIDDOC)
844 # ==== docs for the web (on the androiddevdocs app engine server) =======================
845 include $(CLEAR_VARS)
847 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
848 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
849 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
850 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
851 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
852 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
853 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
854 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
855 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
856 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
857 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
859 LOCAL_MODULE := online-system-api-sdk
861 LOCAL_DROIDDOC_OPTIONS:= \
862 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
864 -showAnnotation android.annotation.SystemApi \
865 -title "Android SDK - Including system APIs." \
870 -hdf android.whichdoc online \
872 -hdf android.hasSamples true \
873 -samplesdir $(samples_dir)
875 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
877 LOCAL_UNINSTALLABLE_MODULE := true
879 include $(BUILD_DROIDDOC)
881 # ==== docs for the web (on the devsite app engine server) =======================
882 include $(CLEAR_VARS)
883 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
884 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
885 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
886 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
887 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
888 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
889 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
890 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
891 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
892 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
893 # specify a second html input dir and an output path relative to OUT_DIR)
894 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
898 LOCAL_DROIDDOC_OPTIONS:= \
899 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
901 -hdf android.whichdoc online \
905 -hdf android.hasSamples true \
906 -samplesdir $(samples_dir)
908 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
910 include $(BUILD_DROIDDOC)
912 # ==== docs for the web (on the devsite app engine server) =======================
913 include $(CLEAR_VARS)
914 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
915 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
916 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
917 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
918 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
919 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
920 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
921 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
922 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
923 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
924 # specify a second html input dir and an output path relative to OUT_DIR)
925 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
927 LOCAL_MODULE := ds-static
929 LOCAL_DROIDDOC_OPTIONS:= \
930 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
931 -hdf android.whichdoc online \
937 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
939 include $(BUILD_DROIDDOC)
941 # ==== generates full navtree for resolving @links in ds postprocessing ====
942 include $(CLEAR_VARS)
944 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
945 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
946 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
947 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
948 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
949 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
950 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
951 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
952 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
954 LOCAL_MODULE := ds-ref-navtree
956 LOCAL_DROIDDOC_OPTIONS:= \
957 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
958 -hdf android.whichdoc online \
963 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
965 include $(BUILD_DROIDDOC)
967 # ==== site updates for docs (on the androiddevdocs app engine server) =======================
968 include $(CLEAR_VARS)
970 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
971 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
972 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
973 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
974 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
975 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
976 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
977 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
978 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
979 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
980 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
982 LOCAL_MODULE := online-sdk-dev
984 LOCAL_DROIDDOC_OPTIONS:= \
985 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
987 -hdf android.whichdoc online \
989 -hdf android.hasSamples true \
990 -samplesdir $(samples_dir)
992 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
994 include $(BUILD_DROIDDOC)
996 # ==== docs that have all of the stuff that's @hidden =======================
997 include $(CLEAR_VARS)
999 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
1000 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
1001 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
1002 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
1003 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
1004 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
1005 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
1006 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
1007 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
1009 LOCAL_MODULE := hidden
1010 LOCAL_DROIDDOC_OPTIONS:=\
1011 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
1013 -title "Android SDK - Including hidden APIs."
1016 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
1018 include $(BUILD_DROIDDOC)
1020 # ==== java proto host library ==============================
1021 include $(CLEAR_VARS)
1022 LOCAL_MODULE := platformprotos
1023 LOCAL_PROTOC_OPTIMIZE_TYPE := full
1024 LOCAL_PROTOC_FLAGS := \
1025 -Iexternal/protobuf/src
1026 LOCAL_SOURCE_FILES_ALL_GENERATED := true
1027 LOCAL_SRC_FILES := \
1028 cmds/am/proto/instrumentation_data.proto \
1029 cmds/statsd/src/perfetto/perfetto_config.proto \
1030 $(call all-proto-files-under, core/proto) \
1031 $(call all-proto-files-under, libs/incident/proto) \
1032 $(call all-proto-files-under, cmds/statsd/src)
1034 LOCAL_ERROR_PRONE_FLAGS := -Xep:MissingOverride:OFF
1035 include $(BUILD_HOST_JAVA_LIBRARY)
1037 # ==== java proto device library (for test only) ==============================
1038 include $(CLEAR_VARS)
1039 LOCAL_MODULE := platformprotosnano
1040 LOCAL_MODULE_TAGS := tests
1041 LOCAL_PROTOC_OPTIMIZE_TYPE := nano
1042 LOCAL_PROTOC_FLAGS := \
1043 -Iexternal/protobuf/src
1044 LOCAL_PROTO_JAVA_OUTPUT_PARAMS := \
1045 store_unknown_fields = true
1046 LOCAL_SDK_VERSION := current
1047 LOCAL_SRC_FILES := \
1048 $(call all-proto-files-under, core/proto) \
1049 $(call all-proto-files-under, libs/incident/proto/android/os)
1050 include $(BUILD_STATIC_JAVA_LIBRARY)
1053 # ==== java proto device library (for test only) ==============================
1054 include $(CLEAR_VARS)
1055 LOCAL_MODULE := platformprotoslite
1056 LOCAL_MODULE_TAGS := tests
1057 LOCAL_PROTOC_OPTIMIZE_TYPE := lite
1058 LOCAL_PROTOC_FLAGS := \
1059 -Iexternal/protobuf/src
1060 LOCAL_SRC_FILES := \
1061 $(call all-proto-files-under, core/proto) \
1062 $(call all-proto-files-under, libs/incident/proto/android/os)
1063 # Protos have lots of MissingOverride and similar.
1064 LOCAL_ERROR_PRONE_FLAGS := -XepDisableAllChecks
1065 include $(BUILD_STATIC_JAVA_LIBRARY)
1067 # ==== hiddenapi lists =======================================
1068 include $(CLEAR_VARS)
1070 # File names of final API lists
1071 LOCAL_LIGHT_GREYLIST := $(INTERNAL_PLATFORM_HIDDENAPI_LIGHT_GREYLIST)
1072 LOCAL_DARK_GREYLIST := $(INTERNAL_PLATFORM_HIDDENAPI_DARK_GREYLIST)
1073 LOCAL_BLACKLIST := $(INTERNAL_PLATFORM_HIDDENAPI_BLACKLIST)
1075 # File names of source files we will use to generate the final API lists.
1076 LOCAL_SRC_GREYLIST := frameworks/base/config/hiddenapi-light-greylist.txt
1077 LOCAL_SRC_VENDOR_LIST := frameworks/base/config/hiddenapi-vendor-list.txt
1078 LOCAL_SRC_FORCE_BLACKLIST := frameworks/base/config/hiddenapi-force-blacklist.txt
1079 LOCAL_SRC_PUBLIC_API := $(INTERNAL_PLATFORM_DEX_API_FILE)
1080 LOCAL_SRC_PRIVATE_API := $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE)
1081 LOCAL_SRC_REMOVED_API := $(INTERNAL_PLATFORM_REMOVED_DEX_API_FILE)
1084 $(LOCAL_SRC_GREYLIST) \
1085 $(LOCAL_SRC_VENDOR_LIST) \
1086 $(LOCAL_SRC_FORCE_BLACKLIST) \
1087 $(LOCAL_SRC_PUBLIC_API) \
1088 $(LOCAL_SRC_PRIVATE_API) \
1089 $(LOCAL_SRC_REMOVED_API)
1091 define assert-has-no-overlap
1092 if [ ! -z "`comm -12 <(sort $(1)) <(sort $(2))`" ]; then \
1093 echo "$(1) and $(2) should not overlap" 1>&2; \
1094 comm -12 <(sort $(1)) <(sort $(2)) 1>&2; \
1099 define assert-is-subset
1100 if [ ! -z "`comm -23 <(sort $(1)) <(sort $(2))`" ]; then \
1101 echo "$(1) must be a subset of $(2)" 1>&2; \
1102 comm -23 <(sort $(1)) <(sort $(2)) 1>&2; \
1107 define assert-has-no-duplicates
1108 if [ ! -z "`sort $(1) | uniq -D`" ]; then \
1109 echo "$(1) has duplicate entries" 1>&2; \
1110 sort $(1) | uniq -D 1>&2; \
1115 # The following rules build API lists in the build folder.
1116 # By not using files from the source tree, ART buildbots can mock these lists
1117 # or have alternative rules for building them. Other rules in the build system
1118 # should depend on the files in the build folder.
1120 # Merge light greylist from multiple files:
1121 # (1) manual greylist LOCAL_SRC_GREYLIST
1122 # (2) list of usages from vendor apps LOCAL_SRC_VENDOR_LIST
1123 # (3) list of removed APIs in LOCAL_SRC_REMOVED_API
1124 # @removed does not imply private in Doclava. We must take the subset also
1125 # in LOCAL_SRC_PRIVATE_API.
1126 # (4) list of serialization APIs
1127 # Automatically adds all methods which match the signatures in
1128 # REGEX_SERIALIZATION. These are greylisted in order to allow applications
1129 # to write their own serializers.
1130 $(LOCAL_LIGHT_GREYLIST): REGEX_SERIALIZATION := \
1131 "readObject\(Ljava/io/ObjectInputStream;\)V" \
1132 "readObjectNoData\(\)V" \
1133 "readResolve\(\)Ljava/lang/Object;" \
1134 "serialVersionUID:J" \
1135 "serialPersistentFields:\[Ljava/io/ObjectStreamField;" \
1136 "writeObject\(Ljava/io/ObjectOutputStream;\)V" \
1137 "writeReplace\(\)Ljava/lang/Object;"
1138 $(LOCAL_LIGHT_GREYLIST): $(LOCAL_SRC_ALL)
1139 sort $(LOCAL_SRC_GREYLIST) $(LOCAL_SRC_VENDOR_LIST) \
1140 <(grep -E "\->("$(subst $(space),"|",$(REGEX_SERIALIZATION))")$$" \
1141 $(LOCAL_SRC_PRIVATE_API)) \
1142 <(comm -12 <(sort $(LOCAL_SRC_REMOVED_API)) <(sort $(LOCAL_SRC_PRIVATE_API))) \
1144 $(call assert-has-no-duplicates,$@)
1145 $(call assert-is-subset,$@,$(LOCAL_SRC_PRIVATE_API))
1146 $(call assert-has-no-overlap,$@,$(LOCAL_SRC_FORCE_BLACKLIST))
1148 # Generate dark greylist as remaining classes and class members in the same
1149 # package as classes listed in the light greylist.
1150 # The algorithm is as follows:
1151 # (1) extract the class descriptor from each entry in LOCAL_LIGHT_GREYLIST
1152 # (2) strip everything after the last forward-slash,
1153 # e.g. 'Lpackage/subpackage/class$inner;' turns into 'Lpackage/subpackage/'
1154 # (3) insert all entries from LOCAL_SRC_PRIVATE_API which begin with the package
1155 # name but do not contain another forward-slash in the class name, e.g.
1156 # matching '^Lpackage/subpackage/[^/;]*;'
1157 # (4) subtract entries shared with LOCAL_LIGHT_GREYLIST
1158 $(LOCAL_DARK_GREYLIST): $(LOCAL_SRC_ALL) $(LOCAL_LIGHT_GREYLIST)
1159 comm -13 <(sort $(LOCAL_LIGHT_GREYLIST) $(LOCAL_SRC_FORCE_BLACKLIST)) \
1160 <(cat $(LOCAL_SRC_PUBLIC_API) $(LOCAL_LIGHT_GREYLIST) | \
1161 sed 's/\->.*//' | sed 's/\(.*\/\).*/\1/' | sort | uniq | \
1162 while read PKG_NAME; do \
1163 grep -E "^$${PKG_NAME}[^/;]*;" $(LOCAL_SRC_PRIVATE_API); \
1164 done | sort | uniq) \
1166 $(call assert-is-subset,$@,$(LOCAL_SRC_PRIVATE_API))
1167 $(call assert-has-no-duplicates,$@)
1168 $(call assert-has-no-overlap,$@,$(LOCAL_LIGHT_GREYLIST))
1169 $(call assert-has-no-overlap,$@,$(LOCAL_SRC_FORCE_BLACKLIST))
1171 # Generate blacklist as private API minus (light greylist plus dark greylist).
1172 $(LOCAL_BLACKLIST): $(LOCAL_SRC_ALL) $(LOCAL_LIGHT_GREYLIST) $(LOCAL_DARK_GREYLIST)
1173 comm -13 <(sort $(LOCAL_LIGHT_GREYLIST) $(LOCAL_DARK_GREYLIST)) \
1174 <(sort $(LOCAL_SRC_PRIVATE_API)) \
1176 $(call assert-is-subset,$@,$(LOCAL_SRC_PRIVATE_API))
1177 $(call assert-has-no-duplicates,$@)
1178 $(call assert-has-no-overlap,$@,$(LOCAL_LIGHT_GREYLIST))
1179 $(call assert-has-no-overlap,$@,$(LOCAL_DARK_GREYLIST))
1180 $(call assert-is-subset,$(LOCAL_SRC_FORCE_BLACKLIST),$@)
1182 # Include subdirectory makefiles
1183 # ============================================================
1185 # If we're building with ONE_SHOT_MAKEFILE (mm, mmm), then what the framework
1186 # team really wants is to build the stuff defined by this makefile.
1187 ifeq (,$(ONE_SHOT_MAKEFILE))
1188 include $(call first-makefiles-under,$(LOCAL_PATH))
1191 endif # ANDROID_BUILD_EMBEDDED