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