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