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