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.
19 ## Common to both droiddoc and javadoc
23 LOCAL_IS_HOST_MODULE := $(call true-or-empty,$(LOCAL_IS_HOST_MODULE))
24 ifeq ($(LOCAL_IS_HOST_MODULE),true)
31 LOCAL_MODULE_CLASS := $(strip $(LOCAL_MODULE_CLASS))
32 ifndef LOCAL_MODULE_CLASS
33 $(error $(LOCAL_PATH): LOCAL_MODULE_CLASS not defined)
36 full_src_files := $(patsubst %,$(LOCAL_PATH)/%,$(LOCAL_SRC_FILES))
37 out_dir := $(OUT_DOCS)/$(LOCAL_MODULE)
38 full_target := $(call doc-timestamp-for,$(LOCAL_MODULE))
40 ifeq ($(LOCAL_DROIDDOC_SOURCE_PATH),)
41 LOCAL_DROIDDOC_SOURCE_PATH := $(LOCAL_PATH)
44 ifeq ($(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR),)
45 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR := $(SRC_DROIDDOC_DIR)/$(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR)
48 ifeq ($(LOCAL_DROIDDOC_ASSET_DIR),)
49 LOCAL_DROIDDOC_ASSET_DIR := assets
51 ifeq ($(LOCAL_DROIDDOC_CUSTOM_ASSET_DIR),)
52 LOCAL_DROIDDOC_CUSTOM_ASSET_DIR := assets
55 ifeq ($(LOCAL_IS_HOST_MODULE),true)
56 $(full_target): PRIVATE_BOOTCLASSPATH :=
57 full_java_libs := $(addprefix $(HOST_OUT_JAVA_LIBRARIES)/,\
58 $(addsuffix $(COMMON_JAVA_PACKAGE_SUFFIX),$(LOCAL_JAVA_LIBRARIES)))
59 full_java_lib_deps := $(full_java_libs)
63 ifneq ($(LOCAL_SDK_VERSION),)
64 ifeq ($(LOCAL_SDK_VERSION)$(TARGET_BUILD_APPS),current)
65 # Use android_stubs_current if LOCAL_SDK_VERSION is current and no TARGET_BUILD_APPS.
66 LOCAL_JAVA_LIBRARIES := android_stubs_current $(LOCAL_JAVA_LIBRARIES)
67 $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, android_stubs_current)
68 else ifeq ($(LOCAL_SDK_VERSION)$(TARGET_BUILD_APPS),system_current)
69 LOCAL_JAVA_LIBRARIES := android_system_stubs_current $(LOCAL_JAVA_LIBRARIES)
70 $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, android_system_stubs_current)
71 else ifeq ($(LOCAL_SDK_VERSION)$(TARGET_BUILD_APPS),test_current)
72 LOCAL_JAVA_LIBRARIES := android_test_stubs_current $(LOCAL_JAVA_LIBRARIES)
73 $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, android_test_stubs_current)
75 LOCAL_JAVA_LIBRARIES := sdk_v$(LOCAL_SDK_VERSION) $(LOCAL_JAVA_LIBRARIES)
76 $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, sdk_v$(LOCAL_SDK_VERSION))
79 LOCAL_JAVA_LIBRARIES := core-oj core-libart ext framework $(LOCAL_JAVA_LIBRARIES)
80 $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, core-oj):$(call java-lib-files, core-libart)
81 endif # LOCAL_SDK_VERSION
82 LOCAL_JAVA_LIBRARIES := $(sort $(LOCAL_JAVA_LIBRARIES))
84 full_java_libs := $(call java-lib-files,$(LOCAL_JAVA_LIBRARIES)) $(LOCAL_CLASSPATH)
85 full_java_lib_deps := $(call java-lib-deps,$(LOCAL_JAVA_LIBRARIES)) $(LOCAL_CLASSPATH)
86 endif # !LOCAL_IS_HOST_MODULE
88 $(full_target): PRIVATE_CLASSPATH := $(subst $(space),:,$(full_java_libs))
91 intermediates.COMMON := $(call local-intermediates-dir,COMMON)
93 $(full_target): PRIVATE_SOURCE_PATH := $(call normalize-path-list,$(LOCAL_DROIDDOC_SOURCE_PATH))
94 $(full_target): PRIVATE_JAVA_FILES := $(filter %.java,$(full_src_files))
95 $(full_target): PRIVATE_JAVA_FILES += $(addprefix $($(my_prefix)OUT_COMMON_INTERMEDIATES)/, $(filter %.java,$(LOCAL_INTERMEDIATE_SOURCES)))
96 $(full_target): PRIVATE_SOURCE_INTERMEDIATES_DIR := $(intermediates.COMMON)/src
97 $(full_target): PRIVATE_SRC_LIST_FILE := $(intermediates.COMMON)/droiddoc-src-list
99 ifneq ($(strip $(LOCAL_ADDITIONAL_JAVA_DIR)),)
100 $(full_target): PRIVATE_ADDITIONAL_JAVA_DIR := $(LOCAL_ADDITIONAL_JAVA_DIR)
103 $(full_target): PRIVATE_OUT_DIR := $(out_dir)
104 $(full_target): PRIVATE_DROIDDOC_OPTIONS := $(LOCAL_DROIDDOC_OPTIONS)
105 $(full_target): PRIVATE_STUB_OUT_DIR := $(LOCAL_DROIDDOC_STUB_OUT_DIR)
107 # Lists the input files for the doc build into a text file
108 # suitable for the @ syntax of javadoc.
109 # $(1): the file to create
110 # $(2): files to include
111 # $(3): list of directories to search for java files in
112 define prepare-doc-source-list
113 $(hide) mkdir -p $(dir $(1))
114 $(call dump-words-to-file, $(2), $(1))
115 $(hide) for d in $(3) ; do find $$d -name '*.java' -and -not -name '.*' >> $(1) 2> /dev/null ; done ; true
119 $(full_target): PRIVATE_PROFILING_OPTIONS := \
120 -J-agentlib:jprofilerti=port=8849 -J-Xbootclasspath/a:/Applications/jprofiler5/bin/agent.jar
124 ifneq ($(strip $(LOCAL_DROIDDOC_USE_STANDARD_DOCLET)),true)
131 droiddoc_templates := \
132 $(sort $(shell find $(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR) -type f))
135 $(HOST_JDK_TOOLS_JAR) \
136 $(HOST_OUT_JAVA_LIBRARIES)/doclava$(COMMON_JAVA_PACKAGE_SUFFIX)
138 $(full_target): PRIVATE_DOCLETPATH := $(HOST_OUT_JAVA_LIBRARIES)/jsilver$(COMMON_JAVA_PACKAGE_SUFFIX):$(HOST_OUT_JAVA_LIBRARIES)/doclava$(COMMON_JAVA_PACKAGE_SUFFIX)
139 $(full_target): PRIVATE_CURRENT_BUILD := -hdf page.build $(BUILD_ID)-$(BUILD_NUMBER_FROM_FILE)
140 $(full_target): PRIVATE_CURRENT_TIME := -hdf page.now "$$($(DATE_FROM_FILE) "+%d %b %Y %k:%M")"
141 $(full_target): PRIVATE_CUSTOM_TEMPLATE_DIR := $(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR)
142 $(full_target): PRIVATE_IN_CUSTOM_ASSET_DIR := $(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR)/$(LOCAL_DROIDDOC_CUSTOM_ASSET_DIR)
143 $(full_target): PRIVATE_OUT_ASSET_DIR := $(out_dir)/$(LOCAL_DROIDDOC_ASSET_DIR)
144 $(full_target): PRIVATE_OUT_CUSTOM_ASSET_DIR := $(out_dir)/$(LOCAL_DROIDDOC_CUSTOM_ASSET_DIR)
147 ifneq ($(strip $(LOCAL_DROIDDOC_HTML_DIR)),)
148 $(full_target): PRIVATE_DROIDDOC_HTML_DIR := -htmldir $(LOCAL_PATH)/$(LOCAL_DROIDDOC_HTML_DIR)
149 html_dir_files := $(sort $(shell find $(LOCAL_PATH)/$(LOCAL_DROIDDOC_HTML_DIR) -type f))
151 $(full_target): PRIVATE_DROIDDOC_HTML_DIR :=
153 ifneq ($(strip $(LOCAL_ADDITIONAL_HTML_DIR)),)
154 $(full_target): PRIVATE_ADDITIONAL_HTML_DIR := -htmldir2 $(LOCAL_PATH)/$(LOCAL_ADDITIONAL_HTML_DIR)
156 $(full_target): PRIVATE_ADDITIONAL_HTML_DIR :=
159 # TODO: not clear if this is used any more
160 $(full_target): PRIVATE_LOCAL_PATH := $(LOCAL_PATH)
164 $(droiddoc_templates) \
167 $(full_java_lib_deps) \
168 $(LOCAL_MODULE_MAKEFILE_DEP) \
169 $(LOCAL_ADDITIONAL_DEPENDENCIES)
170 @echo Docs droiddoc: $(PRIVATE_OUT_DIR)
171 $(hide) mkdir -p $(dir $@)
172 $(addprefix $(hide) rm -rf ,$(PRIVATE_STUB_OUT_DIR))
173 $(call prepare-doc-source-list,$(PRIVATE_SRC_LIST_FILE),$(PRIVATE_JAVA_FILES), \
174 $(PRIVATE_SOURCE_INTERMEDIATES_DIR) $(PRIVATE_ADDITIONAL_JAVA_DIR))
178 \@$(PRIVATE_SRC_LIST_FILE) \
180 -XDignore.symbol.file \
181 $(PRIVATE_PROFILING_OPTIONS) \
183 -doclet com.google.doclava.Doclava \
184 -docletpath $(PRIVATE_DOCLETPATH) \
185 -templatedir $(PRIVATE_CUSTOM_TEMPLATE_DIR) \
186 $(PRIVATE_DROIDDOC_HTML_DIR) \
187 $(PRIVATE_ADDITIONAL_HTML_DIR) \
188 $(addprefix -bootclasspath ,$(PRIVATE_BOOTCLASSPATH)) \
189 $(addprefix -classpath ,$(PRIVATE_CLASSPATH)) \
190 -sourcepath $(PRIVATE_SOURCE_PATH)$(addprefix :,$(PRIVATE_CLASSPATH)) \
191 -d $(PRIVATE_OUT_DIR) \
192 $(PRIVATE_CURRENT_BUILD) $(PRIVATE_CURRENT_TIME) \
193 $(PRIVATE_DROIDDOC_OPTIONS) \
194 $(addprefix -stubs ,$(PRIVATE_STUB_OUT_DIR)) \
196 ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)
203 ## standard doclet only
206 $(full_target): $(full_src_files) $(full_java_lib_deps)
207 @echo Docs javadoc: $(PRIVATE_OUT_DIR)
209 $(call prepare-doc-source-list,$(PRIVATE_SRC_LIST_FILE),$(PRIVATE_JAVA_FILES), \
210 $(PRIVATE_SOURCE_INTERMEDIATES_DIR) $(PRIVATE_ADDITIONAL_JAVA_DIR))
214 $(PRIVATE_DROIDDOC_OPTIONS) \
215 \@$(PRIVATE_SRC_LIST_FILE) \
217 -XDignore.symbol.file \
218 $(if $(LEGACY_USE_JAVA7),,-Xdoclint:none) \
219 $(PRIVATE_PROFILING_OPTIONS) \
220 $(addprefix -classpath ,$(PRIVATE_CLASSPATH)) \
221 $(addprefix -bootclasspath ,$(PRIVATE_BOOTCLASSPATH)) \
222 -sourcepath $(PRIVATE_SOURCE_PATH)$(addprefix :,$(PRIVATE_CLASSPATH)) \
223 -d $(PRIVATE_OUT_DIR) \
226 ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)
232 ## Common to both droiddoc and javadoc
237 ALL_DOCS += $(full_target)
239 .PHONY: $(LOCAL_MODULE)-docs
240 $(LOCAL_MODULE)-docs : $(full_target)
242 ifeq ($(strip $(LOCAL_UNINSTALLABLE_MODULE)),)
244 # Define a rule to create a zip of these docs.
245 out_zip := $(OUT_DOCS)/$(LOCAL_MODULE)-docs.zip
246 $(out_zip): PRIVATE_DOCS_DIR := $(out_dir)
247 $(out_zip): $(full_target)
248 @echo Package docs: $@
251 $(hide) ( F=$$(pwd)/$@ ; cd $(PRIVATE_DOCS_DIR) && zip -rqX $$F * )
253 $(LOCAL_MODULE)-docs.zip : $(out_zip)
255 $(call dist-for-goals,docs,$(out_zip))