droiddoc.mk revision ee89f219ea8298c3b4718ae0dd05061ce372b384 
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_
26LOCAL_HOST_PREFIX :=
27else
28my_prefix := TARGET_
29endif
30
31LOCAL_MODULE_CLASS := $(strip $(LOCAL_MODULE_CLASS))
32ifndef LOCAL_MODULE_CLASS
33$(error $(LOCAL_PATH): LOCAL_MODULE_CLASS not defined)
34endif
35
36full_src_files := $(patsubst %,$(LOCAL_PATH)/%,$(LOCAL_SRC_FILES))
37out_dir := $(OUT_DOCS)/$(LOCAL_MODULE)
38full_target := $(call doc-timestamp-for,$(LOCAL_MODULE))
39
40ifeq ($(LOCAL_DROIDDOC_SOURCE_PATH),)
41LOCAL_DROIDDOC_SOURCE_PATH := $(LOCAL_PATH)
42endif
43
44ifeq ($(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR),)
45LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR := $(SRC_DROIDDOC_DIR)/$(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR)
46endif
47
48ifeq ($(LOCAL_DROIDDOC_ASSET_DIR),)
49LOCAL_DROIDDOC_ASSET_DIR := assets
50endif
51ifeq ($(LOCAL_DROIDDOC_CUSTOM_ASSET_DIR),)
52LOCAL_DROIDDOC_CUSTOM_ASSET_DIR := assets
53endif
54
55ifeq ($(LOCAL_IS_HOST_MODULE),true)
56$(full_target): PRIVATE_BOOTCLASSPATH :=
57full_java_libs := $(addprefix $(HOST_OUT_JAVA_LIBRARIES)/,\
58  $(addsuffix $(COMMON_JAVA_PACKAGE_SUFFIX),$(LOCAL_JAVA_LIBRARIES)))
59full_java_lib_deps := $(full_java_libs)
60
61else
62
63ifneq ($(LOCAL_SDK_VERSION),)
64  ifeq ($(LOCAL_SDK_VERSION)$(TARGET_BUILD_APPS),current)
65    # Use android_stubs_current if LOCAL_SDK_VERSION is current and no TARGET_BUILD_APPS.
66    LOCAL_JAVA_LIBRARIES := android_stubs_current $(LOCAL_JAVA_LIBRARIES)
67    $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, android_stubs_current)
68  else ifeq ($(LOCAL_SDK_VERSION)$(TARGET_BUILD_APPS),system_current)
69    LOCAL_JAVA_LIBRARIES := android_system_stubs_current $(LOCAL_JAVA_LIBRARIES)
70    $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, android_system_stubs_current)
71  else ifeq ($(LOCAL_SDK_VERSION)$(TARGET_BUILD_APPS),test_current)
72    LOCAL_JAVA_LIBRARIES := android_test_stubs_current $(LOCAL_JAVA_LIBRARIES)
73    $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, android_test_stubs_current)
74  else
75    LOCAL_JAVA_LIBRARIES := sdk_v$(LOCAL_SDK_VERSION) $(LOCAL_JAVA_LIBRARIES)
76    $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, sdk_v$(LOCAL_SDK_VERSION))
77  endif
78else
79  LOCAL_JAVA_LIBRARIES := core-oj core-libart ext framework $(LOCAL_JAVA_LIBRARIES)
80  $(full_target): PRIVATE_BOOTCLASSPATH := $(call java-lib-files, core-oj):$(call java-lib-files, core-libart)
81endif  # LOCAL_SDK_VERSION
82LOCAL_JAVA_LIBRARIES := $(sort $(LOCAL_JAVA_LIBRARIES))
83
84full_java_libs := $(call java-lib-files,$(LOCAL_JAVA_LIBRARIES)) $(LOCAL_CLASSPATH)
85full_java_lib_deps := $(call java-lib-deps,$(LOCAL_JAVA_LIBRARIES)) $(LOCAL_CLASSPATH)
86endif # !LOCAL_IS_HOST_MODULE
87
88$(full_target): PRIVATE_CLASSPATH := $(subst $(space),:,$(full_java_libs))
89
90
91intermediates.COMMON := $(call local-intermediates-dir,COMMON)
92
93$(full_target): PRIVATE_SOURCE_PATH := $(call normalize-path-list,$(LOCAL_DROIDDOC_SOURCE_PATH))
94$(full_target): PRIVATE_JAVA_FILES := $(filter %.java,$(full_src_files))
95$(full_target): PRIVATE_JAVA_FILES += $(addprefix $($(my_prefix)OUT_COMMON_INTERMEDIATES)/, $(filter %.java,$(LOCAL_INTERMEDIATE_SOURCES)))
96$(full_target): PRIVATE_SOURCE_INTERMEDIATES_DIR := $(intermediates.COMMON)/src
97$(full_target): PRIVATE_SRC_LIST_FILE := $(intermediates.COMMON)/droiddoc-src-list
98
99ifneq ($(strip $(LOCAL_ADDITIONAL_JAVA_DIR)),)
100$(full_target): PRIVATE_ADDITIONAL_JAVA_DIR := $(LOCAL_ADDITIONAL_JAVA_DIR)
101endif
102
103$(full_target): PRIVATE_OUT_DIR := $(out_dir)
104$(full_target): PRIVATE_DROIDDOC_OPTIONS := $(LOCAL_DROIDDOC_OPTIONS)
105$(full_target): PRIVATE_STUB_OUT_DIR := $(LOCAL_DROIDDOC_STUB_OUT_DIR)
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' -and -not -name '.*' >> $(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    $(sort $(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_FROM_FILE)
140$(full_target): PRIVATE_CURRENT_TIME :=  -hdf page.now "$$($(DATE_FROM_FILE) "+%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)
145
146html_dir_files :=
147ifneq ($(strip $(LOCAL_DROIDDOC_HTML_DIR)),)
148$(full_target): PRIVATE_DROIDDOC_HTML_DIR := -htmldir $(LOCAL_PATH)/$(LOCAL_DROIDDOC_HTML_DIR)
149html_dir_files := $(sort $(shell find $(LOCAL_PATH)/$(LOCAL_DROIDDOC_HTML_DIR) -type f))
150else
151$(full_target): PRIVATE_DROIDDOC_HTML_DIR :=
152endif
153ifneq ($(strip $(LOCAL_ADDITIONAL_HTML_DIR)),)
154$(full_target): PRIVATE_ADDITIONAL_HTML_DIR := -htmldir2 $(LOCAL_PATH)/$(LOCAL_ADDITIONAL_HTML_DIR)
155else
156$(full_target): PRIVATE_ADDITIONAL_HTML_DIR :=
157endif
158
159# TODO: not clear if this is used any more
160$(full_target): PRIVATE_LOCAL_PATH := $(LOCAL_PATH)
161
162$(full_target): \
163        $(full_src_files) \
164        $(droiddoc_templates) \
165        $(droiddoc) \
166        $(html_dir_files) \
167        $(full_java_lib_deps) \
168        $(LOCAL_MODULE_MAKEFILE_DEP) \
169        $(LOCAL_ADDITIONAL_DEPENDENCIES)
170	@echo Docs droiddoc: $(PRIVATE_OUT_DIR)
171	$(hide) mkdir -p $(dir $@)
172	$(addprefix $(hide) rm -rf ,$(PRIVATE_STUB_OUT_DIR))
173	$(call prepare-doc-source-list,$(PRIVATE_SRC_LIST_FILE),$(PRIVATE_JAVA_FILES), \
174			$(PRIVATE_SOURCE_INTERMEDIATES_DIR) $(PRIVATE_ADDITIONAL_JAVA_DIR))
175	$(hide) ( \
176		javadoc \
177                -encoding UTF-8 \
178                \@$(PRIVATE_SRC_LIST_FILE) \
179                -J-Xmx1600m \
180                -XDignore.symbol.file \
181                $(PRIVATE_PROFILING_OPTIONS) \
182                -quiet \
183                -doclet com.google.doclava.Doclava \
184                -docletpath $(PRIVATE_DOCLETPATH) \
185                -templatedir $(PRIVATE_CUSTOM_TEMPLATE_DIR) \
186                $(PRIVATE_DROIDDOC_HTML_DIR) \
187                $(PRIVATE_ADDITIONAL_HTML_DIR) \
188                $(addprefix -bootclasspath ,$(PRIVATE_BOOTCLASSPATH)) \
189                $(addprefix -classpath ,$(PRIVATE_CLASSPATH)) \
190                -sourcepath $(PRIVATE_SOURCE_PATH)$(addprefix :,$(PRIVATE_CLASSPATH)) \
191                -d $(PRIVATE_OUT_DIR) \
192                $(PRIVATE_CURRENT_BUILD) $(PRIVATE_CURRENT_TIME) \
193                $(PRIVATE_DROIDDOC_OPTIONS) \
194                $(addprefix -stubs ,$(PRIVATE_STUB_OUT_DIR)) \
195        && touch -f $@ \
196    ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)
197
198
199
200else
201##
202##
203## standard doclet only
204##
205##
206$(full_target): $(full_src_files) $(full_java_lib_deps)
207	@echo Docs javadoc: $(PRIVATE_OUT_DIR)
208	@mkdir -p $(dir $@)
209	$(call prepare-doc-source-list,$(PRIVATE_SRC_LIST_FILE),$(PRIVATE_JAVA_FILES), \
210			$(PRIVATE_SOURCE_INTERMEDIATES_DIR) $(PRIVATE_ADDITIONAL_JAVA_DIR))
211	$(hide) ( \
212		javadoc \
213                -encoding UTF-8 \
214                $(PRIVATE_DROIDDOC_OPTIONS) \
215                \@$(PRIVATE_SRC_LIST_FILE) \
216                -J-Xmx1024m \
217                -XDignore.symbol.file \
218                $(if $(EXPERIMENTAL_USE_JAVA8),-Xdoclint:none) \
219                $(PRIVATE_PROFILING_OPTIONS) \
220                $(addprefix -classpath ,$(PRIVATE_CLASSPATH)) \
221                $(addprefix -bootclasspath ,$(PRIVATE_BOOTCLASSPATH)) \
222                -sourcepath $(PRIVATE_SOURCE_PATH)$(addprefix :,$(PRIVATE_CLASSPATH)) \
223                -d $(PRIVATE_OUT_DIR) \
224                -quiet \
225        && touch -f $@ \
226    ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)
227
228
229endif
230##
231##
232## Common to both droiddoc and javadoc
233##
234##
235
236
237ALL_DOCS += $(full_target)
238
239.PHONY: $(LOCAL_MODULE)-docs
240$(LOCAL_MODULE)-docs : $(full_target)
241
242ifeq ($(strip $(LOCAL_UNINSTALLABLE_MODULE)),)
243
244# Define a rule to create a zip of these docs.
245out_zip := $(OUT_DOCS)/$(LOCAL_MODULE)-docs.zip
246$(out_zip): PRIVATE_DOCS_DIR := $(out_dir)
247$(out_zip): $(full_target)
248	@echo Package docs: $@
249	@rm -f $@
250	@mkdir -p $(dir $@)
251	$(hide) ( F=$$(pwd)/$@ ; cd $(PRIVATE_DOCS_DIR) && zip -rqX $$F * )
252
253$(LOCAL_MODULE)-docs.zip : $(out_zip)
254
255$(call dist-for-goals,docs,$(out_zip))
256
257endif
258