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.okhttp \
168 -hidePackage com.android.org.conscrypt \
169 -hidePackage com.android.server \
170 -since $(SRC_API_DIR)/1.xml 1 \
171 -since $(SRC_API_DIR)/2.xml 2 \
172 -since $(SRC_API_DIR)/3.xml 3 \
173 -since $(SRC_API_DIR)/4.xml 4 \
174 -since $(SRC_API_DIR)/5.xml 5 \
175 -since $(SRC_API_DIR)/6.xml 6 \
176 -since $(SRC_API_DIR)/7.xml 7 \
177 -since $(SRC_API_DIR)/8.xml 8 \
178 -since $(SRC_API_DIR)/9.xml 9 \
179 -since $(SRC_API_DIR)/10.xml 10 \
180 -since $(SRC_API_DIR)/11.xml 11 \
181 -since $(SRC_API_DIR)/12.xml 12 \
182 -since $(SRC_API_DIR)/13.xml 13 \
183 -since $(SRC_API_DIR)/14.txt 14 \
184 -since $(SRC_API_DIR)/15.txt 15 \
185 -since $(SRC_API_DIR)/16.txt 16 \
186 -since $(SRC_API_DIR)/17.txt 17 \
187 -since $(SRC_API_DIR)/18.txt 18 \
188 -since $(SRC_API_DIR)/19.txt 19 \
189 -since $(SRC_API_DIR)/20.txt 20 \
190 -since $(SRC_API_DIR)/21.txt 21 \
191 -since $(SRC_API_DIR)/22.txt 22 \
192 -since $(SRC_API_DIR)/23.txt 23 \
193 -since $(SRC_API_DIR)/24.txt 24 \
194 -since $(SRC_API_DIR)/25.txt 25 \
195 -since $(SRC_API_DIR)/26.txt 26 \
196 -since $(SRC_API_DIR)/27.txt 27 \
197 -since ./frameworks/base/api/current.txt P \
198 -werror -lerror -hide 111 -hide 113 -hide 125 -hide 126 -hide 127 -hide 128 \
199 -overview $(LOCAL_PATH)/core/java/overview.html \
201 framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR:= \
202 $(call intermediates-dir-for,JAVA_LIBRARIES,framework,,COMMON)
204 framework_docs_LOCAL_ADDITIONAL_JAVA_DIR:= \
205 $(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
207 framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES := \
208 frameworks/base/docs/knowntags.txt \
209 $(libcore_to_document_generated)
211 samples_dir := development/samples/browseable
213 # Whitelist of valid groups, used for default TOC grouping. Each sample must
214 # belong to one (and only one) group. Assign samples to groups by setting
215 # a sample.group var to one of these groups in the sample's _index.jd.
216 sample_groups := -samplegroup Admin \
217 -samplegroup Background \
218 -samplegroup Connectivity \
219 -samplegroup Content \
222 -samplegroup Notification \
223 -samplegroup RenderScript \
224 -samplegroup Security \
225 -samplegroup Sensors \
226 -samplegroup System \
227 -samplegroup Testing \
230 -samplegroup Wearable
232 ## SDK version identifiers used in the published docs
233 # major[.minor] version for current SDK. (full releases only)
234 framework_docs_SDK_VERSION:=7.0
235 # release version (ie "Release x") (full releases only)
236 framework_docs_SDK_REL_ID:=1
238 framework_docs_LOCAL_DROIDDOC_OPTIONS += \
240 -hdf sdk.codename O \
241 -hdf sdk.preview.version 1 \
242 -hdf sdk.version $(framework_docs_SDK_VERSION) \
243 -hdf sdk.rel.id $(framework_docs_SDK_REL_ID) \
245 -resourcesdir $(LOCAL_PATH)/docs/html/reference/images/ \
246 -resourcesoutdir reference/android/images/
248 # Federate Support Library references against local API file.
249 framework_docs_LOCAL_DROIDDOC_OPTIONS += \
250 -federate SupportLib https://developer.android.com \
251 -federationapi SupportLib prebuilts/sdk/current/support-api.txt
253 # ==== Public API diff ===========================
254 include $(CLEAR_VARS)
256 LOCAL_SRC_FILES := $(framework_docs_LOCAL_API_CHECK_SRC_FILES)
257 LOCAL_GENERATED_SOURCES := $(framework_docs_LOCAL_GENERATED_SOURCES)
258 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
259 LOCAL_JAVA_LIBRARIES := $(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
260 LOCAL_MODULE_CLASS := $(framework_docs_LOCAL_MODULE_CLASS)
261 LOCAL_ADDITIONAL_JAVA_DIR := $(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
262 LOCAL_ADDITIONAL_DEPENDENCIES := \
263 $(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES) \
264 $(INTERNAL_PLATFORM_API_FILE)
266 LOCAL_MODULE := offline-sdk-referenceonly
268 last_released_sdk_version := $(lastword $(call numerically_sort, \
269 $(filter-out current, \
270 $(patsubst $(SRC_API_DIR)/%.txt,%, $(wildcard $(SRC_API_DIR)/*.txt)) \
274 LOCAL_APIDIFF_OLDAPI := $(LOCAL_PATH)/../../$(SRC_API_DIR)/$(last_released_sdk_version)
275 LOCAL_APIDIFF_NEWAPI := $(LOCAL_PATH)/../../$(basename $(INTERNAL_PLATFORM_API_FILE))
277 include $(BUILD_APIDIFF)
279 # Hack to get diffs included in docs output
280 out_zip := $(OUT_DOCS)/$(LOCAL_MODULE)-docs.zip
281 $(out_zip): $(full_target)
283 # ==== System API diff ===========================
284 include $(CLEAR_VARS)
286 LOCAL_SRC_FILES := $(framework_docs_LOCAL_API_CHECK_SRC_FILES)
287 LOCAL_GENERATED_SOURCES := $(framework_docs_LOCAL_GENERATED_SOURCES)
288 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
289 LOCAL_JAVA_LIBRARIES := $(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
290 LOCAL_MODULE_CLASS := $(framework_docs_LOCAL_MODULE_CLASS)
291 LOCAL_ADDITIONAL_JAVA_DIR := $(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
292 LOCAL_ADDITIONAL_DEPENDENCIES := \
293 $(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES) \
294 $(INTERNAL_PLATFORM_SYSTEM_API_FILE)
296 LOCAL_MODULE := offline-system-sdk-referenceonly
298 last_released_sdk_version := $(lastword $(call numerically_sort, \
299 $(filter-out current, \
300 $(patsubst $(SRC_SYSTEM_API_DIR)/%.txt,%, $(wildcard $(SRC_SYSTEM_API_DIR)/*.txt)) \
304 LOCAL_APIDIFF_OLDAPI := $(LOCAL_PATH)/../../$(SRC_SYSTEM_API_DIR)/$(last_released_sdk_version)
305 LOCAL_APIDIFF_NEWAPI := $(LOCAL_PATH)/../../$(basename $(INTERNAL_PLATFORM_SYSTEM_API_FILE))
307 include $(BUILD_APIDIFF)
309 # Hack to get diffs included in docs output
310 out_zip := $(OUT_DOCS)/$(LOCAL_MODULE)-docs.zip
311 $(out_zip): $(full_target)
313 # ==== the api stubs and current.xml ===========================
314 include $(CLEAR_VARS)
316 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
317 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
318 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
319 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
320 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
321 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
322 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
323 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
324 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
326 LOCAL_MODULE := api-stubs
328 LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/android_stubs_current_intermediates/src
330 LOCAL_DROIDDOC_OPTIONS:=\
331 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
333 -api $(INTERNAL_PLATFORM_API_FILE) \
334 -privateApi $(INTERNAL_PLATFORM_PRIVATE_API_FILE) \
335 -privateDexApi $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE) \
336 -removedApi $(INTERNAL_PLATFORM_REMOVED_API_FILE) \
339 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
341 LOCAL_UNINSTALLABLE_MODULE := true
343 include $(BUILD_DROIDDOC)
345 $(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_API_FILE) \
346 $(INTERNAL_PLATFORM_PRIVATE_API_FILE) \
347 $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE)
348 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_API_FILE))
350 # ==== the system api stubs ===================================
351 include $(CLEAR_VARS)
353 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
354 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
355 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
356 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
357 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
358 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
359 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
360 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
361 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
363 LOCAL_MODULE := system-api-stubs
365 LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/android_system_stubs_current_intermediates/src
367 LOCAL_DROIDDOC_OPTIONS:=\
368 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
370 -showAnnotation android.annotation.SystemApi \
371 -api $(INTERNAL_PLATFORM_SYSTEM_API_FILE) \
372 -privateApi $(INTERNAL_PLATFORM_SYSTEM_PRIVATE_API_FILE) \
373 -privateDexApi $(INTERNAL_PLATFORM_SYSTEM_PRIVATE_DEX_API_FILE) \
374 -removedApi $(INTERNAL_PLATFORM_SYSTEM_REMOVED_API_FILE) \
375 -exactApi $(INTERNAL_PLATFORM_SYSTEM_EXACT_API_FILE) \
378 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
380 LOCAL_UNINSTALLABLE_MODULE := true
382 include $(BUILD_DROIDDOC)
384 $(full_target): .KATI_IMPLICIT_OUTPUTS := $(INTERNAL_PLATFORM_SYSTEM_API_FILE) \
385 $(INTERNAL_PLATFORM_SYSTEM_PRIVATE_API_FILE) \
386 $(INTERNAL_PLATFORM_SYSTEM_PRIVATE_DEX_API_FILE)
387 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_SYSTEM_API_FILE))
389 # ==== the test api stubs ===================================
390 include $(CLEAR_VARS)
392 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES)
393 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
394 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
395 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES)
396 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
397 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
398 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
399 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR)
400 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
402 LOCAL_MODULE := test-api-stubs
404 LOCAL_DROIDDOC_STUB_OUT_DIR := $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/android_test_stubs_current_intermediates/src
406 LOCAL_DROIDDOC_OPTIONS:=\
407 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
409 -stubs $(TARGET_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/android_test_stubs_current_intermediates/src \
410 -showAnnotation android.annotation.TestApi \
411 -api $(INTERNAL_PLATFORM_TEST_API_FILE) \
412 -removedApi $(INTERNAL_PLATFORM_TEST_REMOVED_API_FILE) \
413 -exactApi $(INTERNAL_PLATFORM_TEST_EXACT_API_FILE) \
416 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
418 LOCAL_UNINSTALLABLE_MODULE := true
420 include $(BUILD_DROIDDOC)
422 $(INTERNAL_PLATFORM_TEST_API_FILE): $(full_target)
423 $(call dist-for-goals,sdk,$(INTERNAL_PLATFORM_TEST_API_FILE))
425 # ==== check javadoc comments but don't generate docs ========
426 include $(CLEAR_VARS)
428 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
429 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
430 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
431 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
432 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
433 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
434 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
435 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
436 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
438 LOCAL_MODULE := doc-comment-check
440 LOCAL_DROIDDOC_OPTIONS:=\
441 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
445 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
447 LOCAL_UNINSTALLABLE_MODULE := true
449 include $(BUILD_DROIDDOC)
451 # Run this for checkbuild
452 checkbuild: doc-comment-check-docs
453 # Check comment when you are updating the API
454 update-api: doc-comment-check-docs
456 # ==== static html in the sdk ==================================
457 include $(CLEAR_VARS)
459 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
460 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
461 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
462 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
463 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
464 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
465 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
466 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
467 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
469 LOCAL_MODULE := offline-sdk
471 LOCAL_DROIDDOC_OPTIONS:=\
472 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
474 -title "Android SDK" \
475 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-proofread.txt \
476 -sdkvalues $(OUT_DOCS) \
477 -hdf android.whichdoc offline
479 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
481 include $(BUILD_DROIDDOC)
483 static_doc_index_redirect := $(out_dir)/index.html
484 $(static_doc_index_redirect): \
485 $(LOCAL_PATH)/docs/docs-preview-index.html | $(ACP)
486 $(hide) mkdir -p $(dir $@)
489 $(full_target): $(static_doc_index_redirect)
492 # ==== Public API static reference docs ==================================
493 include $(CLEAR_VARS)
495 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
496 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
497 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
498 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
499 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
500 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
501 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
502 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
503 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
505 LOCAL_MODULE := offline-sdk-referenceonly
507 LOCAL_DROIDDOC_OPTIONS:=\
508 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
510 -title "Android SDK" \
511 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-proofread.txt \
512 -sdkvalues $(OUT_DOCS) \
513 -hdf android.whichdoc offline \
516 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
518 include $(BUILD_DROIDDOC)
520 static_doc_index_redirect := $(out_dir)/index.html
521 $(static_doc_index_redirect): $(LOCAL_PATH)/docs/docs-documentation-redirect.html
522 $(copy-file-to-target)
524 static_doc_properties := $(out_dir)/source.properties
525 $(static_doc_properties): \
526 $(LOCAL_PATH)/docs/source.properties | $(ACP)
527 $(hide) mkdir -p $(dir $@)
530 $(full_target): $(static_doc_index_redirect)
531 $(full_target): $(static_doc_properties)
534 # ==== System API static reference docs ==================================
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_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
541 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
542 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
543 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
544 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
545 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
547 LOCAL_MODULE := offline-system-sdk-referenceonly
549 LOCAL_DROIDDOC_OPTIONS:=\
550 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
551 -hide 101 -hide 104 -hide 108 \
552 -showAnnotation android.annotation.SystemApi \
554 -title "Android System SDK" \
555 -proofread $(OUT_DOCS)/$(LOCAL_MODULE)-proofread.txt \
556 -sdkvalues $(OUT_DOCS) \
557 -hdf android.whichdoc offline \
560 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
562 include $(BUILD_DROIDDOC)
564 static_doc_index_redirect := $(out_dir)/index.html
565 $(static_doc_index_redirect): $(LOCAL_PATH)/docs/docs-documentation-redirect.html
566 $(copy-file-to-target)
568 static_doc_properties := $(out_dir)/source.properties
569 $(static_doc_properties): \
570 $(LOCAL_PATH)/docs/source.properties | $(ACP)
571 $(hide) mkdir -p $(dir $@)
574 $(full_target): $(static_doc_index_redirect)
575 $(full_target): $(static_doc_properties)
576 $(full_target): $(framework_built)
579 # ==== docs for the web (on the androiddevdocs app engine server) =======================
580 include $(CLEAR_VARS)
582 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
583 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
584 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
585 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
586 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
587 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
588 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
589 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
590 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
591 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
592 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
594 LOCAL_MODULE := online-sdk
596 LOCAL_DROIDDOC_OPTIONS:= \
597 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
599 -hdf android.whichdoc online \
601 -hdf android.hasSamples true \
602 -samplesdir $(samples_dir)
604 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
606 include $(BUILD_DROIDDOC)
608 # ==== docs for the web (on the androiddevdocs app engine server) =======================
609 include $(CLEAR_VARS)
611 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
612 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
613 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
614 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
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)
621 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
623 LOCAL_MODULE := online-system-api-sdk
625 LOCAL_DROIDDOC_OPTIONS:= \
626 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
628 -showAnnotation android.annotation.SystemApi \
629 -title "Android SDK - Including system APIs." \
634 -hdf android.whichdoc online \
636 -hdf android.hasSamples true \
637 -samplesdir $(samples_dir)
639 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
641 LOCAL_UNINSTALLABLE_MODULE := true
643 include $(BUILD_DROIDDOC)
645 # ==== docs for the web (on the devsite app engine server) =======================
646 include $(CLEAR_VARS)
647 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
648 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
649 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
650 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
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)
657 # specify a second html input dir and an output path relative to OUT_DIR)
658 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
662 LOCAL_DROIDDOC_OPTIONS:= \
663 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
665 -hdf android.whichdoc online \
668 -hdf android.hasSamples true \
669 -samplesdir $(samples_dir)
671 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
673 include $(BUILD_DROIDDOC)
675 # ==== docs for the web (on the devsite app engine server) =======================
676 include $(CLEAR_VARS)
677 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
678 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
679 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
680 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
681 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
682 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
683 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
684 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
685 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
686 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
687 # specify a second html input dir and an output path relative to OUT_DIR)
688 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
690 LOCAL_MODULE := ds-static
692 LOCAL_DROIDDOC_OPTIONS:= \
693 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
694 -hdf android.whichdoc online \
700 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
702 include $(BUILD_DROIDDOC)
704 # ==== generates full navtree for resolving @links in ds postprocessing ====
705 include $(CLEAR_VARS)
707 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
708 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
709 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
710 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
711 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
712 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
713 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
714 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
715 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
717 LOCAL_MODULE := ds-ref-navtree
719 LOCAL_DROIDDOC_OPTIONS:= \
720 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
721 -hdf android.whichdoc online \
726 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
728 include $(BUILD_DROIDDOC)
730 # ==== site updates for docs (on the androiddevdocs app engine server) =======================
731 include $(CLEAR_VARS)
733 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
734 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
735 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
736 LOCAL_STATIC_JAVA_LIBRARIES:=$(framework_docs_LOCAL_STATIC_JAVA_LIBRARIES)
737 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
738 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
739 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
740 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
741 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
742 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
743 LOCAL_ADDITIONAL_HTML_DIR:=docs/html-intl /
745 LOCAL_MODULE := online-sdk-dev
747 LOCAL_DROIDDOC_OPTIONS:= \
748 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
750 -hdf android.whichdoc online \
752 -hdf android.hasSamples true \
753 -samplesdir $(samples_dir)
755 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
757 include $(BUILD_DROIDDOC)
759 # ==== docs that have all of the stuff that's @hidden =======================
760 include $(CLEAR_VARS)
762 LOCAL_SRC_FILES:=$(framework_docs_LOCAL_SRC_FILES)
763 LOCAL_GENERATED_SOURCES:=$(framework_docs_LOCAL_GENERATED_SOURCES)
764 LOCAL_SRCJARS:=$(framework_docs_LOCAL_SRCJARS)
765 LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES)
766 LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS)
767 LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH)
768 LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR)
769 LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR)
770 LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES)
772 LOCAL_MODULE := hidden
773 LOCAL_DROIDDOC_OPTIONS:=\
774 $(framework_docs_LOCAL_DROIDDOC_OPTIONS) \
776 -title "Android SDK - Including hidden APIs."
779 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR:=external/doclava/res/assets/templates-sdk
781 include $(BUILD_DROIDDOC)
783 # ==== java proto host library ==============================
784 include $(CLEAR_VARS)
785 LOCAL_MODULE := platformprotos
786 LOCAL_PROTOC_OPTIMIZE_TYPE := full
787 LOCAL_PROTOC_FLAGS := \
788 -Iexternal/protobuf/src
789 LOCAL_SOURCE_FILES_ALL_GENERATED := true
791 cmds/am/proto/instrumentation_data.proto \
792 cmds/statsd/src/perfetto/perfetto_config.proto \
793 $(call all-proto-files-under, core/proto) \
794 $(call all-proto-files-under, libs/incident/proto) \
795 $(call all-proto-files-under, cmds/statsd/src)
797 LOCAL_ERROR_PRONE_FLAGS := -Xep:MissingOverride:OFF
798 include $(BUILD_HOST_JAVA_LIBRARY)
800 # ==== java proto device library (for test only) ==============================
801 include $(CLEAR_VARS)
802 LOCAL_MODULE := platformprotosnano
803 LOCAL_MODULE_TAGS := tests
804 LOCAL_PROTOC_OPTIMIZE_TYPE := nano
805 LOCAL_PROTOC_FLAGS := \
806 -Iexternal/protobuf/src
807 LOCAL_PROTO_JAVA_OUTPUT_PARAMS := \
808 store_unknown_fields = true
809 LOCAL_SDK_VERSION := current
811 $(call all-proto-files-under, core/proto) \
812 $(call all-proto-files-under, libs/incident/proto/android/os)
813 include $(BUILD_STATIC_JAVA_LIBRARY)
816 # ==== java proto device library (for test only) ==============================
817 include $(CLEAR_VARS)
818 LOCAL_MODULE := platformprotoslite
819 LOCAL_MODULE_TAGS := tests
820 LOCAL_PROTOC_OPTIMIZE_TYPE := lite
821 LOCAL_PROTOC_FLAGS := \
822 -Iexternal/protobuf/src
824 $(call all-proto-files-under, core/proto) \
825 $(call all-proto-files-under, libs/incident/proto/android/os)
826 # Protos have lots of MissingOverride and similar.
827 LOCAL_ERROR_PRONE_FLAGS := -XepDisableAllChecks
828 include $(BUILD_STATIC_JAVA_LIBRARY)
830 # ==== hiddenapi lists =======================================
832 # Copy blacklist and light greylist over into the build folder.
833 # This is for ART buildbots which need to mock these lists and have alternative
834 # rules for building them. Other rules in the build system should depend on the
835 # files in the build folder.
837 $(eval $(call copy-one-file,frameworks/base/config/hiddenapi-blacklist.txt,\
838 $(INTERNAL_PLATFORM_HIDDENAPI_BLACKLIST)))
839 $(eval $(call copy-one-file,frameworks/base/config/hiddenapi-light-greylist.txt,\
840 $(INTERNAL_PLATFORM_HIDDENAPI_LIGHT_GREYLIST)))
842 # Generate dark greylist as private API minus (blacklist plus light greylist).
844 $(INTERNAL_PLATFORM_HIDDENAPI_DARK_GREYLIST): PRIVATE_API := $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE)
845 $(INTERNAL_PLATFORM_HIDDENAPI_DARK_GREYLIST): BLACKLIST := $(INTERNAL_PLATFORM_HIDDENAPI_BLACKLIST)
846 $(INTERNAL_PLATFORM_HIDDENAPI_DARK_GREYLIST): LIGHT_GREYLIST := $(INTERNAL_PLATFORM_HIDDENAPI_LIGHT_GREYLIST)
847 $(INTERNAL_PLATFORM_HIDDENAPI_DARK_GREYLIST): $(INTERNAL_PLATFORM_PRIVATE_DEX_API_FILE) \
848 $(INTERNAL_PLATFORM_HIDDENAPI_BLACKLIST) \
849 $(INTERNAL_PLATFORM_HIDDENAPI_LIGHT_GREYLIST)
850 if [ ! -z "`comm -12 <(sort $(BLACKLIST)) <(sort $(LIGHT_GREYLIST))`" ]; then \
851 echo "There should be no overlap between $(BLACKLIST) and $(LIGHT_GREYLIST)" 1>&2; \
853 elif [ ! -z "`comm -13 <(sort $(PRIVATE_API)) <(sort $(BLACKLIST))`" ]; then \
854 echo "$(BLACKLIST) must be a subset of $(PRIVATE_API)" 1>&2; \
856 elif [ ! -z "`comm -13 <(sort $(PRIVATE_API)) <(sort $(LIGHT_GREYLIST))`" ]; then \
857 echo "$(LIGHT_GREYLIST) must be a subset of $(PRIVATE_API)" 1>&2; \
860 comm -23 <(sort $(PRIVATE_API)) <(sort $(BLACKLIST) $(LIGHT_GREYLIST)) > $@
862 # Include subdirectory makefiles
863 # ============================================================
865 # If we're building with ONE_SHOT_MAKEFILE (mm, mmm), then what the framework
866 # team really wants is to build the stuff defined by this makefile.
867 ifeq (,$(ONE_SHOT_MAKEFILE))
868 include $(call first-makefiles-under,$(LOCAL_PATH))
871 endif # ANDROID_BUILD_EMBEDDED