blob: 0b8cd24e0fba08b4a6327a3f91ffa3e116879d9e [file] [log] [blame]
Joe Onorato64d85d02009-04-09 19:31:12 -07001#
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#
The Android Open Source Project88b60792009-03-03 19:28:42 -080016
Joe Onorato64d85d02009-04-09 19:31:12 -070017##
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)
The Android Open Source Project88b60792009-03-03 19:28:42 -080025my_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)
Joe Onorato64d85d02009-04-09 19:31:12 -070037full_target := $(call doc-timestamp-for,$(LOCAL_MODULE))
The Android Open Source Project88b60792009-03-03 19:28:42 -080038
39ifeq ($(LOCAL_DROIDDOC_SOURCE_PATH),)
40LOCAL_DROIDDOC_SOURCE_PATH := $(LOCAL_PATH)
41endif
42
43ifeq ($(LOCAL_DROIDDOC_TEMPLATE_DIR),)
44LOCAL_DROIDDOC_TEMPLATE_DIR := $(SRC_DROIDDOC_DIR)/templates
45endif
46ifeq ($(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR),)
47LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR := $(SRC_DROIDDOC_DIR)/templates
48endif
49
50ifeq ($(LOCAL_DROIDDOC_ASSET_DIR),)
51LOCAL_DROIDDOC_ASSET_DIR := assets
52endif
53ifeq ($(LOCAL_DROIDDOC_CUSTOM_ASSET_DIR),)
54LOCAL_DROIDDOC_CUSTOM_ASSET_DIR := assets
55endif
56
The Android Open Source Project88b60792009-03-03 19:28:42 -080057$(full_target): PRIVATE_CLASSPATH:=$(LOCAL_CLASSPATH)
58full_java_lib_deps :=
59
Ying Wang7b142da2010-06-23 20:59:22 -070060ifeq ($(BUILD_OS),linux)
61# You have to set bootclasspath for javadoc manually on linux since Java 6.
62host_jdk_rt_jar := $(dir $(HOST_JDK_TOOLS_JAR))../jre/lib/rt.jar
63$(full_target): PRIVATE_BOOTCLASSPATH := $(host_jdk_rt_jar)
64endif
65
Joe Onorato64d85d02009-04-09 19:31:12 -070066ifneq ($(LOCAL_IS_HOST_MODULE),true)
The Android Open Source Project88b60792009-03-03 19:28:42 -080067
68ifeq ($(LOCAL_JAVA_LIBRARIES),)
69LOCAL_JAVA_LIBRARIES := core ext framework
70endif
71full_java_libs := $(call java-lib-files,$(LOCAL_JAVA_LIBRARIES),$(LOCAL_IS_HOST_MODULE))
72full_java_lib_deps := $(call java-lib-deps,$(LOCAL_JAVA_LIBRARIES),$(LOCAL_IS_HOST_MODULE))
73
74# we're not going to generate docs from any of these classes, but we need them
75# to build properly.
76ifneq ($(strip $(LOCAL_STATIC_JAVA_LIBRARIES)),)
77full_java_libs += $(addprefix $(LOCAL_PATH)/,$(LOCAL_STATIC_JAVA_LIBRARIES)) $(LOCAL_CLASSPATH)
78full_java_lib_deps += $(addprefix $(LOCAL_PATH)/,$(LOCAL_STATIC_JAVA_LIBRARIES)) $(LOCAL_CLASSPATH)
79endif
80
81empty :=
82space := $(empty) $(empty)
83$(full_target): PRIVATE_CLASSPATH := $(subst $(space),:,$(full_java_libs))
84
85endif # !LOCAL_IS_HOST_MODULE
86
Joe Onorato64d85d02009-04-09 19:31:12 -070087intermediates := $(call local-intermediates-dir)
88
89$(full_target): PRIVATE_SOURCE_PATH := $(call normalize-path-list,$(LOCAL_DROIDDOC_SOURCE_PATH))
The Android Open Source Project88b60792009-03-03 19:28:42 -080090$(full_target): PRIVATE_JAVA_FILES := $(filter %.java,$(full_src_files))
91$(full_target): PRIVATE_JAVA_FILES += $(addprefix $($(my_prefix)OUT_COMMON_INTERMEDIATES)/, $(filter %.java,$(LOCAL_INTERMEDIATE_SOURCES)))
Joe Onorato64d85d02009-04-09 19:31:12 -070092$(full_target): PRIVATE_SOURCE_INTERMEDIATES_DIR := $(intermediates)/src
93$(full_target): PRIVATE_SRC_LIST_FILE := $(intermediates)/droiddoc-src-list
94
95ifneq ($(strip $(LOCAL_ADDITIONAL_JAVA_DIR)),)
96$(full_target): PRIVATE_ADDITIONAL_JAVA_DIR := $(LOCAL_ADDITIONAL_JAVA_DIR)
97endif
98
The Android Open Source Project88b60792009-03-03 19:28:42 -080099$(full_target): PRIVATE_OUT_DIR := $(out_dir)
100$(full_target): PRIVATE_DROIDDOC_OPTIONS := $(LOCAL_DROIDDOC_OPTIONS)
Joe Onorato64d85d02009-04-09 19:31:12 -0700101
102# Lists the input files for the doc build into a text file
103# suitable for the @ syntax of javadoc.
104# $(1): the file to create
105# $(2): files to include
106# $(3): list of directories to search for java files in
107define prepare-doc-source-list
108$(hide) mkdir -p $(dir $(1))
Joe Onorato64d85d02009-04-09 19:31:12 -0700109$(call dump-words-to-file, $(2), $(1))
110$(hide) for d in $(3) ; do find $$d -name '*.java' >> $(1) 2> /dev/null ; done ; true
111endef
112
113ifeq (a,b)
114$(full_target): PRIVATE_PROFILING_OPTIONS := \
115 -J-agentlib:jprofilerti=port=8849 -J-Xbootclasspath/a:/Applications/jprofiler5/bin/agent.jar
116endif
117
118
119ifneq ($(strip $(LOCAL_DROIDDOC_USE_STANDARD_DOCLET)),true)
120##
121##
122## droiddoc only
123##
124##
125
126droiddoc_templates := \
127 $(shell find $(LOCAL_DROIDDOC_TEMPLATE_DIR) -type f) \
128 $(shell find $(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR) -type f)
129
130droiddoc := \
131 $(HOST_JDK_TOOLS_JAR) \
132 $(HOST_OUT_JAVA_LIBRARIES)/droiddoc$(COMMON_JAVA_PACKAGE_SUFFIX) \
133 $(HOST_OUT_JAVA_LIBRARIES)/clearsilver$(COMMON_JAVA_PACKAGE_SUFFIX) \
134 $(HOST_OUT_SHARED_LIBRARIES)/libclearsilver-jni$(HOST_JNILIB_SUFFIX)
135
Jesse Wilson289d80e2009-07-21 14:02:14 -0700136$(full_target): PRIVATE_DOCLETPATH := $(HOST_OUT_JAVA_LIBRARIES)/clearsilver$(COMMON_JAVA_PACKAGE_SUFFIX):$(HOST_OUT_JAVA_LIBRARIES)/droiddoc$(COMMON_JAVA_PACKAGE_SUFFIX):$(HOST_OUT_JAVA_LIBRARIES)/apicheck$(COMMON_JAVA_PACKAGE_SUFFIX)
Joe Onorato64d85d02009-04-09 19:31:12 -0700137$(full_target): PRIVATE_CURRENT_BUILD := -hdf page.build $(BUILD_ID)-$(BUILD_NUMBER)
138$(full_target): PRIVATE_CURRENT_TIME := -hdf page.now "$(shell date "+%d %b %Y %k:%M")"
The Android Open Source Project88b60792009-03-03 19:28:42 -0800139$(full_target): PRIVATE_TEMPLATE_DIR := $(LOCAL_DROIDDOC_TEMPLATE_DIR)
140$(full_target): PRIVATE_CUSTOM_TEMPLATE_DIR := $(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR)
141$(full_target): PRIVATE_IN_ASSET_DIR := $(LOCAL_DROIDDOC_TEMPLATE_DIR)/$(LOCAL_DROIDDOC_ASSET_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)
145ifneq ($(strip $(LOCAL_DROIDDOC_HTML_DIR)),)
146$(full_target): PRIVATE_DROIDDOC_HTML_DIR := -htmldir $(LOCAL_PATH)/$(LOCAL_DROIDDOC_HTML_DIR)
147else
148$(full_target): PRIVATE_DROIDDOC_HTML_DIR :=
149endif
The Android Open Source Project88b60792009-03-03 19:28:42 -0800150
Joe Onorato64d85d02009-04-09 19:31:12 -0700151# TODO: not clear if this is used any more
152$(full_target): PRIVATE_LOCAL_PATH := $(LOCAL_PATH)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800153
154html_dir_files := $(shell find $(LOCAL_PATH)/$(LOCAL_DROIDDOC_HTML_DIR) -type f)
155
The Android Open Source Project88b60792009-03-03 19:28:42 -0800156$(full_target): $(full_src_files) $(droiddoc_templates) $(droiddoc) $(html_dir_files) $(full_java_lib_deps)
157 @echo Docs droiddoc: $(PRIVATE_OUT_DIR)
Joe Onorato64d85d02009-04-09 19:31:12 -0700158 $(hide) mkdir -p $(dir $(full_target))
159 $(call prepare-doc-source-list,$(PRIVATE_SRC_LIST_FILE),$(PRIVATE_JAVA_FILES), \
160 $(PRIVATE_SOURCE_INTERMEDIATES_DIR) $(PRIVATE_ADDITIONAL_JAVA_DIR))
The Android Open Source Project88b60792009-03-03 19:28:42 -0800161 $(hide) ( \
Joe Onorato64d85d02009-04-09 19:31:12 -0700162 LD_LIBRARY_PATH=$(HOST_OUT_SHARED_LIBRARIES) \
163 javadoc \
The Android Open Source Project88b60792009-03-03 19:28:42 -0800164 \@$(PRIVATE_SRC_LIST_FILE) \
165 -J-Xmx768m \
166 -J-Djava.library.path=$(HOST_OUT_SHARED_LIBRARIES) \
167 $(PRIVATE_PROFILING_OPTIONS) \
168 -quiet \
169 -doclet DroidDoc \
170 -docletpath $(PRIVATE_DOCLETPATH) \
171 -templatedir $(PRIVATE_CUSTOM_TEMPLATE_DIR) \
172 -templatedir $(PRIVATE_TEMPLATE_DIR) \
173 $(PRIVATE_DROIDDOC_HTML_DIR) \
Ying Wang7b142da2010-06-23 20:59:22 -0700174 $(addprefix -bootclasspath ,$(PRIVATE_BOOTCLASSPATH)) \
The Android Open Source Project88b60792009-03-03 19:28:42 -0800175 $(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 && rm -rf $(PRIVATE_OUT_ASSET_DIR) \
181 && rm -rf $(PRIVATE_OUT_CUSTOM_ASSET_DIR) \
182 && mkdir -p $(PRIVATE_OUT_ASSET_DIR) \
183 && mkdir -p $(PRIVATE_OUT_CUSTOM_ASSET_DIR) \
184 && cp -fr $(PRIVATE_IN_ASSET_DIR)/* $(PRIVATE_OUT_ASSET_DIR)/ \
185 && cp -fr $(PRIVATE_IN_CUSTOM_ASSET_DIR)/* $(PRIVATE_OUT_CUSTOM_ASSET_DIR)/ \
186 && touch -f $@ \
187 ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)
188
Joe Onorato64d85d02009-04-09 19:31:12 -0700189
190
191else
192##
193##
194## standard doclet only
195##
196##
197$(full_target): $(full_src_files) $(full_java_lib_deps)
198 @echo Docs javadoc: $(PRIVATE_OUT_DIR)
199 @mkdir -p $(dir $(full_target))
200 $(call prepare-doc-source-list,$(PRIVATE_SRC_LIST_FILE),$(PRIVATE_JAVA_FILES), \
201 $(PRIVATE_SOURCE_INTERMEDIATES_DIR) $(PRIVATE_ADDITIONAL_JAVA_DIR))
202 $(hide) ( \
203 javadoc \
204 $(PRIVATE_DROIDDOC_OPTIONS) \
205 \@$(PRIVATE_SRC_LIST_FILE) \
206 -J-Xmx768m \
207 $(PRIVATE_PROFILING_OPTIONS) \
208 $(addprefix -classpath ,$(PRIVATE_CLASSPATH)) \
209 -sourcepath $(PRIVATE_SOURCE_PATH)$(addprefix :,$(PRIVATE_CLASSPATH)) \
210 -d $(PRIVATE_OUT_DIR) \
211 -quiet \
212 && touch -f $@ \
213 ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)
214
215
216endif
217##
218##
219## Common to both droiddoc and javadoc
220##
221##
222
223
The Android Open Source Project88b60792009-03-03 19:28:42 -0800224ALL_DOCS += $(full_target)
225
226.PHONY: $(LOCAL_MODULE)-docs
227$(LOCAL_MODULE)-docs : $(full_target)
228
229# Define a rule to create a zip of these docs.
230out_zip := $(OUT_DOCS)/$(LOCAL_MODULE)-docs.zip
231$(out_zip): PRIVATE_DOCS_DIR := $(out_dir)
232$(out_zip): $(full_target)
233 @echo Package docs: $@
234 @rm -f $@
235 @mkdir -p $(dir $@)
236 $(hide) ( F=$$(pwd)/$@ ; cd $(PRIVATE_DOCS_DIR) && zip -rq $$F * )
237
238$(call dist-for-goals,docs,$(out_zip))