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
378 LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/metalava_android_stubs_current_intermediates/src
380 INTERNAL_PLATFORM_METALAVA_PUBLIC_API_FILE := $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/metalava_public_api.txt
381 INTERNAL_PLATFORM_METALAVA_PUBLIC_REMOVED_API_FILE := $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/metalava_removed.txt
383 LOCAL_DROIDDOC_OPTIONS:=\
384 $(framework_metalava_docs_LOCAL_DROIDDOC_OPTIONS) \
385 --api $(INTERNAL_PLATFORM_METALAVA_PUBLIC_API_FILE) \
386 --removed-api $(INTERNAL_PLATFORM_METALAVA_PUBLIC_REMOVED_API_FILE) \
389 LOCAL_UNINSTALLABLE_MODULE := true
391 include $(BUILD_DROIDDOC)
393 $(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_METALAVA_PUBLIC_API_FILE) \
394 $(INTERNAL_PLATFORM_METALAVA_PUBLIC_REMOVED_API_FILE)
395 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_METALAVA_PUBLIC_API_FILE))
397 # ==== the system api stubs ===================================
398 include $(CLEAR_VARS)
400 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
401 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
402 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
403 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
404 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
405 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
406 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
407 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
408 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
410 LOCAL_MODULE := system-api-stubs
412 LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/android_system_stubs_current_intermediates/src
414 LOCAL_DROIDDOC_OPTIONS:=\
415 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
417 -showAnnotation android.annotation.SystemApi \
418 -api $(INTERNAL_PLATFORM_SYSTEM_API_FILE) \
419 -removedApi $(INTERNAL_PLATFORM_SYSTEM_REMOVED_API_FILE) \
420 -exactApi $(INTERNAL_PLATFORM_SYSTEM_EXACT_API_FILE) \
423 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
425 LOCAL_UNINSTALLABLE_MODULE := true
427 include $(BUILD_DROIDDOC)
429 $(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_SYSTEM_API_FILE) \
430 $(INTERNAL_PLATFORM_SYSTEM_REMOVED_API_FILE) \
431 $(INTERNAL_PLATFORM_SYSTEM_EXACT_API_FILE)
432 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_SYSTEM_API_FILE))
434 # ==== the metalava system api stubs ===================================
435 include $(CLEAR_VARS)
437 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
438 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
439 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
440 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
441 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
442 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
443 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
444 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
446 LOCAL_MODULE := metalava-system-api-stubs
447 LOCAL_DROIDDOC_USE_METALAVA := true
449 LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/metalava_android_system_stubs_current_intermediates/src
451 INTERNAL_PLATFORM_METALAVA_SYSTEM_API_FILE := $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/metalava-system-api.txt
452 INTERNAL_PLATFORM_METALAVA_SYSTEM_REMOVED_API_FILE := $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/metalava-system-removed.txt
454 LOCAL_DROIDDOC_OPTIONS:=\
455 $(framework_metalava_docs_LOCAL_DROIDDOC_OPTIONS) \
456 --show-annotation android.annotation.SystemApi \
457 --api $(INTERNAL_PLATFORM_METALAVA_SYSTEM_API_FILE) \
458 --removed-api $(INTERNAL_PLATFORM_METALAVA_SYSTEM_REMOVED_API_FILE) \
461 LOCAL_UNINSTALLABLE_MODULE := true
463 include $(BUILD_DROIDDOC)
465 $(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_METALAVA_SYSTEM_API_FILE) \
466 $(INTERNAL_PLATFORM_METALAVA_SYSTEM_REMOVED_API_FILE) \
467 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_METALAVA_SYSTEM_API_FILE))
469 # ==== the test api stubs ===================================
470 include $(CLEAR_VARS)
472 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
473 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
474 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
475 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
476 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
477 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
478 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
479 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
480 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
482 LOCAL_MODULE := test-api-stubs
484 LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/android_test_stubs_current_intermediates/src
486 LOCAL_DROIDDOC_OPTIONS:=\
487 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
489 -stubs $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/android_test_stubs_current_intermediates/src \
490 -showAnnotation android.annotation.TestApi \
491 -api $(INTERNAL_PLATFORM_TEST_API_FILE) \
492 -removedApi $(INTERNAL_PLATFORM_TEST_REMOVED_API_FILE) \
493 -exactApi $(INTERNAL_PLATFORM_TEST_EXACT_API_FILE) \
496 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
498 LOCAL_UNINSTALLABLE_MODULE := true
500 include $(BUILD_DROIDDOC)
502 $(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_TEST_API_FILE) \
503 $(INTERNAL_PLATFORM_TEST_REMOVED_API_FILE) \
504 $(INTERNAL_PLATFORM_TEST_EXACT_API_FILE)
505 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_TEST_API_FILE))
507 # ==== the metalava test api stubs ===================================
508 include $(CLEAR_VARS)
510 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
511 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
512 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
513 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
514 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
515 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
516 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
517 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
519 LOCAL_MODULE := metalava-test-api-stubs
520 LOCAL_DROIDDOC_USE_METALAVA := true
522 LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/metalava_android_test_stubs_current_intermediates/src
524 INTERNAL_PLATFORM_METALAVA_TEST_API_FILE := $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/metalava-test-api.txt
525 INTERNAL_PLATFORM_METALAVA_TEST_REMOVED_API_FILE := $(TARGET_OUT_COMMON_INTERMEDIATES)/PACKAGING/metalava-test-removed.txt
527 LOCAL_DROIDDOC_OPTIONS:=\
528 $(framework_metalava_docs_LOCAL_DROIDDOC_OPTIONS) \
529 --show-annotation android.annotation.TestApi \
530 --api $(INTERNAL_PLATFORM_METALAVA_TEST_API_FILE) \
531 --removed-api $(INTERNAL_PLATFORM_METALAVA_TEST_REMOVED_API_FILE) \
534 LOCAL_UNINSTALLABLE_MODULE := true
536 include $(BUILD_DROIDDOC)
538 $(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_METALAVA_TEST_API_FILE) \
539 $(INTERNAL_PLATFORM_METALAVA_TEST_REMOVED_API_FILE) \
540 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_METALAVA_TEST_API_FILE))
542 # ==== the complete hidden api list ===================================
543 include $(CLEAR_VARS)
545 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
546 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
547 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
548 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
549 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
550 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
551 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
552 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
553 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
555 LOCAL_MODULE := hidden-api-list
557 LOCAL_DROIDDOC_OPTIONS:=\
558 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
561 -showAnnotation android.annotation.SystemApi \
562 -showAnnotation android.annotation.TestApi \
563 -dexApi $(INTERNAL_PLATFORM_DEX_API_FILE) \
564 -privateDexApi $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE) \
565 -removedDexApi $(INTERNAL_PLATFORM_REMOVED_DEX_API_FILE) \
568 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
570 LOCAL_UNINSTALLABLE_MODULE := true
572 include $(BUILD_DROIDDOC)
574 $(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_DEX_API_FILE) \
575 $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE) \
576 $(INTERNAL_PLATFORM_REMOVED_DEX_API_FILE)
578 # ==== check javadoc comments but don't generate docs ========
579 include $(CLEAR_VARS)
581 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
582 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
583 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
584 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
585 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
586 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
587 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
588 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
589 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
591 LOCAL_MODULE := doc-comment-check
593 LOCAL_DROIDDOC_OPTIONS:=\
594 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
598 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
600 LOCAL_UNINSTALLABLE_MODULE := true
602 include $(BUILD_DROIDDOC)
604 # Run this for checkbuild
605 checkbuild: doc-comment-check-docs
606 # Check comment when you are updating the API
607 update-api: doc-comment-check-docs
609 # ==== static html in the sdk ==================================
610 include $(CLEAR_VARS)
612 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
613 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
614 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
615 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
616 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
617 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
618 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
619 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
620 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
622 LOCAL_MODULE := offline-sdk
624 LOCAL_DROIDDOC_OPTIONS:=\
625 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
627 -title "Android SDK" \
628 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-proofread.txt \
629 -sdkvalues $(OUT_DOCS) \
630 -hdf android.whichdoc offline
632 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
634 include $(BUILD_DROIDDOC)
636 static_doc_index_redirect := $(out_dir)/index.html
637 $(static_doc_index_redirect): \
638 $(LOCAL_PATH)/docs/docs-preview-index.html | $(ACP)
639 $(hide) mkdir -p $(dir $@)
642 $(full_target): $(static_doc_index_redirect)
645 # ==== Public API static reference docs ==================================
646 include $(CLEAR_VARS)
648 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
649 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
650 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
651 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
652 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
653 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
654 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
655 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
656 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
658 LOCAL_MODULE := offline-sdk-referenceonly
660 LOCAL_DROIDDOC_OPTIONS:=\
661 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
663 -title "Android SDK" \
664 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-proofread.txt \
665 -sdkvalues $(OUT_DOCS) \
666 -hdf android.whichdoc offline \
669 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
671 include $(BUILD_DROIDDOC)
673 static_doc_index_redirect := $(out_dir)/index.html
674 $(static_doc_index_redirect): $(LOCAL_PATH)/docs/docs-documentation-redirect.html
675 $(copy-file-to-target)
677 static_doc_properties := $(out_dir)/source.properties
678 $(static_doc_properties): \
679 $(LOCAL_PATH)/docs/source.properties | $(ACP)
680 $(hide) mkdir -p $(dir $@)
683 $(full_target): $(static_doc_index_redirect)
684 $(full_target): $(static_doc_properties)
687 # ==== System API static reference docs ==================================
688 include $(CLEAR_VARS)
690 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
691 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
692 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
693 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
694 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
695 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
696 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
697 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
698 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
700 LOCAL_MODULE := offline-system-sdk-referenceonly
702 LOCAL_DROIDDOC_OPTIONS:=\
703 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
704 -hide 101 -hide 104 -hide 108 \
705 -showAnnotation android.annotation.SystemApi \
707 -title "Android System SDK" \
708 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-proofread.txt \
709 -sdkvalues $(OUT_DOCS) \
710 -hdf android.whichdoc offline \
713 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
715 include $(BUILD_DROIDDOC)
717 static_doc_index_redirect := $(out_dir)/index.html
718 $(static_doc_index_redirect): $(LOCAL_PATH)/docs/docs-documentation-redirect.html
719 $(copy-file-to-target)
721 static_doc_properties := $(out_dir)/source.properties
722 $(static_doc_properties): \
723 $(LOCAL_PATH)/docs/source.properties | $(ACP)
724 $(hide) mkdir -p $(dir $@)
727 $(full_target): $(static_doc_index_redirect)
728 $(full_target): $(static_doc_properties)
729 $(full_target): $(framework_built)
732 # ==== docs for the web (on the androiddevdocs app engine server) =======================
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_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
739 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
740 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
741 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
742 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
743 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
744 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
745 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
747 LOCAL_MODULE := online-sdk
749 LOCAL_DROIDDOC_OPTIONS:= \
750 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
752 -hdf android.whichdoc online \
754 -hdf android.hasSamples true \
755 -samplesdir $(samples_dir)
757 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
759 include $(BUILD_DROIDDOC)
761 # ==== docs for the web (on the androiddevdocs app engine server) =======================
762 include $(CLEAR_VARS)
764 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
765 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
766 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
767 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
768 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
769 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
770 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
771 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
772 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
773 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
774 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
776 LOCAL_MODULE := online-system-api-sdk
778 LOCAL_DROIDDOC_OPTIONS:= \
779 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
781 -showAnnotation android.annotation.SystemApi \
782 -title "Android SDK - Including system APIs." \
787 -hdf android.whichdoc online \
789 -hdf android.hasSamples true \
790 -samplesdir $(samples_dir)
792 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
794 LOCAL_UNINSTALLABLE_MODULE := true
796 include $(BUILD_DROIDDOC)
798 # ==== docs for the web (on the devsite app engine server) =======================
799 include $(CLEAR_VARS)
800 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
801 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
802 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
803 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
804 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
805 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
806 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
807 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
808 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
809 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
810 # specify a second html input dir and an output path relative to OUT_DIR)
811 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
815 LOCAL_DROIDDOC_OPTIONS:= \
816 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
818 -hdf android.whichdoc online \
822 -hdf android.hasSamples true \
823 -samplesdir $(samples_dir)
825 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
827 include $(BUILD_DROIDDOC)
829 # ==== docs for the web (on the devsite app engine server) =======================
830 include $(CLEAR_VARS)
831 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
832 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
833 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
834 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
835 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
836 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
837 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
838 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
839 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
840 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
841 # specify a second html input dir and an output path relative to OUT_DIR)
842 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
844 LOCAL_MODULE := ds-static
846 LOCAL_DROIDDOC_OPTIONS:= \
847 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
848 -hdf android.whichdoc online \
854 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
856 include $(BUILD_DROIDDOC)
858 # ==== generates full navtree for resolving @links in ds postprocessing ====
859 include $(CLEAR_VARS)
861 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
862 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
863 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
864 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
865 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
866 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
867 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
868 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
869 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
871 LOCAL_MODULE := ds-ref-navtree
873 LOCAL_DROIDDOC_OPTIONS:= \
874 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
875 -hdf android.whichdoc online \
880 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
882 include $(BUILD_DROIDDOC)
884 # ==== site updates for docs (on the androiddevdocs app engine server) =======================
885 include $(CLEAR_VARS)
887 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
888 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
889 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
890 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
891 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
892 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
893 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
894 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
895 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
896 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
897 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
899 LOCAL_MODULE := online-sdk-dev
901 LOCAL_DROIDDOC_OPTIONS:= \
902 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
904 -hdf android.whichdoc online \
906 -hdf android.hasSamples true \
907 -samplesdir $(samples_dir)
909 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
911 include $(BUILD_DROIDDOC)
913 # ==== docs that have all of the stuff that's @hidden =======================
914 include $(CLEAR_VARS)
916 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
917 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
918 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
919 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
920 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
921 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
922 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
923 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
924 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
926 LOCAL_MODULE := hidden
927 LOCAL_DROIDDOC_OPTIONS:=\
928 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
930 -title "Android SDK - Including hidden APIs."
933 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
935 include $(BUILD_DROIDDOC)
937 # ==== java proto host library ==============================
938 include $(CLEAR_VARS)
939 LOCAL_MODULE := platformprotos
940 LOCAL_PROTOC_OPTIMIZE_TYPE := full
941 LOCAL_PROTOC_FLAGS := \
942 -Iexternal/protobuf/src
943 LOCAL_SOURCE_FILES_ALL_GENERATED := true
945 cmds/am/proto/instrumentation_data.proto \
946 cmds/statsd/src/perfetto/perfetto_config.proto \
947 $(call all-proto-files-under, core/proto) \
948 $(call all-proto-files-under, libs/incident/proto) \
949 $(call all-proto-files-under, cmds/statsd/src)
951 LOCAL_ERROR_PRONE_FLAGS := -Xep:MissingOverride:OFF
952 include $(BUILD_HOST_JAVA_LIBRARY)
954 # ==== java proto device library (for test only) ==============================
955 include $(CLEAR_VARS)
956 LOCAL_MODULE := platformprotosnano
957 LOCAL_MODULE_TAGS := tests
958 LOCAL_PROTOC_OPTIMIZE_TYPE := nano
959 LOCAL_PROTOC_FLAGS := \
960 -Iexternal/protobuf/src
961 LOCAL_PROTO_JAVA_OUTPUT_PARAMS := \
962 store_unknown_fields = true
963 LOCAL_SDK_VERSION := current
965 $(call all-proto-files-under, core/proto) \
966 $(call all-proto-files-under, libs/incident/proto/android/os)
967 include $(BUILD_STATIC_JAVA_LIBRARY)
970 # ==== java proto device library (for test only) ==============================
971 include $(CLEAR_VARS)
972 LOCAL_MODULE := platformprotoslite
973 LOCAL_MODULE_TAGS := tests
974 LOCAL_PROTOC_OPTIMIZE_TYPE := lite
975 LOCAL_PROTOC_FLAGS := \
976 -Iexternal/protobuf/src
978 $(call all-proto-files-under, core/proto) \
979 $(call all-proto-files-under, libs/incident/proto/android/os)
980 # Protos have lots of MissingOverride and similar.
981 LOCAL_ERROR_PRONE_FLAGS := -XepDisableAllChecks
982 include $(BUILD_STATIC_JAVA_LIBRARY)
984 # ==== hiddenapi lists =======================================
985 include $(CLEAR_VARS)
987 # File names of final API lists
988 LOCAL_LIGHT_GREYLIST := $(INTERNAL_PLATFORM_HIDDENAPI_LIGHT_GREYLIST)
989 LOCAL_DARK_GREYLIST := $(INTERNAL_PLATFORM_HIDDENAPI_DARK_GREYLIST)
990 LOCAL_BLACKLIST := $(INTERNAL_PLATFORM_HIDDENAPI_BLACKLIST)
992 # File names of source files we will use to generate the final API lists.
993 LOCAL_SRC_GREYLIST := frameworks/base/config/hiddenapi-light-greylist.txt
994 LOCAL_SRC_VENDOR_LIST := frameworks/base/config/hiddenapi-vendor-list.txt
995 LOCAL_SRC_FORCE_BLACKLIST := frameworks/base/config/hiddenapi-force-blacklist.txt
996 LOCAL_SRC_PUBLIC_API := $(INTERNAL_PLATFORM_DEX_API_FILE)
997 LOCAL_SRC_PRIVATE_API := $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE)
998 LOCAL_SRC_REMOVED_API := $(INTERNAL_PLATFORM_REMOVED_DEX_API_FILE)
1001 $(LOCAL_SRC_GREYLIST) \
1002 $(LOCAL_SRC_VENDOR_LIST) \
1003 $(LOCAL_SRC_FORCE_BLACKLIST) \
1004 $(LOCAL_SRC_PUBLIC_API) \
1005 $(LOCAL_SRC_PRIVATE_API) \
1006 $(LOCAL_SRC_REMOVED_API)
1008 define assert-has-no-overlap
1009 if [ ! -z "`comm -12 <(sort $(1)) <(sort $(2))`" ]; then \
1010 echo "$(1) and $(2) should not overlap" 1>&2; \
1011 comm -12 <(sort $(1)) <(sort $(2)) 1>&2; \
1016 define assert-is-subset
1017 if [ ! -z "`comm -23 <(sort $(1)) <(sort $(2))`" ]; then \
1018 echo "$(1) must be a subset of $(2)" 1>&2; \
1019 comm -23 <(sort $(1)) <(sort $(2)) 1>&2; \
1024 define assert-has-no-duplicates
1025 if [ ! -z "`sort $(1) | uniq -D`" ]; then \
1026 echo "$(1) has duplicate entries" 1>&2; \
1027 sort $(1) | uniq -D 1>&2; \
1032 # The following rules build API lists in the build folder.
1033 # By not using files from the source tree, ART buildbots can mock these lists
1034 # or have alternative rules for building them. Other rules in the build system
1035 # should depend on the files in the build folder.
1037 # Merge light greylist from multiple files:
1038 # (1) manual greylist LOCAL_SRC_GREYLIST
1039 # (2) list of usages from vendor apps LOCAL_SRC_VENDOR_LIST
1040 # (3) list of removed APIs in LOCAL_SRC_REMOVED_API
1041 # @removed does not imply private in Doclava. We must take the subset also
1042 # in LOCAL_SRC_PRIVATE_API.
1043 # (4) list of serialization APIs
1044 # Automatically adds all methods which match the signatures in
1045 # REGEX_SERIALIZATION. These are greylisted in order to allow applications
1046 # to write their own serializers.
1047 $(LOCAL_LIGHT_GREYLIST): REGEX_SERIALIZATION := \
1048 "readObject\(Ljava/io/ObjectInputStream;\)V" \
1049 "readObjectNoData\(\)V" \
1050 "readResolve\(\)Ljava/lang/Object;" \
1051 "serialVersionUID:J" \
1052 "serialPersistentFields:\[Ljava/io/ObjectStreamField;" \
1053 "writeObject\(Ljava/io/ObjectOutputStream;\)V" \
1054 "writeReplace\(\)Ljava/lang/Object;"
1055 $(LOCAL_LIGHT_GREYLIST): $(LOCAL_SRC_ALL)
1056 sort $(LOCAL_SRC_GREYLIST) $(LOCAL_SRC_VENDOR_LIST) \
1057 <(grep -E "\->("$(subst $(space),"|",$(REGEX_SERIALIZATION))")$$" \
1058 $(LOCAL_SRC_PRIVATE_API)) \
1059 <(comm -12 <(sort $(LOCAL_SRC_REMOVED_API)) <(sort $(LOCAL_SRC_PRIVATE_API))) \
1061 $(call assert-has-no-duplicates,$@)
1062 $(call assert-is-subset,$@,$(LOCAL_SRC_PRIVATE_API))
1063 $(call assert-has-no-overlap,$@,$(LOCAL_SRC_FORCE_BLACKLIST))
1065 # Generate dark greylist as remaining classes and class members in the same
1066 # package as classes listed in the light greylist.
1067 # The algorithm is as follows:
1068 # (1) extract the class descriptor from each entry in LOCAL_LIGHT_GREYLIST
1069 # (2) strip everything after the last forward-slash,
1070 # e.g. 'Lpackage/subpackage/class$inner;' turns into 'Lpackage/subpackage/'
1071 # (3) insert all entries from LOCAL_SRC_PRIVATE_API which begin with the package
1072 # name but do not contain another forward-slash in the class name, e.g.
1073 # matching '^Lpackage/subpackage/[^/;]*;'
1074 # (4) subtract entries shared with LOCAL_LIGHT_GREYLIST
1075 $(LOCAL_DARK_GREYLIST): $(LOCAL_SRC_ALL) $(LOCAL_LIGHT_GREYLIST)
1076 comm -13 <(sort $(LOCAL_LIGHT_GREYLIST) $(LOCAL_SRC_FORCE_BLACKLIST)) \
1077 <(cat $(LOCAL_SRC_PUBLIC_API) $(LOCAL_LIGHT_GREYLIST) | \
1078 sed 's/\->.*//' | sed 's/\(.*\/\).*/\1/' | sort | uniq | \
1079 while read PKG_NAME; do \
1080 grep -E "^$${PKG_NAME}[^/;]*;" $(LOCAL_SRC_PRIVATE_API); \
1081 done | sort | uniq) \
1083 $(call assert-is-subset,$@,$(LOCAL_SRC_PRIVATE_API))
1084 $(call assert-has-no-duplicates,$@)
1085 $(call assert-has-no-overlap,$@,$(LOCAL_LIGHT_GREYLIST))
1086 $(call assert-has-no-overlap,$@,$(LOCAL_SRC_FORCE_BLACKLIST))
1088 # Generate blacklist as private API minus (light greylist plus dark greylist).
1089 $(LOCAL_BLACKLIST): $(LOCAL_SRC_ALL) $(LOCAL_LIGHT_GREYLIST) $(LOCAL_DARK_GREYLIST)
1090 comm -13 <(sort $(LOCAL_LIGHT_GREYLIST) $(LOCAL_DARK_GREYLIST)) \
1091 <(sort $(LOCAL_SRC_PRIVATE_API)) \
1093 $(call assert-is-subset,$@,$(LOCAL_SRC_PRIVATE_API))
1094 $(call assert-has-no-duplicates,$@)
1095 $(call assert-has-no-overlap,$@,$(LOCAL_LIGHT_GREYLIST))
1096 $(call assert-has-no-overlap,$@,$(LOCAL_DARK_GREYLIST))
1097 $(call assert-is-subset,$(LOCAL_SRC_FORCE_BLACKLIST),$@)
1099 # Include subdirectory makefiles
1100 # ============================================================
1102 # If we're building with ONE_SHOT_MAKEFILE (mm, mmm), then what the framework
1103 # team really wants is to build the stuff defined by this makefile.
1104 ifeq (,$(ONE_SHOT_MAKEFILE))
1105 include $(call first-makefiles-under,$(LOCAL_PATH))
1108 endif # ANDROID_BUILD_EMBEDDED