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