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 ./frameworks/base/api/current.txt P \
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 # ==== Public API diff ===========================
256 include $(CLEAR_VARS)
258 LOCAL_SRC_FILES := $(framework_docs_LOCAL_API_CHECK_SRC_FILES)
259 LOCAL_GENERATED_SOURCES := $(framework_docs_LOCAL_GENERATED_SOURCES)
260 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
261 LOCAL_JAVA_LIBRARIES := $(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
262 LOCAL_MODULE_CLASS := $(framework_docs_LOCAL_MODULE_CLASS)
263 LOCAL_ADDITIONAL_JAVA_DIR := $(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
264 LOCAL_ADDITIONAL_DEPENDENCIES := \
265 $(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES) \
266 $(INTERNAL_PLATFORM_API_FILE)
268 LOCAL_MODULE := offline-sdk-referenceonly
270 last_released_sdk_version := $(lastword $(call numerically_sort, \
271 $(filter-out current, \
272 $(patsubst $(SRC_API_DIR)/%.txt,%, $(wildcard $(SRC_API_DIR)/*.txt)) \
276 LOCAL_APIDIFF_OLDAPI := $(LOCAL_PATH)/../../$(SRC_API_DIR)/$(last_released_sdk_version)
277 LOCAL_APIDIFF_NEWAPI := $(LOCAL_PATH)/../../$(basename $(INTERNAL_PLATFORM_API_FILE))
279 include $(BUILD_APIDIFF)
281 # Hack to get diffs included in docs output
282 out_zip := $(OUT_DOCS)/$(LOCAL_MODULE)-docs.zip
283 $(out_zip): $(full_target)
285 # ==== System API diff ===========================
286 include $(CLEAR_VARS)
288 LOCAL_SRC_FILES := $(framework_docs_LOCAL_API_CHECK_SRC_FILES)
289 LOCAL_GENERATED_SOURCES := $(framework_docs_LOCAL_GENERATED_SOURCES)
290 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
291 LOCAL_JAVA_LIBRARIES := $(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
292 LOCAL_MODULE_CLASS := $(framework_docs_LOCAL_MODULE_CLASS)
293 LOCAL_ADDITIONAL_JAVA_DIR := $(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
294 LOCAL_ADDITIONAL_DEPENDENCIES := \
295 $(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES) \
296 $(INTERNAL_PLATFORM_SYSTEM_API_FILE)
298 LOCAL_MODULE := offline-system-sdk-referenceonly
300 last_released_sdk_version := $(lastword $(call numerically_sort, \
301 $(filter-out current, \
302 $(patsubst $(SRC_SYSTEM_API_DIR)/%.txt,%, $(wildcard $(SRC_SYSTEM_API_DIR)/*.txt)) \
306 LOCAL_APIDIFF_OLDAPI := $(LOCAL_PATH)/../../$(SRC_SYSTEM_API_DIR)/$(last_released_sdk_version)
307 LOCAL_APIDIFF_NEWAPI := $(LOCAL_PATH)/../../$(basename $(INTERNAL_PLATFORM_SYSTEM_API_FILE))
309 include $(BUILD_APIDIFF)
311 # Hack to get diffs included in docs output
312 out_zip := $(OUT_DOCS)/$(LOCAL_MODULE)-docs.zip
313 $(out_zip): $(full_target)
315 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_API_FILE))
316 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_SYSTEM_API_FILE))
317 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_TEST_API_FILE))
319 # ==== the complete hidden api list ===================================
320 include $(CLEAR_VARS)
322 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
323 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
324 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
325 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
326 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
327 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
328 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
329 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
330 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
332 LOCAL_MODULE := hidden-api-list
334 LOCAL_DROIDDOC_OPTIONS:=\
335 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
338 -showAnnotation android.annotation.SystemApi \
339 -showAnnotation android.annotation.TestApi \
340 -privateDexApi $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE) \
343 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
345 LOCAL_UNINSTALLABLE_MODULE := true
347 include $(BUILD_DROIDDOC)
349 $(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE)
351 # ==== check javadoc comments but don't generate docs ========
352 include $(CLEAR_VARS)
354 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
355 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
356 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
357 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
358 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
359 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
360 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
361 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
362 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
364 LOCAL_MODULE := doc-comment-check
366 LOCAL_DROIDDOC_OPTIONS:=\
367 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
371 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
373 LOCAL_UNINSTALLABLE_MODULE := true
375 include $(BUILD_DROIDDOC)
377 # Run this for checkbuild
378 checkbuild: doc-comment-check-docs
379 # Check comment when you are updating the API
380 update-api: doc-comment-check-docs
382 # ==== static html in the sdk ==================================
383 include $(CLEAR_VARS)
385 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
386 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
387 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
388 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
389 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
390 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
391 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
392 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
393 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
395 LOCAL_MODULE := offline-sdk
397 LOCAL_DROIDDOC_OPTIONS:=\
398 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
400 -title "Android SDK" \
401 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-proofread.txt \
402 -sdkvalues $(OUT_DOCS) \
403 -hdf android.whichdoc offline
405 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
407 include $(BUILD_DROIDDOC)
409 static_doc_index_redirect := $(out_dir)/index.html
410 $(static_doc_index_redirect): \
411 $(LOCAL_PATH)/docs/docs-preview-index.html | $(ACP)
412 $(hide) mkdir -p $(dir $@)
415 $(full_target): $(static_doc_index_redirect)
418 # ==== Public API static reference docs ==================================
419 include $(CLEAR_VARS)
421 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
422 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
423 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
424 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
425 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
426 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
427 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
428 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
429 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
431 LOCAL_MODULE := offline-sdk-referenceonly
433 LOCAL_DROIDDOC_OPTIONS:=\
434 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
436 -title "Android SDK" \
437 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-proofread.txt \
438 -sdkvalues $(OUT_DOCS) \
439 -hdf android.whichdoc offline \
442 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
444 include $(BUILD_DROIDDOC)
446 static_doc_index_redirect := $(out_dir)/index.html
447 $(static_doc_index_redirect): $(LOCAL_PATH)/docs/docs-documentation-redirect.html
448 $(copy-file-to-target)
450 static_doc_properties := $(out_dir)/source.properties
451 $(static_doc_properties): \
452 $(LOCAL_PATH)/docs/source.properties | $(ACP)
453 $(hide) mkdir -p $(dir $@)
456 $(full_target): $(static_doc_index_redirect)
457 $(full_target): $(static_doc_properties)
460 # ==== System API static reference docs ==================================
461 include $(CLEAR_VARS)
463 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
464 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
465 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
466 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
467 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
468 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
469 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
470 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
471 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
473 LOCAL_MODULE := offline-system-sdk-referenceonly
475 LOCAL_DROIDDOC_OPTIONS:=\
476 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
477 -hide 101 -hide 104 -hide 108 \
478 -showAnnotation android.annotation.SystemApi \
480 -title "Android System SDK" \
481 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-proofread.txt \
482 -sdkvalues $(OUT_DOCS) \
483 -hdf android.whichdoc offline \
486 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
488 include $(BUILD_DROIDDOC)
490 static_doc_index_redirect := $(out_dir)/index.html
491 $(static_doc_index_redirect): $(LOCAL_PATH)/docs/docs-documentation-redirect.html
492 $(copy-file-to-target)
494 static_doc_properties := $(out_dir)/source.properties
495 $(static_doc_properties): \
496 $(LOCAL_PATH)/docs/source.properties | $(ACP)
497 $(hide) mkdir -p $(dir $@)
500 $(full_target): $(static_doc_index_redirect)
501 $(full_target): $(static_doc_properties)
502 $(full_target): $(framework_built)
505 # ==== docs for the web (on the androiddevdocs app engine server) =======================
506 include $(CLEAR_VARS)
508 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
509 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
510 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
511 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
512 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
513 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
514 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
515 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
516 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
517 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
518 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
520 LOCAL_MODULE := online-sdk
522 LOCAL_DROIDDOC_OPTIONS:= \
523 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
525 -hdf android.whichdoc online \
527 -hdf android.hasSamples true \
528 -samplesdir $(samples_dir)
530 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
532 include $(BUILD_DROIDDOC)
534 # ==== docs for the web (on the androiddevdocs app engine server) =======================
535 include $(CLEAR_VARS)
537 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
538 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
539 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
540 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
541 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
542 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
543 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
544 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
545 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
546 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
547 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
549 LOCAL_MODULE := online-system-api-sdk
551 LOCAL_DROIDDOC_OPTIONS:= \
552 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
554 -showAnnotation android.annotation.SystemApi \
555 -title "Android SDK - Including system APIs." \
560 -hdf android.whichdoc online \
562 -hdf android.hasSamples true \
563 -samplesdir $(samples_dir)
565 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
567 LOCAL_UNINSTALLABLE_MODULE := true
569 include $(BUILD_DROIDDOC)
571 # ==== docs for the web (on the devsite app engine server) =======================
572 include $(CLEAR_VARS)
573 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
574 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
575 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
576 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
577 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
578 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
579 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
580 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
581 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
582 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
583 # specify a second html input dir and an output path relative to OUT_DIR)
584 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
588 LOCAL_DROIDDOC_OPTIONS:= \
589 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
591 -hdf android.whichdoc online \
595 -hdf android.hasSamples true \
596 -samplesdir $(samples_dir)
598 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
600 include $(BUILD_DROIDDOC)
602 # ==== docs for the web (on the devsite app engine server) =======================
603 include $(CLEAR_VARS)
604 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
605 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
606 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
607 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
608 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
609 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
610 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
611 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
612 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
613 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
614 # specify a second html input dir and an output path relative to OUT_DIR)
615 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
617 LOCAL_MODULE := ds-static
619 LOCAL_DROIDDOC_OPTIONS:= \
620 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
621 -hdf android.whichdoc online \
627 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
629 include $(BUILD_DROIDDOC)
631 # ==== generates full navtree for resolving @links in ds postprocessing ====
632 include $(CLEAR_VARS)
634 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
635 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
636 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
637 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
638 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
639 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
640 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
641 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
642 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
644 LOCAL_MODULE := ds-ref-navtree
646 LOCAL_DROIDDOC_OPTIONS:= \
647 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
648 -hdf android.whichdoc online \
653 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
655 include $(BUILD_DROIDDOC)
657 # ==== site updates for docs (on the androiddevdocs app engine server) =======================
658 include $(CLEAR_VARS)
660 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
661 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
662 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
663 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
664 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
665 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
666 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
667 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
668 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
669 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
670 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
672 LOCAL_MODULE := online-sdk-dev
674 LOCAL_DROIDDOC_OPTIONS:= \
675 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
677 -hdf android.whichdoc online \
679 -hdf android.hasSamples true \
680 -samplesdir $(samples_dir)
682 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
684 include $(BUILD_DROIDDOC)
686 # ==== docs that have all of the stuff that's @hidden =======================
687 include $(CLEAR_VARS)
689 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
690 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
691 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
692 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
693 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
694 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
695 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
696 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
697 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
699 LOCAL_MODULE := hidden
700 LOCAL_DROIDDOC_OPTIONS:=\
701 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
703 -title "Android SDK - Including hidden APIs."
706 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
708 include $(BUILD_DROIDDOC)
710 # ==== java proto host library ==============================
711 include $(CLEAR_VARS)
712 LOCAL_MODULE := platformprotos
713 LOCAL_PROTOC_OPTIMIZE_TYPE := full
714 LOCAL_PROTOC_FLAGS := \
715 -Iexternal/protobuf/src
716 LOCAL_SOURCE_FILES_ALL_GENERATED := true
718 cmds/am/proto/instrumentation_data.proto \
719 cmds/statsd/src/perfetto/perfetto_config.proto \
720 $(call all-proto-files-under, core/proto) \
721 $(call all-proto-files-under, libs/incident/proto) \
722 $(call all-proto-files-under, cmds/statsd/src)
724 LOCAL_ERROR_PRONE_FLAGS := -Xep:MissingOverride:OFF
725 include $(BUILD_HOST_JAVA_LIBRARY)
727 # ==== java proto device library (for test only) ==============================
728 include $(CLEAR_VARS)
729 LOCAL_MODULE := platformprotosnano
730 LOCAL_MODULE_TAGS := tests
731 LOCAL_PROTOC_OPTIMIZE_TYPE := nano
732 LOCAL_PROTOC_FLAGS := \
733 -Iexternal/protobuf/src
734 LOCAL_PROTO_JAVA_OUTPUT_PARAMS := \
735 store_unknown_fields = true
736 LOCAL_SDK_VERSION := current
738 $(call all-proto-files-under, core/proto) \
739 $(call all-proto-files-under, libs/incident/proto/android/os)
740 include $(BUILD_STATIC_JAVA_LIBRARY)
743 # ==== java proto device library (for test only) ==============================
744 include $(CLEAR_VARS)
745 LOCAL_MODULE := platformprotoslite
746 LOCAL_MODULE_TAGS := tests
747 LOCAL_PROTOC_OPTIMIZE_TYPE := lite
748 LOCAL_PROTOC_FLAGS := \
749 -Iexternal/protobuf/src
751 $(call all-proto-files-under, core/proto) \
752 $(call all-proto-files-under, libs/incident/proto/android/os)
753 # Protos have lots of MissingOverride and similar.
754 LOCAL_ERROR_PRONE_FLAGS := -XepDisableAllChecks
755 include $(BUILD_STATIC_JAVA_LIBRARY)
757 # ==== hiddenapi lists =======================================
759 # Copy blacklist and light greylist over into the build folder.
760 # This is for ART buildbots which need to mock these lists and have alternative
761 # rules for building them. Other rules in the build system should depend on the
762 # files in the build folder.
764 $(eval $(call copy-one-file,frameworks/base/config/hiddenapi-blacklist.txt,\
765 $(INTERNAL_PLATFORM_HIDDENAPI_BLACKLIST)))
767 # Temporarily merge light greylist from two files. Vendor list will become dark
768 # grey once we remove the UI toast.
769 $(INTERNAL_PLATFORM_HIDDENAPI_LIGHT_GREYLIST): frameworks/base/config/hiddenapi-light-greylist.txt \
770 frameworks/base/config/hiddenapi-vendor-list.txt
773 # Generate dark greylist as private API minus (blacklist plus light greylist).
775 $(INTERNAL_PLATFORM_HIDDENAPI_DARK_GREYLIST): PRIVATE_API := $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE)
776 $(INTERNAL_PLATFORM_HIDDENAPI_DARK_GREYLIST): BLACKLIST := $(INTERNAL_PLATFORM_HIDDENAPI_BLACKLIST)
777 $(INTERNAL_PLATFORM_HIDDENAPI_DARK_GREYLIST): LIGHT_GREYLIST := $(INTERNAL_PLATFORM_HIDDENAPI_LIGHT_GREYLIST)
778 $(INTERNAL_PLATFORM_HIDDENAPI_DARK_GREYLIST): $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE) \
779 $(INTERNAL_PLATFORM_HIDDENAPI_BLACKLIST) \
780 $(INTERNAL_PLATFORM_HIDDENAPI_LIGHT_GREYLIST)
781 if [ ! -z "`comm -12 <(sort $(BLACKLIST)) <(sort $(LIGHT_GREYLIST))`" ]; then \
782 echo "There should be no overlap between $(BLACKLIST) and $(LIGHT_GREYLIST)" 1>&2; \
784 elif [ ! -z "`comm -13 <(sort $(PRIVATE_API)) <(sort $(BLACKLIST))`" ]; then \
785 echo "$(BLACKLIST) must be a subset of $(PRIVATE_API)" 1>&2; \
787 elif [ ! -z "`comm -13 <(sort $(PRIVATE_API)) <(sort $(LIGHT_GREYLIST))`" ]; then \
788 echo "$(LIGHT_GREYLIST) must be a subset of $(PRIVATE_API)" 1>&2; \
791 comm -23 <(sort $(PRIVATE_API)) <(sort $(BLACKLIST) $(LIGHT_GREYLIST)) > $@
793 # Include subdirectory makefiles
794 # ============================================================
796 # If we're building with ONE_SHOT_MAKEFILE (mm, mmm), then what the framework
797 # team really wants is to build the stuff defined by this makefile.
798 ifeq (,$(ONE_SHOT_MAKEFILE))
799 include $(call first-makefiles-under,$(LOCAL_PATH))
802 endif # ANDROID_BUILD_EMBEDDED