core/droiddoc.mk

   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
  23 LOCAL_IS_HOST_MODULE := $(call true-or-empty,$(LOCAL_IS_HOST_MODULE))
  24 ifeq ($(LOCAL_IS_HOST_MODULE),true)
  25 my_prefix := HOST_
  26 else
  27 my_prefix := TARGET_
  28 endif
  29
  30 LOCAL_MODULE_CLASS := $(strip $(LOCAL_MODULE_CLASS))
  31 ifndef LOCAL_MODULE_CLASS
  32 $(error $(LOCAL_PATH): LOCAL_MODULE_CLASS not defined)
  33 endif
  34
  35 full_src_files := $(patsubst %,$(LOCAL_PATH)/%,$(LOCAL_SRC_FILES))
  36 out_dir := $(OUT_DOCS)/$(LOCAL_MODULE)
  37 full_target := $(call doc-timestamp-for,$(LOCAL_MODULE))
  38
  39 ifeq ($(LOCAL_DROIDDOC_SOURCE_PATH),)
  40 LOCAL_DROIDDOC_SOURCE_PATH := $(LOCAL_PATH)
  41 endif
  42
  43 ifeq ($(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR),)
  44 LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR := $(SRC_DROIDDOC_DIR)/$(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR)
  45 endif
  46
  47 ifeq ($(LOCAL_DROIDDOC_ASSET_DIR),)
  48 LOCAL_DROIDDOC_ASSET_DIR := assets
  49 endif
  50 ifeq ($(LOCAL_DROIDDOC_CUSTOM_ASSET_DIR),)
  51 LOCAL_DROIDDOC_CUSTOM_ASSET_DIR := assets
  52 endif
  53
  54 $(full_target): PRIVATE_CLASSPATH:=$(LOCAL_CLASSPATH)
  55 full_java_lib_deps :=
  56
  57 $(full_target): PRIVATE_BOOTCLASSPATH :=
  58 ifeq ($(BUILD_OS),linux)
  59 # You have to set bootclasspath for javadoc manually on linux since Java 6.
  60 host_jdk_rt_jar := $(dir $(HOST_JDK_TOOLS_JAR))../jre/lib/rt.jar
  61 $(full_target): PRIVATE_BOOTCLASSPATH := $(host_jdk_rt_jar)
  62 endif
  63
  64 ifneq ($(LOCAL_IS_HOST_MODULE),true)
  65
  66 ifneq ($(LOCAL_SDK_VERSION),)
  67   ifeq ($(LOCAL_SDK_VERSION)$(TARGET_BUILD_APPS),current)
  68     # Use android_stubs_current if LOCAL_SDK_VERSION is current and no TARGET_BUILD_APPS.
  69     LOCAL_JAVA_LIBRARIES := android_stubs_current $(LOCAL_JAVA_LIBRARIES)
  70   else
  71     LOCAL_JAVA_LIBRARIES := sdk_v$(LOCAL_SDK_VERSION) $(LOCAL_JAVA_LIBRARIES)
  72   endif
  73 else
  74   LOCAL_JAVA_LIBRARIES := core ext framework $(LOCAL_JAVA_LIBRARIES)
  75 endif  # LOCAL_SDK_VERSION
  76 LOCAL_JAVA_LIBRARIES := $(sort $(LOCAL_JAVA_LIBRARIES))
  77
  78 full_java_libs := $(call java-lib-files,$(LOCAL_JAVA_LIBRARIES),$(LOCAL_IS_HOST_MODULE))
  79 full_java_lib_deps := $(call java-lib-deps,$(LOCAL_JAVA_LIBRARIES),$(LOCAL_IS_HOST_MODULE))
  80
  81 # we're not going to generate docs from any of these classes, but we need them
  82 # to build properly.
  83 ifneq ($(strip $(LOCAL_STATIC_JAVA_LIBRARIES)),)
  84 full_java_libs += $(addprefix $(LOCAL_PATH)/,$(LOCAL_STATIC_JAVA_LIBRARIES)) $(LOCAL_CLASSPATH)
  85 full_java_lib_deps += $(addprefix $(LOCAL_PATH)/,$(LOCAL_STATIC_JAVA_LIBRARIES)) $(LOCAL_CLASSPATH)
  86 endif
  87
  88 $(full_target): PRIVATE_CLASSPATH := $(subst $(space),:,$(full_java_libs))
  89
  90 endif # !LOCAL_IS_HOST_MODULE
  91
  92 intermediates.COMMON := $(call local-intermediates-dir,COMMON)
  93
  94 $(full_target): PRIVATE_SOURCE_PATH := $(call normalize-path-list,$(LOCAL_DROIDDOC_SOURCE_PATH))
  95 $(full_target): PRIVATE_JAVA_FILES := $(filter %.java,$(full_src_files))
  96 $(full_target): PRIVATE_JAVA_FILES += $(addprefix $($(my_prefix)OUT_COMMON_INTERMEDIATES)/, $(filter %.java,$(LOCAL_INTERMEDIATE_SOURCES)))
  97 $(full_target): PRIVATE_SOURCE_INTERMEDIATES_DIR := $(intermediates.COMMON)/src
  98 $(full_target): PRIVATE_SRC_LIST_FILE := $(intermediates.COMMON)/droiddoc-src-list
  99
 100 ifneq ($(strip $(LOCAL_ADDITIONAL_JAVA_DIR)),)
 101 $(full_target): PRIVATE_ADDITIONAL_JAVA_DIR := $(LOCAL_ADDITIONAL_JAVA_DIR)
 102 endif
 103
 104 $(full_target): PRIVATE_OUT_DIR := $(out_dir)
 105 $(full_target): PRIVATE_DROIDDOC_OPTIONS := $(LOCAL_DROIDDOC_OPTIONS)
 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
 112 define 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' >> $(1) 2> /dev/null ; done ; true
 116 endef
 117
 118 ifeq (a,b)
 119 $(full_target): PRIVATE_PROFILING_OPTIONS := \
 120     -J-agentlib:jprofilerti=port=8849 -J-Xbootclasspath/a:/Applications/jprofiler5/bin/agent.jar
 121 endif
 122
 123
 124 ifneq ($(strip $(LOCAL_DROIDDOC_USE_STANDARD_DOCLET)),true)
 125 ##
 126 ##
 127 ## droiddoc only
 128 ##
 129 ##
 130
 131 droiddoc_templates := \
 132     $(shell find $(LOCAL_DROIDDOC_CUSTOM_TEMPLATE_DIR) -type f)
 133
 134 droiddoc := \
 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)
 140 $(full_target): PRIVATE_CURRENT_TIME :=  -hdf page.now "$(shell date "+%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 ifneq ($(strip $(LOCAL_DROIDDOC_HTML_DIR)),)
 146 $(full_target): PRIVATE_DROIDDOC_HTML_DIR := -htmldir $(LOCAL_PATH)/$(LOCAL_DROIDDOC_HTML_DIR)
 147 else
 148 $(full_target): PRIVATE_DROIDDOC_HTML_DIR :=
 149 endif
 150 ifneq ($(strip $(LOCAL_ADDITIONAL_HTML_DIR)),)
 151 $(full_target): PRIVATE_ADDITIONAL_HTML_DIR := -htmldir2 $(LOCAL_PATH)/$(LOCAL_ADDITIONAL_HTML_DIR)
 152 else
 153 $(full_target): PRIVATE_ADDITIONAL_HTML_DIR :=
 154 endif
 155 ifneq ($(strip $(LOCAL_ADDITIONAL_HTML_DIR)),)
 156 $(full_target): PRIVATE_ADDITIONAL_HTML_DIR := -htmldir2 $(LOCAL_PATH)/$(LOCAL_ADDITIONAL_HTML_DIR)
 157 else
 158 $(full_target): PRIVATE_ADDITIONAL_HTML_DIR :=
 159 endif
 160
 161 # TODO: not clear if this is used any more
 162 $(full_target): PRIVATE_LOCAL_PATH := $(LOCAL_PATH)
 163
 164 html_dir_files := $(shell find $(LOCAL_PATH)/$(LOCAL_DROIDDOC_HTML_DIR) -type f)
 165
 166 $(full_target): $(full_src_files) $(droiddoc_templates) $(droiddoc) $(html_dir_files) $(full_java_lib_deps) $(LOCAL_ADDITIONAL_DEPENDENCIES)
 167         @echo Docs droiddoc: $(PRIVATE_OUT_DIR)
 168         $(hide) mkdir -p $(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                 \@$(PRIVATE_SRC_LIST_FILE) \
 174                 -J-Xmx1280m \
 175                 $(PRIVATE_PROFILING_OPTIONS) \
 176                 -quiet \
 177                 -doclet com.google.doclava.Doclava \
 178                 -docletpath $(PRIVATE_DOCLETPATH) \
 179                 -templatedir $(PRIVATE_CUSTOM_TEMPLATE_DIR) \
 180                 $(PRIVATE_DROIDDOC_HTML_DIR) \
 181                 $(PRIVATE_ADDITIONAL_HTML_DIR) \
 182                 $(addprefix -bootclasspath ,$(PRIVATE_BOOTCLASSPATH)) \
 183                 $(addprefix -classpath ,$(PRIVATE_CLASSPATH)) \
 184                 -sourcepath $(PRIVATE_SOURCE_PATH)$(addprefix :,$(PRIVATE_CLASSPATH)) \
 185                 -d $(PRIVATE_OUT_DIR) \
 186                 $(PRIVATE_CURRENT_BUILD) $(PRIVATE_CURRENT_TIME) \
 187                 $(PRIVATE_DROIDDOC_OPTIONS) \
 188         && touch -f $@ \
 189     ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)
 190
 191
 192
 193 else
 194 ##
 195 ##
 196 ## standard doclet only
 197 ##
 198 ##
 199 $(full_target): $(full_src_files) $(full_java_lib_deps)
 200         @echo Docs javadoc: $(PRIVATE_OUT_DIR)
 201         @mkdir -p $(dir $@)
 202         $(call prepare-doc-source-list,$(PRIVATE_SRC_LIST_FILE),$(PRIVATE_JAVA_FILES), \
 203                         $(PRIVATE_SOURCE_INTERMEDIATES_DIR) $(PRIVATE_ADDITIONAL_JAVA_DIR))
 204         $(hide) ( \
 205                 javadoc \
 206                 $(PRIVATE_DROIDDOC_OPTIONS) \
 207                 \@$(PRIVATE_SRC_LIST_FILE) \
 208                 -J-Xmx1024m \
 209                 $(PRIVATE_PROFILING_OPTIONS) \
 210                 $(addprefix -classpath ,$(PRIVATE_CLASSPATH)) \
 211                 -sourcepath $(PRIVATE_SOURCE_PATH)$(addprefix :,$(PRIVATE_CLASSPATH)) \
 212                 -d $(PRIVATE_OUT_DIR) \
 213                 -quiet \
 214         && touch -f $@ \
 215     ) || (rm -rf $(PRIVATE_OUT_DIR) $(PRIVATE_SRC_LIST_FILE); exit 45)
 216
 217
 218 endif
 219 ##
 220 ##
 221 ## Common to both droiddoc and javadoc
 222 ##
 223 ##
 224
 225
 226 ALL_DOCS += $(full_target)
 227
 228 .PHONY: $(LOCAL_MODULE)-docs
 229 $(LOCAL_MODULE)-docs : $(full_target)
 230
 231 ifeq ($(strip $(LOCAL_UNINSTALLABLE_MODULE)),)
 232
 233 # Define a rule to create a zip of these docs.
 234 out_zip := $(OUT_DOCS)/$(LOCAL_MODULE)-docs.zip
 235 $(out_zip): PRIVATE_DOCS_DIR := $(out_dir)
 236 $(out_zip): $(full_target)
 237         @echo Package docs: $@
 238         @rm -f $@
 239         @mkdir -p $(dir $@)
 240         $(hide) ( F=$$(pwd)/$@ ; cd $(PRIVATE_DOCS_DIR) && zip -rq $$F * )
 241
 242 $(call dist-for-goals,docs,$(out_zip))
 243
 244 endif