annotate make/Docs.gmk @ 47429:aa31c0a9ebca

8189706: javadoc for the JDK APIs should summarize overridden methods with no specification changes Reviewed-by: jjg, mchung, tbell
author ksrini
date Fri, 20 Oct 2017 11:42:36 -0700
parents 743814386712
children 28d6070f5f2f
rev   line source
ihse@43047 1 # Copyright (c) 1997, 2017, Oracle and/or its affiliates. All rights reserved.
ohair@13697 2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@13697 3 #
ohair@13697 4 # This code is free software; you can redistribute it and/or modify it
ohair@13697 5 # under the terms of the GNU General Public License version 2 only, as
ohair@13697 6 # published by the Free Software Foundation. Oracle designates this
ohair@13697 7 # particular file as subject to the "Classpath" exception as provided
ohair@13697 8 # by Oracle in the LICENSE file that accompanied this code.
ohair@13697 9 #
ohair@13697 10 # This code is distributed in the hope that it will be useful, but WITHOUT
ohair@13697 11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@13697 12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@13697 13 # version 2 for more details (a copy is included in the LICENSE file that
ohair@13697 14 # accompanied this code).
ohair@13697 15 #
ohair@13697 16 # You should have received a copy of the GNU General Public License version
ohair@13697 17 # 2 along with this work; if not, write to the Free Software Foundation,
ohair@13697 18 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@13697 19 #
ohair@13697 20 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@13697 21 # or visit www.oracle.com if you need additional information or have any
ohair@13697 22 # questions.
ohair@13697 23 #
ohair@13697 24
ihse@41652 25 default: all
ihse@41652 26
ohair@13697 27 include $(SPEC)
ohair@13697 28 include MakeBase.gmk
ihse@44725 29 include Modules.gmk
ihse@44983 30 include ProcessMarkdown.gmk
ihse@44725 31 include ZipArchive.gmk
erikj@47217 32 include $(TOPDIR)/make/ToolsJdk.gmk
erikj@47217 33 include $(TOPDIR)/make/ModuleTools.gmk
ohair@13697 34
ihse@44725 35 # This is needed to properly setup DOCS_MODULES.
ihse@44725 36 $(eval $(call ReadImportMetaData))
ihse@44725 37
ihse@41652 38 ################################################################################
ihse@44827 39 # Hook to include the corresponding custom file, if present.
ihse@47314 40 $(eval $(call IncludeCustomExtension, Docs.gmk))
ihse@44827 41
ihse@44827 42 ################################################################################
ihse@45323 43 # This file generates all documentation for OpenJDK.
ihse@45323 44 #
ihse@45323 45 # We will generate API documentation for two different selections of the source
ihse@45323 46 # code: "Java SE", which contains just the modules covered by the top-level
ihse@45323 47 # module java.se.ee, and "JDK", which covers all of Java SE and also all
ihse@45323 48 # other available modules that should be documented, including imported modules,
ihse@45323 49 # if any.
ihse@45323 50 #
ihse@45323 51 # We will also generate separate, free-standing specifications from either
ihse@45323 52 # markdown or existing html files.
ihse@45323 53 #
ihse@45323 54
ihse@45323 55 ################################################################################
ihse@44725 56 # Javadoc settings
ohair@13697 57
ihse@44725 58 # On top of the sources that was used to compile the JDK, we need some
ihse@44725 59 # extra java.rmi sources that are used just for javadoc.
ihse@44726 60 MODULES_SOURCE_PATH := $(call PathList, $(call GetModuleSrcPath) \
erikj@47217 61 $(SUPPORT_OUTPUTDIR)/rmic/* $(TOPDIR)/src/*/share/doc/stub)
alanb@36506 62
ihse@41652 63 # URLs
ihse@45108 64 JAVADOC_BASE_URL := http://www.oracle.com/pls/topic/lookup?ctx=javase9&id=homepage
ihse@41652 65 BUG_SUBMIT_URL := http://bugreport.java.com/bugreport/
ihse@45613 66 COPYRIGHT_URL := {@docroot}/../legal/copyright.html
ihse@44990 67 LICENSE_URL := http://www.oracle.com/technetwork/java/javase/terms/license/java9speclicense.html
ihse@44990 68 REDISTRIBUTION_URL := http://www.oracle.com/technetwork/java/redist-137594.html
ihse@44990 69
ihse@42135 70 # In order to get a specific ordering it's necessary to specify the total
ihse@42135 71 # ordering of tags as the tags are otherwise ordered in order of definition.
ihse@44725 72 JAVADOC_TAGS := \
ihse@42135 73 -tag beaninfo:X \
ihse@42135 74 -tag revised:X \
ihse@42135 75 -tag since.unbundled:X \
ihse@42135 76 -tag spec:X \
ihse@42135 77 -tag specdefault:X \
ihse@42135 78 -tag Note:X \
ihse@42135 79 -tag ToDo:X \
ihse@42135 80 -tag 'apiNote:a:API Note:' \
ihse@42135 81 -tag 'implSpec:a:Implementation Requirements:' \
ihse@42135 82 -tag 'implNote:a:Implementation Note:' \
ihse@42135 83 -tag param \
ihse@42135 84 -tag return \
ihse@42135 85 -tag throws \
mchung@44397 86 -taglet build.tools.taglet.ModuleGraph \
ihse@42135 87 -tag since \
ihse@42135 88 -tag version \
ihse@42135 89 -tag serialData \
ihse@42135 90 -tag factory \
ihse@42135 91 -tag see \
ihse@42135 92 -tag 'jvms:a:See <cite>The Java&trade; Virtual Machine Specification</cite>:' \
ihse@42135 93 -tag 'jls:a:See <cite>The Java&trade; Language Specification</cite>:' \
ksrini@44826 94 -taglet build.tools.taglet.ExtLink \
chegar@43285 95 -taglet build.tools.taglet.Incubating \
chegar@43285 96 -tagletpath $(BUILDTOOLS_OUTPUTDIR)/jdk_tools_classes \
ihse@44827 97 $(CUSTOM_JAVADOC_TAGS) \
ihse@42135 98 #
ihse@42135 99
ihse@44725 100 # Which doclint checks to ignore
ihse@44725 101 JAVADOC_DISABLED_DOCLINT := accessibility html missing syntax reference
ihse@44725 102
ihse@44725 103 # The initial set of options for javadoc
jjg@46087 104 JAVADOC_OPTIONS := -use -keywords -notimestamp \
jjg@46087 105 -serialwarn -encoding ISO-8859-1 -docencoding UTF-8 -breakiterator \
ksrini@47429 106 -splitIndex --system none -html5 -javafx --expand-requires transitive \
ksrini@47429 107 --override-methods=summary
ihse@41652 108
ihse@44725 109 # Should we add DRAFT stamps to the generated javadoc?
ihse@44725 110 ifeq ($(VERSION_IS_GA), true)
ihse@44725 111 IS_DRAFT := false
ihse@44725 112 else
ihse@44725 113 IS_DRAFT := true
ihse@44725 114 endif
ohair@13697 115
ihse@41652 116 ################################################################################
ihse@44725 117 # General text snippets
alanb@36506 118
ihse@44725 119 FULL_COMPANY_NAME := Oracle and/or its affiliates
mr@45616 120 COMPANY_ADDRESS := 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@13697 121
mr@45616 122 JAVA_PLATFORM := Java Platform
ihse@45323 123
ihse@44725 124 ifeq ($(IS_DRAFT), true)
ihse@44725 125 DRAFT_MARKER_STR := <br><strong>DRAFT $(VERSION_STRING)</strong>
ihse@44725 126 ifeq ($(VERSION_BUILD), 0)
ihse@44725 127 DRAFT_MARKER_TITLE := [ad-hoc build]
ihse@44725 128 else
ihse@44725 129 DRAFT_MARKER_TITLE := [build $(VERSION_BUILD)]
ihse@44725 130 endif
mr@45616 131 DRAFT_TEXT := This specification is not final and is subject to change. \
mr@45616 132 Use is subject to <a href="$(LICENSE_URL)">license terms</a>.
ihse@44725 133 endif
ihse@44725 134
ihse@44725 135 JAVADOC_BOTTOM := \
mr@45616 136 <a href="$(BUG_SUBMIT_URL)">Report a bug or suggest an enhancement</a><br> \
mr@45616 137 For further API reference and developer documentation see the \
ihse@45108 138 <a href="$(JAVADOC_BASE_URL)" target="_blank">Java SE \
mr@45616 139 Documentation</a>, which contains more detailed, \
mr@45616 140 developer-targeted descriptions with conceptual overviews, definitions \
ihse@44725 141 of terms, workarounds, and working code examples.<br> \
ihse@44725 142 Java is a trademark or registered trademark of $(FULL_COMPANY_NAME) in \
ihse@44725 143 the US and other countries.<br> \
ihse@44725 144 <a href="$(COPYRIGHT_URL)">Copyright</a> \
mr@45616 145 &copy; 1993, $(COPYRIGHT_YEAR), $(FULL_COMPANY_NAME), \
mr@45616 146 $(COMPANY_ADDRESS).<br>All rights reserved. \
mr@45616 147 Use is subject to <a href="$(LICENSE_URL)">license terms</a> and the \
ihse@44990 148 <a href="$(REDISTRIBUTION_URL)">documentation redistribution policy</a>. \
mr@45616 149 $(DRAFT_MARKER_STR) <!-- Version $(VERSION_STRING) -->
mr@45616 150
ihse@44725 151
ihse@44725 152 JAVADOC_TOP := \
mr@45616 153 <div style="padding: 6px; text-align: center; font-size: 80%; \
mr@45616 154 font-family: DejaVu Sans, Arial, Helvetica, sans-serif; \
mr@45616 155 font-weight: normal;">$(DRAFT_TEXT)</div>
ksrini@35367 156
ihse@41652 157 ################################################################################
ihse@44726 158 # JDK javadoc titles/text snippets
ksrini@35367 159
mr@45616 160 JDK_SHORT_NAME := Java SE $(VERSION_SPECIFICATION) &amp; JDK $(VERSION_SPECIFICATION)
mr@45616 161 JDK_LONG_NAME := Java<sup>&reg;</sup> Platform, Standard Edition \
mr@45775 162 &amp;&nbsp;Java&nbsp;Development&nbsp;Kit
ihse@44726 163
ihse@44726 164 ################################################################################
ihse@44726 165 # Java SE javadoc titles/text snippets
ihse@44726 166
mr@45616 167 JAVASE_SHORT_NAME := Java SE $(VERSION_SPECIFICATION)
mr@45616 168 JAVASE_LONG_NAME := Java<sup>&reg;</sup> Platform, Standard Edition
ksrini@35367 169
ihse@41652 170 ################################################################################
ihse@44726 171 # Functions
alanb@36506 172
ihse@44726 173 # Helper function for creating a png file from a dot file generated by the
ihse@44726 174 # GenGraphs tool.
ihse@44726 175 # param 1: SetupJavadocGeneration namespace ($1)
ihse@44726 176 # param 2: module name
ihse@44726 177 #
ihse@44726 178 define setup_gengraph_dot_to_png
ihse@44726 179 $1_$2_DOT_SRC := $$($1_GENGRAPHS_DIR)/$2.dot
ihse@44726 180 $1_$2_PNG_TARGET := $$($1_TARGET_DIR)/$2-graph.png
ksrini@35367 181
ihse@44726 182 # For each module needing a graph, create a png file from the dot file
ihse@44726 183 # generated by the GenGraphs tool and store it in the target dir.
ihse@44726 184 $$($1_$2_PNG_TARGET): $$($1_GENGRAPHS_MARKER)
ihse@44726 185 $$(call MakeDir, $$(@D))
ihse@44726 186 $$(call ExecuteWithLog, $$($1_$2_DOT_SRC), \
ihse@44726 187 $$(DOT) -Tpng -o $$($1_$2_PNG_TARGET) $$($1_$2_DOT_SRC))
ihse@44725 188
ihse@44726 189 $1_MODULEGRAPH_TARGETS += $$($1_$2_PNG_TARGET)
ihse@44726 190 endef
ksrini@35367 191
ihse@45323 192 # Helper function to create the overview.html file to use with the -overview
ihse@45323 193 # javadoc option.
ihse@45323 194 # Returns the filename as $1_OVERVIEW.
ihse@45323 195 #
ihse@45323 196 # param 1: SetupJavadocGeneration namespace ($1)
ihse@45323 197 define create_overview_file
ihse@45323 198 $1_OVERVIEW_TEXT := \
ihse@45323 199 <!DOCTYPE html> \
ihse@45323 200 <html><head></head><body> \
ihse@45323 201 #
ihse@45323 202 ifneq ($$($1_GROUPS),)
ihse@45323 203 $1_OVERVIEW_TEXT += \
mr@45616 204 <p>This document is divided into \
mr@45616 205 $$(subst 2,two,$$(subst 3,three,$$(words $$($1_GROUPS)))) sections:</p> \
mr@45616 206 <blockquote><dl> \
mr@45616 207 #
ihse@45323 208 $1_OVERVIEW_TEXT += $$(foreach g, $$($1_GROUPS), \
mr@45616 209 <dt style="margin-top: 8px;"><a href="\#$$g">$$($$g_GROUP_NAME)</a></dt> \
mr@45775 210 <dd style="margin-top: 8px;">$$($$g_GROUP_DESCRIPTION)</dd> \
ihse@45323 211 )
ihse@45323 212 $1_OVERVIEW_TEXT += \
mr@45775 213 </dl></blockquote> \
ihse@45323 214 #
ihse@45323 215 endif
ihse@45323 216 $1_OVERVIEW_TEXT += \
ihse@45323 217 </body></html> \
ihse@45323 218 #
ihse@45323 219
ihse@45323 220 $1_OVERVIEW := $$(SUPPORT_OUTPUTDIR)/docs/$1-overview.html
ihse@45323 221
ihse@45323 222 $1_OVERVIEW_VARDEPS_FILE := $$(call DependOnVariable, $1_OVERVIEW_TEXT, \
ihse@45323 223 $$($1_OVERVIEW).vardeps)
ihse@45323 224
ihse@45323 225 $$($1_OVERVIEW): $$($1_OVERVIEW_VARDEPS_FILE)
ihse@45323 226 $$(call LogInfo, Creating overview.html for $1)
ihse@45323 227 $$(call MakeDir, $$(@D))
ihse@45323 228 $$(PRINTF) > $$@ '$$($1_OVERVIEW_TEXT)'
ihse@45323 229 endef
ihse@45323 230
ihse@41652 231 ################################################################################
ihse@45323 232 # Setup make rules to create an API documentation collection, using javadoc and
ihse@45323 233 # other tools if needed.
ihse@44726 234 #
ihse@44726 235 # Parameter 1 is the name of the rule. This name is used as variable prefix.
ihse@44726 236 # Targets generated are returned as $1_JAVADOC_TARGETS and
ihse@44726 237 # $1_MODULEGRAPH_TARGETS. Note that the index.html file will work as a "touch
ihse@44726 238 # file" for all the magnitude of files that are generated by javadoc.
ihse@44726 239 #
ihse@44726 240 # Remaining parameters are named arguments. These include:
ihse@44726 241 # MODULES - Modules to generate javadoc for
ihse@45323 242 # GROUPS - Name of the groups to divide the modules into, if any
ihse@45323 243 # SHORT_NAME - The short name of this documentation collection
ihse@45323 244 # LONG_NAME - The long name of this documentation collection
ihse@44726 245 # TARGET_DIR - Where to store the output
ihse@44726 246 #
ihse@44726 247 SetupApiDocsGeneration = $(NamedParamsMacroTemplate)
ihse@44726 248 define SetupApiDocsGenerationBody
ksrini@35367 249
ihse@45233 250 # Figure out all modules, both specified and transitive indirect exports, that
ihse@45233 251 # will be processed by javadoc.
ihse@45233 252 $1_INDIRECT_EXPORTS := $$(call FindTransitiveIndirectDepsForModules, $$($1_MODULES))
ihse@45233 253 $1_ALL_MODULES := $$(sort $$($1_MODULES) $$($1_INDIRECT_EXPORTS))
ksrini@35367 254
ihse@44726 255 ifeq ($$(ENABLE_FULL_DOCS), true)
ihse@44726 256 # Tell the ModuleGraph taglet to generate html links to soon-to-be-created
ihse@44726 257 # png files with module graphs.
ihse@44726 258 $1_JAVA_ARGS += -DenableModuleGraph=true
ihse@44726 259 endif
ihse@44725 260
ihse@44726 261 # Always include tags and basic options
ihse@44726 262 $1_OPTIONS := $$(JAVADOC_TAGS) $$(JAVADOC_OPTIONS)
ihse@44725 263
ihse@44726 264 $1_OPTIONS += --module-source-path $$(MODULES_SOURCE_PATH)
ihse@44726 265 $1_OPTIONS += --module $$(call CommaList, $$($1_MODULES))
ihse@44725 266
ihse@44726 267 # Create a string like "-Xdoclint:all,-syntax,-html,..."
ihse@44726 268 $1_OPTIONS += -Xdoclint:all,$$(call CommaList, $$(addprefix -, \
ihse@44726 269 $$(JAVADOC_DISABLED_DOCLINT)))
ihse@44726 270
mr@45616 271 $1_DOC_TITLE := $$($1_LONG_NAME)<br>Version $$(VERSION_SPECIFICATION) API Specification
mr@45616 272 $1_WINDOW_TITLE := $$(subst &amp;,&,$$($1_SHORT_NAME)) \
ihse@45323 273 $$(DRAFT_MARKER_TITLE)
mr@45616 274 ifeq ($(VERSION_IS_GA), true) # Workaround stylesheet bug
mr@45616 275 $1_HEADER_PAD := 14
mr@45616 276 else
mr@45616 277 $1_HEADER_PAD := 9
mr@45616 278 endif
mr@45616 279 $1_HEADER_TITLE := <div style="margin-top: $$($1_HEADER_PAD)px;"><strong>$$($1_SHORT_NAME)</strong> \
mr@45616 280 $$(DRAFT_MARKER_STR)</div>
ihse@45323 281
ihse@44726 282 $1_OPTIONS += -doctitle '$$($1_DOC_TITLE)'
ihse@44726 283 $1_OPTIONS += -windowtitle '$$($1_WINDOW_TITLE)'
ihse@44726 284 $1_OPTIONS += -header '$$($1_HEADER_TITLE)'
ihse@45323 285 $1_OPTIONS += -bottom '$$(JAVADOC_BOTTOM)'
ihse@44726 286 ifeq ($$(IS_DRAFT), true)
ihse@45323 287 $1_OPTIONS += -top '$$(JAVADOC_TOP)'
ihse@44726 288 endif
ihse@44726 289
ihse@44726 290 # Do not store debug level options in VARDEPS.
ihse@44726 291 ifneq ($$(LOG_LEVEL), trace)
ihse@44726 292 $1_LOG_OPTION += -quiet
ihse@44726 293 else
ihse@44726 294 $1_LOG_OPTION += -verbose
ihse@44726 295 endif
ihse@44726 296
ihse@45323 297 # Generate the overview.html file. This will return the filename in
ihse@45323 298 # $1_OVERVIEW.
ihse@45323 299 $$(eval $$(call create_overview_file,$1))
ihse@45323 300 $1_OPTIONS += -overview $$($1_OVERVIEW)
ihse@45323 301
ihse@45323 302 $$(foreach g, $$($1_GROUPS), \
ihse@45323 303 $$(eval $1_OPTIONS += -group "$$($$g_GROUP_NAME)" "$$($$g_GROUP_MODULES)") \
ihse@45323 304 )
ihse@45323 305
ihse@44726 306 $1_VARDEPS := $$($1_JAVA_ARGS) $$($1_OPTIONS) $$(MODULES_SOURCE_PATH) \
ihse@44726 307 $$($1_ALL_MODULES)
ihse@44726 308 $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, \
ihse@44726 309 $$(SUPPORT_OUTPUTDIR)/docs/$1.vardeps)
ihse@44726 310
ihse@44726 311 # Get a list of all files in all the source dirs for all included modules
ihse@44726 312 $1_SOURCE_DEPS := $$(call CacheFind, $$(wildcard $$(foreach module, \
ihse@44726 313 $$($1_ALL_MODULES), $$(call FindModuleSrcDirs, $$(module)))))
ihse@44726 314
ihse@44726 315 # Javadoc creates a lot of files but use index.html as a marker
ihse@44726 316 $$($1_TARGET_DIR)/index.html: $$(BUILD_TOOLS_JDK) $$($1_VARDEPS_FILE) \
ihse@44726 317 $$($1_SOURCE_DEPS) $$($1_OVERVIEW)
ihse@45323 318 $$(call LogWarn, Generating $1 javadoc for \
ihse@44726 319 $$(words $$($1_ALL_MODULES)) modules)
ihse@44726 320 $$(call LogInfo, Javadoc modules: $$($1_ALL_MODULES))
ihse@44726 321 $$(call MakeDir, $$($1_TARGET_DIR))
ihse@44726 322 $$(call ExecuteWithLog, $$(SUPPORT_OUTPUTDIR)/docs/$1, \
ihse@44726 323 $$(JAVA) -Djava.awt.headless=true $$($1_JAVA_ARGS) \
ihse@44726 324 $$(NEW_JAVADOC) -d $$($1_TARGET_DIR) \
ihse@44726 325 $$(JAVADOC_TAGS) $$($1_OPTIONS) $$($1_LOG_OPTION))
ihse@44726 326
ihse@44726 327 $1_JAVADOC_TARGETS := $$($1_TARGET_DIR)/index.html
ihse@44726 328
ihse@44726 329 ifeq ($$(ENABLE_FULL_DOCS), true)
ihse@44726 330 # We have asked ModuleGraph to generate links to png files. Now we must
ihse@44726 331 # produce the png files.
ihse@44726 332
ihse@44726 333 # Locate which modules has the @moduleGraph tag in their module-info.java
ihse@44726 334 $1_MODULES_NEEDING_GRAPH := $$(strip $$(foreach m, $$($1_ALL_MODULES), \
ihse@44726 335 $$(if $$(shell $$(GREP) -e @moduleGraph \
ihse@44726 336 $$(wildcard $$(addsuffix /module-info.java, \
ihse@44726 337 $$(call FindModuleSrcDirs, $$m)))), \
ihse@44726 338 $$m) \
ihse@44726 339 ))
ihse@44726 340
ihse@44726 341 # First we run the GenGraph tool. It will query the module structure of the
ihse@44726 342 # running JVM and output .dot files for all existing modules.
ihse@44726 343 GENGRAPHS_PROPS := \
erikj@47217 344 $$(TOPDIR)/make/jdk/src/classes/build/tools/jigsaw/javadoc-graphs.properties
ihse@44726 345
ihse@44726 346 $1_GENGRAPHS_DIR := $$(SUPPORT_OUTPUTDIR)/docs/$1-gengraphs
ihse@44726 347 $1_GENGRAPHS_MARKER := $$($1_GENGRAPHS_DIR)/_gengraphs_run.marker
ihse@44726 348
ihse@44726 349 $$($1_GENGRAPHS_MARKER): $$(BUILD_JIGSAW_TOOLS) $$(GENGRAPHS_PROPS)
ihse@45323 350 $$(call LogInfo, Running gengraphs for $1 documentation)
ihse@44726 351 $$(call MakeDir, $$($1_GENGRAPHS_DIR))
ihse@44726 352 $$(call ExecuteWithLog, $$($1_GENGRAPHS_DIR)/gengraphs, \
ihse@44726 353 $$(TOOL_GENGRAPHS) --spec --output $$($1_GENGRAPHS_DIR) \
ihse@44726 354 --dot-attributes $$(GENGRAPHS_PROPS) && \
ihse@44726 355 $$(TOUCH) $$($1_GENGRAPHS_MARKER))
ihse@44726 356
ihse@44726 357 # For each module needing a graph, create a png file from the dot file
ihse@44726 358 # generated by the GenGraphs tool and store it in the target dir.
ihse@44726 359 # They will depend on $1_GENGRAPHS_MARKER, and will be added to $1.
ihse@44726 360 $$(foreach m, $$($1_MODULES_NEEDING_GRAPH), \
ihse@44726 361 $$(eval $$(call setup_gengraph_dot_to_png,$1,$$m)) \
ihse@44726 362 )
ihse@44726 363 endif
ihse@44726 364 endef
ihse@44726 365
ihse@44726 366 ################################################################################
ihse@44726 367 # Setup generation of the JDK API documentation (javadoc + modulegraph)
ihse@44726 368
ihse@45323 369 # Define the groups of the JDK API documentation
ihse@45323 370 JavaSE_GROUP_NAME := Java SE
ihse@45323 371 JavaSE_GROUP_MODULES := $(call ColonList, $(sort java.se.ee \
ihse@45323 372 $(call FindTransitiveIndirectDepsForModules, java.se.ee)))
ihse@45323 373 JavaSE_GROUP_DESCRIPTION := \
mr@45616 374 The Java Platform, Standard Edition (Java SE) APIs define the core Java \
mr@45616 375 platform for general-purpose computing. These APIs are in modules whose \
mr@45616 376 names start with {@code java}. \
ihse@45323 377 #
ihse@45323 378 JDK_GROUPS += JavaSE
ihse@45323 379
ihse@45323 380 JDK_GROUP_NAME := JDK
ihse@45323 381 JDK_GROUP_MODULES := jdk.*
ihse@45323 382 JDK_GROUP_DESCRIPTION := \
mr@45616 383 The Java Development Kit (JDK) APIs are specific to the JDK and will not \
mr@45616 384 necessarily be available in all implementations of the Java SE Platform. \
mr@45616 385 These APIs are in modules whose names start with {@code jdk}. \
ihse@45323 386 #
ihse@45323 387 JDK_GROUPS += JDK
ihse@45323 388
ihse@45323 389 # If we are importing JavaFX, we need a JavaFX group. In an ideal world, this
ihse@45323 390 # would have been abstracted away to a more proper generic handling of imported
ihse@45323 391 # modules.
ihse@45323 392 ifneq ($(findstring javafx., $(IMPORTED_MODULES)), )
ihse@45323 393 JavaFX_GROUP_NAME := JavaFX
ihse@45323 394 JavaFX_GROUP_MODULES := javafx.*
ihse@45323 395 JavaFX_GROUP_DESCRIPTION := \
mr@45616 396 The JavaFX APIs define a set of user-interface controls, graphics, \
ihse@45323 397 media, and web packages for developing rich client applications. These \
mr@45616 398 APIs are in modules whose names start with {@code javafx}. \
ihse@45323 399 #
ihse@45323 400 JDK_GROUPS += JavaFX
ihse@45323 401 endif
ihse@45323 402
ihse@44726 403 # All modules to have docs generated by docs-jdk-api target
ihse@45323 404 JDK_MODULES := $(sort $(DOCS_MODULES))
ihse@44726 405
ihse@44726 406 $(eval $(call SetupApiDocsGeneration, JDK_API, \
ihse@45323 407 MODULES := $(JDK_MODULES), \
ihse@45323 408 GROUPS := $(JDK_GROUPS), \
ihse@45323 409 SHORT_NAME := $(JDK_SHORT_NAME), \
ihse@45323 410 LONG_NAME := $(JDK_LONG_NAME), \
ihse@45103 411 TARGET_DIR := $(DOCS_OUTPUTDIR)/api, \
ihse@44726 412 ))
ihse@44726 413
ihse@44726 414 # Targets generated are returned in JDK_API_JAVADOC_TARGETS and
ihse@44726 415 # JDK_API_MODULEGRAPH_TARGETS.
ihse@44726 416
ihse@44726 417 ################################################################################
ihse@44726 418 # Setup generation of the Java SE API documentation (javadoc + modulegraph)
ihse@44726 419
mr@45616 420 # The Java SE module scope is just java.se.ee and its transitive indirect
ihse@45233 421 # exports.
ihse@45323 422 JAVASE_MODULES := java.se.ee
ihse@44726 423
ihse@44726 424 $(eval $(call SetupApiDocsGeneration, JAVASE_API, \
ihse@45323 425 MODULES := $(JAVASE_MODULES), \
ihse@45323 426 SHORT_NAME := $(JAVASE_SHORT_NAME), \
ihse@45323 427 LONG_NAME := $(JAVASE_LONG_NAME), \
ihse@44726 428 TARGET_DIR := $(IMAGES_OUTPUTDIR)/javase-docs/api, \
ihse@44726 429 ))
ihse@44726 430
ihse@44726 431 # Targets generated are returned in JAVASE_API_JAVADOC_TARGETS and
ihse@44726 432 # JAVASE_API_MODULEGRAPH_TARGETS.
ohair@13697 433
ihse@41652 434 ################################################################################
mchung@45105 435
ihse@45229 436 JDK_INDEX_HTML := $(DOCS_OUTPUTDIR)/index.html
mchung@45105 437
mchung@45610 438 JDK_INDEX_CONTENT := \
mchung@45610 439 <!DOCTYPE html> \
mchung@45610 440 <html lang="en"> \
mchung@45610 441 <head> \
mchung@45610 442 <meta http-equiv="refresh" content="0;url=api/index.html"> \
mchung@45610 443 </head> \
mchung@45610 444 </html>
mchung@45610 445
mchung@45610 446 $(JDK_INDEX_HTML):
mchung@45610 447 $(ECHO) '$(JDK_INDEX_CONTENT)' > $@
mchung@45105 448
ihse@45613 449 JDK_INDEX_TARGETS += $(JDK_INDEX_HTML)
ihse@45229 450
ihse@45229 451 # Copy the global resources
erikj@47217 452 GLOBAL_SPECS_RESOURCES_DIR := $(TOPDIR)/make/data/docs-resources/
ihse@45229 453 $(eval $(call SetupCopyFiles, COPY_GLOBAL_RESOURCES, \
ihse@45229 454 SRC := $(GLOBAL_SPECS_RESOURCES_DIR), \
ihse@45229 455 FILES := $(call CacheFind, $(GLOBAL_SPECS_RESOURCES_DIR)), \
ihse@45229 456 DEST := $(DOCS_OUTPUTDIR), \
ihse@45229 457 ))
ihse@45229 458 JDK_INDEX_TARGETS += $(COPY_GLOBAL_RESOURCES)
mchung@45105 459
mchung@45617 460 # Copy the legal notices distributed with the docs bundle
mchung@45617 461 DOCS_LEGAL_NOTICES := jquery.md jszip.md pako.md
mchung@45617 462 $(eval $(call SetupCopyFiles, COPY_DOCS_LEGAL_NOTICES, \
erikj@47217 463 SRC := $(TOPDIR)/src/jdk.javadoc/share/legal, \
mchung@45617 464 FILES := $(DOCS_LEGAL_NOTICES), \
mchung@45617 465 DEST := $(DOCS_OUTPUTDIR)/legal, \
mchung@45617 466 ))
mchung@45617 467 JDK_INDEX_TARGETS += $(COPY_DOCS_LEGAL_NOTICES)
mchung@45617 468
mchung@45105 469 ################################################################################
ihse@44733 470 # Copy JDK specs files
ihse@41652 471
ihse@44733 472 # For all html documentation in $module/share/specs directories, copy it
ihse@44733 473 # unmodified
ihse@41652 474
ihse@44733 475 ALL_MODULES := $(call FindAllModules)
ihse@44983 476 COPY_SPEC_FILTER := %.html %.gif %.jpg %.mib %.css
ihse@44733 477
ihse@44733 478 $(foreach m, $(ALL_MODULES), \
ihse@44733 479 $(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \
ihse@45095 480 $(foreach d, $(SPECS_$m), \
ihse@45095 481 $(if $(filter $(COPY_SPEC_FILTER), $(call CacheFind, $d)), \
ihse@45095 482 $(eval $(call SetupCopyFiles, COPY_$m, \
ihse@45095 483 SRC := $d, \
ihse@45095 484 FILES := $(filter $(COPY_SPEC_FILTER), $(call CacheFind, $d)), \
ihse@45103 485 DEST := $(DOCS_OUTPUTDIR)/specs/, \
ihse@45095 486 )) \
ihse@45095 487 $(eval JDK_SPECS_TARGETS += $(COPY_$m)) \
ihse@45095 488 ) \
ihse@44733 489 ) \
ihse@44733 490 )
ihse@44733 491
ihse@44734 492 ifeq ($(ENABLE_FULL_DOCS), true)
ihse@44734 493 # For all markdown files in $module/share/specs directories, convert them to
ihse@44734 494 # html.
ihse@44734 495
ihse@45229 496 GLOBAL_SPECS_DEFAULT_CSS_FILE := $(DOCS_OUTPUTDIR)/resources/jdk-default.css
ihse@44734 497
ihse@44734 498 $(foreach m, $(ALL_MODULES), \
ihse@44734 499 $(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \
ihse@44983 500 $(foreach d, $(SPECS_$m), \
ihse@44983 501 $(if $(filter %.md, $(call CacheFind, $d)), \
erikj@47217 502 $(eval $m_$d_NAME := CONVERT_MARKDOWN_$m_$(strip $(call RelativePath, $d, $(TOPDIR)))) \
erikj@47217 503 $(eval $(call SetupProcessMarkdown, $($m_$d_NAME), \
ihse@44983 504 SRC := $d, \
ihse@44983 505 FILES := $(filter %.md, $(call CacheFind, $d)), \
ihse@45103 506 DEST := $(DOCS_OUTPUTDIR)/specs/, \
ihse@44983 507 CSS := $(GLOBAL_SPECS_DEFAULT_CSS_FILE), \
ihse@44983 508 )) \
erikj@47217 509 $(eval JDK_SPECS_TARGETS += $($($m_$d_NAME))) \
ihse@44983 510 ) \
ihse@44734 511 ) \
ihse@44734 512 )
ihse@44734 513 endif
ihse@44734 514
ihse@44733 515 # Special treatment for generated documentation
ihse@44733 516
ihse@44733 517 JDWP_PROTOCOL := $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html
ihse@44733 518 $(eval $(call SetupCopyFiles, COPY_JDWP_PROTOCOL, \
ihse@44733 519 FILES := $(JDWP_PROTOCOL), \
ihse@45103 520 DEST := $(DOCS_OUTPUTDIR)/specs/jdwp, \
ihse@41652 521 ))
ihse@44733 522 JDK_SPECS_TARGETS += $(COPY_JDWP_PROTOCOL)
ihse@41652 523
ihse@44733 524 # Get jvmti.html from the main jvm variant (all variants' jvmti.html are identical).
ihse@44733 525 JVMTI_HTML := $(HOTSPOT_OUTPUTDIR)/variant-$(JVM_VARIANT_MAIN)/gensrc/jvmtifiles/jvmti.html
erikj@41260 526 $(eval $(call SetupCopyFiles, COPY_JVMTI_HTML, \
erikj@41260 527 FILES := $(JVMTI_HTML), \
ihse@45103 528 DEST := $(DOCS_OUTPUTDIR)/specs, \
erikj@41260 529 ))
ihse@44733 530 JDK_SPECS_TARGETS += $(COPY_JVMTI_HTML)
ohair@13697 531
ihse@41652 532 ################################################################################
ihse@41652 533 # Optional target which bundles all generated javadocs into a zip archive.
neugens@37034 534
ihse@44725 535 JAVADOC_ZIP_NAME := jdk-$(VERSION_STRING)-docs.zip
ihse@47253 536 JAVADOC_ZIP_FILE := $(OUTPUTDIR)/bundles/$(JAVADOC_ZIP_NAME)
ihse@41652 537
ihse@44725 538 $(eval $(call SetupZipArchive, BUILD_JAVADOC_ZIP, \
ihse@45103 539 SRC := $(DOCS_OUTPUTDIR), \
ihse@44733 540 ZIP := $(JAVADOC_ZIP_FILE), \
ihse@44733 541 EXTRA_DEPS := $(JDK_API_JAVADOC_TARGETS) $(JDK_API_MODULEGRAPH_TARGETS) \
ihse@44733 542 $(JDK_SPECS_TARGETS), \
ihse@44725 543 ))
neugens@37034 544
ihse@44725 545 ZIP_TARGETS += $(BUILD_JAVADOC_ZIP)
erikj@39384 546
erikj@39384 547 ################################################################################
erikj@39384 548
ihse@45103 549 docs-jdk-api-javadoc: $(JDK_API_JAVADOC_TARGETS) $(JDK_API_CUSTOM_TARGETS)
mchung@44397 550
ihse@44726 551 docs-jdk-api-modulegraph: $(JDK_API_MODULEGRAPH_TARGETS)
ihse@44725 552
ihse@45103 553 docs-javase-api-javadoc: $(JAVASE_API_JAVADOC_TARGETS) $(JAVASE_API_CUSTOM_TARGETS)
ihse@44726 554
ihse@44726 555 docs-javase-api-modulegraph: $(JAVASE_API_MODULEGRAPH_TARGETS)
ihse@41652 556
ihse@44733 557 docs-jdk-specs: $(JDK_SPECS_TARGETS)
ihse@41652 558
ihse@45229 559 docs-jdk-index: $(JDK_INDEX_TARGETS)
mchung@45105 560
ihse@41652 561 docs-zip: $(ZIP_TARGETS)
ihse@41652 562
ihse@44726 563 all: docs-jdk-api-javadoc docs-jdk-api-modulegraph docs-javase-api-javadoc \
mchung@45105 564 docs-javase-api-modulegraph docs-jdk-specs docs-jdk-index docs-zip
ihse@41652 565
ihse@44726 566 .PHONY: default all docs-jdk-api-javadoc docs-jdk-api-modulegraph \
mchung@45105 567 docs-javase-api-javadoc docs-javase-api-modulegraph docs-jdk-specs \
mchung@45105 568 docs-jdk-index docs-zip