1 # 2 # Copyright (C) 2008 The Android Open Source Project 3 # 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 7 # 8 # http://www.apache.org/licenses/LICENSE-2.0 9 # 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. 15 # 16 17 ## 18 ## 19 ## Common to both droiddoc and javadoc 20 ## 21 ## 22 23 LOCAL_IS_HOST_MODULE := $(call true-or-empty,$(LOCAL_IS_HOST_MODULE)) 24 ifeq ($(LOCAL_IS_HOST_MODULE),true) 25 my_prefix := HOST_ 26 else 27 my_prefix := TARGET_ 28 endif 29 30 LOCAL_MODULE_CLASS := $(strip $(LOCAL_MODULE_CLASS)) 31 ifndef LOCAL_MODULE_CLASS 32 $(error $(LOCAL_PATH): LOCAL_MODULE_CLASS not defined) 33 endif 34 35 full_src_files := $(patsubst %,$(LOCAL_PATH)/%,$(LOCAL_SRC_FILES)) 36 out_dir := $(OUT_DOCS)/$(LOCAL_MODULE) 37 full_target := $(call doc-timestamp-for,$(LOCAL_MODULE)) 38 39 ifeq ($(LOCAL_DROIDDOC_SOURCE_PATH),) 40 LOCAL_DROIDDOC_SOURCE_PATH := $(LOCAL_PATH) 41 endif 42 43 ifeq ($(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR),) 44 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR := $(SRC_DROIDDOC_DIR)/$(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR) 45 endif 46 47 ifeq ($(LOCAL_DROIDDOC_ASSET_DIR),) 48 LOCAL_DROIDDOC_ASSET_DIR := assets 49 endif 50 ifeq ($(LOCAL_DROIDDOC_CUSTOM_ASSET_DIR),) 51 LOCAL_DROIDDOC_CUSTOM_ASSET_DIR := assets 52 endif 53 54 55 $(full_target): PRIVATE_BOOTCLASSPATH := 56 ifeq ($(BUILD_OS),linux) 57 # You have to set bootclasspath for javadoc manually on linux since Java 6. 58 host_jdk_rt_jar := $(dir $(HOST_JDK_TOOLS_JAR))../jre/lib/rt.jar 59 $(full_target): PRIVATE_BOOTCLASSPATH := $(host_jdk_rt_jar) 60 endif 61 62 ifneq ($(LOCAL_IS_HOST_MODULE),true) 63 64 ifneq ($(LOCAL_SDK_VERSION),) 65 ifeq ($(LOCAL_SDK_VERSION)$(TARGET_BUILD_APPS),current) 66 # Use android_stubs_current if LOCAL_SDK_VERSION is current and no TARGET_BUILD_APPS. 67 LOCAL_JAVA_LIBRARIES := android_stubs_current $(LOCAL_JAVA_LIBRARIES) 68 else 69 LOCAL_JAVA_LIBRARIES := sdk_v$(LOCAL_SDK_VERSION) $(LOCAL_JAVA_LIBRARIES) 70 endif 71 else 72 LOCAL_JAVA_LIBRARIES := core ext framework framework2 $(LOCAL_JAVA_LIBRARIES) 73 endif # LOCAL_SDK_VERSION 74 LOCAL_JAVA_LIBRARIES := $(sort $(LOCAL_JAVA_LIBRARIES)) 75 76 endif # !LOCAL_IS_HOST_MODULE 77 78 full_java_libs := $(call java-lib-files,$(LOCAL_JAVA_LIBRARIES),$(LOCAL_IS_HOST_MODULE)) $(LOCAL_CLASSPATH) 79 full_java_lib_deps := $(call java-lib-deps,$(LOCAL_JAVA_LIBRARIES),$(LOCAL_IS_HOST_MODULE)) $(LOCAL_CLASSPATH) 80 81 $(full_target): PRIVATE_CLASSPATH := $(subst $(space),:,$(full_java_libs)) 82 83 84 intermediates.COMMON := $(call local-intermediates-dir,COMMON) 85 86 $(full_target): PRIVATE_SOURCE_PATH := $(call normalize-path-list,$(LOCAL_DROIDDOC_SOURCE_PATH)) 87 $(full_target): PRIVATE_JAVA_FILES := $(filter %.java,$(full_src_files)) 88 $(full_target): PRIVATE_JAVA_FILES += $(addprefix $($(my_prefix)OUT_COMMON_INTERMEDIATES)/, $(filter %.java,$(LOCAL_INTERMEDIATE_SOURCES))) 89 $(full_target): PRIVATE_SOURCE_INTERMEDIATES_DIR := $(intermediates.COMMON)/src 90 $(full_target): PRIVATE_SRC_LIST_FILE := $(intermediates.COMMON)/droiddoc-src-list 91 92 ifneq ($(strip $(LOCAL_ADDITIONAL_JAVA_DIR)),) 93 $(full_target): PRIVATE_ADDITIONAL_JAVA_DIR := $(LOCAL_ADDITIONAL_JAVA_DIR) 94 endif 95 96 $(full_target): PRIVATE_OUT_DIR := $(out_dir) 97 $(full_target): PRIVATE_DROIDDOC_OPTIONS := $(LOCAL_DROIDDOC_OPTIONS) 98 99 # Lists the input files for the doc build into a text file 100 # suitable for the @ syntax of javadoc. 101 # $(1): the file to create 102 # $(2): files to include 103 # $(3): list of directories to search for java files in 104 define prepare-doc-source-list 105 $(hide) mkdir -p $(dir $(1)) 106 $(call dump-words-to-file, $(2), $(1)) 107 $(hide) for d in $(3) ; do find $$d -name '*.java' >> $(1) 2> /dev/null ; done ; true 108 endef 109 110 ifeq (a,b) 111 $(full_target): PRIVATE_PROFILING_OPTIONS := \ 112 -J-agentlib:jprofilerti=port=8849 -J-Xbootclasspath/a:/Applications/jprofiler5/bin/agent.jar 113 endif 114 115 116 ifneq ($(strip $(LOCAL_DROIDDOC_USE_STANDARD_DOCLET)),true) 117 ## 118 ## 119 ## droiddoc only 120 ## 121 ## 122 123 droiddoc_templates := \ 124 $(shell find $(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR) -type f) 125 126 droiddoc := \ 127 $(HOST_JDK_TOOLS_JAR) \ 128 $(HOST_OUT_JAVA_LIBRARIES)/doclava$(COMMON_JAVA_PACKAGE_SUFFIX) 129 130 $(full_target): PRIVATE_DOCLETPATH := $(HOST_OUT_JAVA_LIBRARIES)/jsilver$(COMMON_JAVA_PACKAGE_SUFFIX):$(HOST_OUT_JAVA_LIBRARIES)/doclava$(COMMON_JAVA_PACKAGE_SUFFIX) 131 $(full_target): PRIVATE_CURRENT_BUILD := -hdf page.build $(BUILD_ID)-$(BUILD_NUMBER) 132 $(full_target): PRIVATE_CURRENT_TIME := -hdf page.now "$(shell date "+%d %b %Y %k:%M")" 133 $(full_target): PRIVATE_CUSTOM_TEMPLATE_DIR := $(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR) 134 $(full_target): PRIVATE_IN_CUSTOM_ASSET_DIR := $(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR)/$(LOCAL_DROIDDOC_CUSTOM_ASSET_DIR) 135 $(full_target): PRIVATE_OUT_ASSET_DIR := $(out_dir)/$(LOCAL_DROIDDOC_ASSET_DIR) 136 $(full_target): PRIVATE_OUT_CUSTOM_ASSET_DIR := $(out_dir)/$(LOCAL_DROIDDOC_CUSTOM_ASSET_DIR) 137 ifneq ($(strip $(LOCAL_DROIDDOC_HTML_DIR)),) 138 $(full_target): PRIVATE_DROIDDOC_HTML_DIR := -htmldir $(LOCAL_PATH)/$(LOCAL_DROIDDOC_HTML_DIR) 139 else 140 $(full_target): PRIVATE_DROIDDOC_HTML_DIR := 141 endif 142 ifneq ($(strip $(LOCAL_ADDITIONAL_HTML_DIR)),) 143 $(full_target): PRIVATE_ADDITIONAL_HTML_DIR := -htmldir2 $(LOCAL_PATH)/$(LOCAL_ADDITIONAL_HTML_DIR) 144 else 145 $(full_target): PRIVATE_ADDITIONAL_HTML_DIR := 146 endif 147 ifneq ($(strip $(LOCAL_ADDITIONAL_HTML_DIR)),) 148 $(full_target): PRIVATE_ADDITIONAL_HTML_DIR := -htmldir2 $(LOCAL_PATH)/$(LOCAL_ADDITIONAL_HTML_DIR) 149 else 150 $(full_target): PRIVATE_ADDITIONAL_HTML_DIR := 151 endif 152 153 # TODO: not clear if this is used any more 154 $(full_target): PRIVATE_LOCAL_PATH := $(LOCAL_PATH) 155 156 html_dir_files := $(shell find $(LOCAL_PATH)/$(LOCAL_DROIDDOC_HTML_DIR) -type f) 157 158 $(full_target): $(full_src_files) $(droiddoc_templates) $(droiddoc) $(html_dir_files) $(full_java_lib_deps) $(LOCAL_ADDITIONAL_DEPENDENCIES) 159 @echo Docs droiddoc: $(PRIVATE_OUT_DIR) 160 $(hide) mkdir -p $(dir $@) 161 $(call prepare-doc-source-list,$(PRIVATE_SRC_LIST_FILE),$(PRIVATE_JAVA_FILES), \ 162 $(PRIVATE_SOURCE_INTERMEDIATES_DIR) $(PRIVATE_ADDITIONAL_JAVA_DIR)) 163 $(hide) ( \ 164 javadoc \ 165 \@$(PRIVATE_SRC_LIST_FILE) \ 166 -J-Xmx1280m \ 167 $(PRIVATE_PROFILING_OPTIONS) \ 168 -quiet \ 169 -doclet com.google.doclava.Doclava \ 170 -docletpath $(PRIVATE_DOCLETPATH) \ 171 -templatedir $(PRIVATE_CUSTOM_TEMPLATE_DIR) \ 172 $(PRIVATE_DROIDDOC_HTML_DIR) \ 173 $(PRIVATE_ADDITIONAL_HTML_DIR) \ 174 $(addprefix -bootclasspath ,$(PRIVATE_BOOTCLASSPATH)) \ 175 $(addprefix -classpath ,$(PRIVATE_CLASSPATH)) \ 176 -sourcepath $(PRIVATE_SOURCE_PATH)$(addprefix :,$(PRIVATE_CLASSPATH)) \ 177 -d $(PRIVATE_OUT_DIR) \ 178 $(PRIVATE_CURRENT_BUILD) $(PRIVATE_CURRENT_TIME) \ 179 $(PRIVATE_DROIDDOC_OPTIONS) \ 180 && touch -f $@ \ 181 ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45) 182 183 184 185 else 186 ## 187 ## 188 ## standard doclet only 189 ## 190 ## 191 $(full_target): $(full_src_files) $(full_java_lib_deps) 192 @echo Docs javadoc: $(PRIVATE_OUT_DIR) 193 @mkdir -p $(dir $@) 194 $(call prepare-doc-source-list,$(PRIVATE_SRC_LIST_FILE),$(PRIVATE_JAVA_FILES), \ 195 $(PRIVATE_SOURCE_INTERMEDIATES_DIR) $(PRIVATE_ADDITIONAL_JAVA_DIR)) 196 $(hide) ( \ 197 javadoc \ 198 $(PRIVATE_DROIDDOC_OPTIONS) \ 199 \@$(PRIVATE_SRC_LIST_FILE) \ 200 -J-Xmx1024m \ 201 $(PRIVATE_PROFILING_OPTIONS) \ 202 $(addprefix -classpath ,$(PRIVATE_CLASSPATH)) \ 203 -sourcepath $(PRIVATE_SOURCE_PATH)$(addprefix :,$(PRIVATE_CLASSPATH)) \ 204 -d $(PRIVATE_OUT_DIR) \ 205 -quiet \ 206 && touch -f $@ \ 207 ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45) 208 209 210 endif 211 ## 212 ## 213 ## Common to both droiddoc and javadoc 214 ## 215 ## 216 217 218 ALL_DOCS += $(full_target) 219 220 .PHONY: $(LOCAL_MODULE)-docs 221 $(LOCAL_MODULE)-docs : $(full_target) 222 223 ifeq ($(strip $(LOCAL_UNINSTALLABLE_MODULE)),) 224 225 # Define a rule to create a zip of these docs. 226 out_zip := $(OUT_DOCS)/$(LOCAL_MODULE)-docs.zip 227 $(out_zip): PRIVATE_DOCS_DIR := $(out_dir) 228 $(out_zip): $(full_target) 229 @echo Package docs: $@ 230 @rm -f $@ 231 @mkdir -p $(dir $@) 232 $(hide) ( F=$$(pwd)/$@ ; cd $(PRIVATE_DOCS_DIR) && zip -rq $$F * ) 233 234 $(call dist-for-goals,docs,$(out_zip)) 235 236 endif 237
