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