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