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