1 # Copyright (c) 1997, 2025, Oracle and/or its affiliates. All rights reserved. 2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 3 # 4 # This code is free software; you can redistribute it and/or modify it 5 # under the terms of the GNU General Public License version 2 only, as 6 # published by the Free Software Foundation. Oracle designates this 7 # particular file as subject to the "Classpath" exception as provided 8 # by Oracle in the LICENSE file that accompanied this code. 9 # 10 # This code is distributed in the hope that it will be useful, but WITHOUT 11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 13 # version 2 for more details (a copy is included in the LICENSE file that 14 # accompanied this code). 15 # 16 # You should have received a copy of the GNU General Public License version 17 # 2 along with this work; if not, write to the Free Software Foundation, 18 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 19 # 20 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 21 # or visit www.oracle.com if you need additional information or have any 22 # questions. 23 # 24 25 include MakeFileStart.gmk 26 27 ################################################################################ 28 # This file generates all documentation for OpenJDK. 29 # 30 # We will generate API documentation for two different selections of the source 31 # code: "Java SE", which contains just the modules covered by the top-level 32 # module java.se and "JDK", which covers all of Java SE and also all 33 # other available modules that should be documented, including imported modules, 34 # if any. 35 # 36 # We will also generate separate, free-standing specifications from either 37 # markdown or existing html files. 38 ################################################################################ 39 40 include CopyFiles.gmk 41 include Execute.gmk 42 include Modules.gmk 43 include ProcessMarkdown.gmk 44 include TextFileProcessing.gmk 45 include ZipArchive.gmk 46 include $(TOPDIR)/make/ModuleTools.gmk 47 include $(TOPDIR)/make/ToolsJdk.gmk 48 49 # This is needed to properly setup DOCS_MODULES. 50 $(eval $(call ReadImportMetaData)) 51 52 ################################################################################ 53 # Javadoc settings 54 55 # Include configuration for URLs in generated javadoc 56 include $(TOPDIR)/make/conf/javadoc.conf 57 58 MODULES_SOURCE_PATH := $(call PathList, $(call GetModuleSrcPath) ) 59 60 61 # In order to get a specific ordering it's necessary to specify the total 62 # ordering of tags as the tags are otherwise ordered in order of definition. 63 JAVADOC_TAGS := \ 64 -tag 'apiNote:a:API Note:' \ 65 -tag 'implSpec:a:Implementation Requirements:' \ 66 -tag 'implNote:a:Implementation Note:' \ 67 -tag param \ 68 -tag return \ 69 -tag throws \ 70 -taglet build.tools.taglet.JSpec\$$JLS \ 71 -taglet build.tools.taglet.JSpec\$$JVMS \ 72 -taglet build.tools.taglet.ModuleGraph \ 73 -taglet build.tools.taglet.SealedGraph \ 74 -taglet build.tools.taglet.ToolGuide \ 75 -tag since \ 76 -tag serialData \ 77 -tag factory \ 78 -tag spec \ 79 -tag see \ 80 -taglet build.tools.taglet.ExtLink \ 81 -taglet build.tools.taglet.Incubating \ 82 -tagletpath $(BUILDTOOLS_OUTPUTDIR)/jdk_tools_classes \ 83 $(CUSTOM_JAVADOC_TAGS) \ 84 # 85 86 # The reference tags must stay stable to allow for comparisons across the 87 # development cycle. If JAVADOC_TAGS needs to change, make sure that 88 # REFERENCE_TAGS remains unchanged, by copying and hardcoding, if necessary. 89 REFERENCE_TAGS := $(JAVADOC_TAGS) 90 91 # Which doclint checks to ignore 92 JAVADOC_DISABLED_DOCLINT_WARNINGS := missing 93 JAVADOC_DISABLED_DOCLINT_PACKAGES := org.w3c.* javax.smartcardio 94 95 # Allow overriding on the command line 96 # (intentionally sharing name with the javac option) 97 JAVA_WARNINGS_ARE_ERRORS ?= -Werror 98 99 # The initial set of options for javadoc 100 JAVADOC_OPTIONS := -use -keywords -notimestamp \ 101 -serialwarn -encoding ISO-8859-1 -docencoding UTF-8 -breakiterator \ 102 -splitIndex --system none -javafx --expand-requires transitive \ 103 --override-methods=summary 104 105 # The reference options must stay stable to allow for comparisons across the 106 # development cycle. 107 REFERENCE_OPTIONS := -XDignore.symbol.file=true -use -keywords -notimestamp \ 108 -serialwarn -encoding ISO-8859-1 -breakiterator -splitIndex --system none \ 109 -html5 -javafx --expand-requires transitive 110 111 # Should we add DRAFT stamps to the generated javadoc? 112 ifeq ($(VERSION_IS_GA), true) 113 IS_DRAFT := false 114 else 115 IS_DRAFT := true 116 endif 117 118 ################################################################################ 119 # General text snippets 120 121 FULL_COMPANY_NAME := Oracle and/or its affiliates 122 COMPANY_ADDRESS := 500 Oracle Parkway, Redwood Shores, CA 94065 USA 123 124 JAVA_PLATFORM := Java Platform 125 126 ifeq ($(IS_DRAFT), true) 127 DRAFT_MARKER_STR := <br><strong>DRAFT $(VERSION_STRING)</strong> 128 ifeq ($(VERSION_BUILD), ) 129 DRAFT_MARKER_TITLE := $(SPACE)[ad-hoc build] 130 else 131 DRAFT_MARKER_TITLE := $(SPACE)[build $(VERSION_BUILD)] 132 endif 133 DRAFT_TEXT := This specification is not final and is subject to change. \ 134 Use is subject to <a href="$(LICENSE_URL)">license terms</a>. 135 endif 136 137 # $1 - Relative prefix to COPYRIGHT_URL 138 COPYRIGHT_BOTTOM = \ 139 <a href="$(strip $1)$(COPYRIGHT_URL)">Copyright</a> \ 140 © 1993, $(COPYRIGHT_YEAR), $(FULL_COMPANY_NAME), \ 141 $(COMPANY_ADDRESS).<br>All rights reserved. \ 142 Use is subject to <a href="$(LICENSE_URL)">license terms</a> and the \ 143 <a href="$(REDISTRIBUTION_URL)">documentation redistribution policy</a>. \ 144 $(DRAFT_MARKER_STR) <!-- Version $(VERSION_STRING) --> 145 146 # $1 - Optional "Other Versions" link 147 JAVADOC_BOTTOM = \ 148 <a href="$(BUG_SUBMIT_URL)">Report a bug or suggest an enhancement</a><br> \ 149 For further API reference and developer documentation see the \ 150 <a href="$(JAVADOC_BASE_URL)" target="_blank">Java SE \ 151 Documentation</a>, which contains more detailed, \ 152 developer-targeted descriptions with conceptual overviews, definitions \ 153 of terms, workarounds, and working code examples. $1<br> \ 154 Java is a trademark or registered trademark of $(FULL_COMPANY_NAME) in \ 155 the US and other countries.<br> \ 156 $(call COPYRIGHT_BOTTOM, {@docroot}/../) 157 158 JAVADOC_TOP := \ 159 <div style="padding: 6px; text-align: center; font-size: 80%; \ 160 font-family: DejaVu Sans, Arial, Helvetica, sans-serif; \ 161 font-weight: normal;">$(DRAFT_TEXT)</div> 162 163 ################################################################################ 164 # JDK javadoc titles/text snippets 165 166 JDK_SHORT_NAME := Java SE $(VERSION_SPECIFICATION) & JDK $(VERSION_SPECIFICATION) 167 JDK_LONG_NAME := Java<sup>®</sup> Platform, Standard Edition \ 168 & Java Development Kit 169 170 ################################################################################ 171 # Java SE javadoc titles/text snippets 172 173 JAVASE_SHORT_NAME := Java SE $(VERSION_SPECIFICATION) 174 JAVASE_LONG_NAME := Java<sup>®</sup> Platform, Standard Edition 175 176 ################################################################################ 177 # Functions 178 179 # Helper function for creating a svg file from a dot file generated by the 180 # GenGraphs tool for a module. 181 # param 1: SetupJavadocGeneration namespace ($1) 182 # param 2: module name 183 # 184 define setup_module_graph_dot_to_svg 185 $1_$2_DOT_SRC := $$($1_MODULE_GRAPHS_DIR)/$2.dot 186 $1_$2_SVG_TARGET := $$($1_TARGET_DIR)/$2/module-graph.svg 187 188 # For each module needing a graph, create a svg file from the dot file 189 # generated by the GenGraphs tool and store it in the target dir. 190 $$(eval $$(call SetupExecute, module_graphs_svg_$1_$2, \ 191 INFO := Running dot for module graphs for $2, \ 192 DEPS := $$(module_graphs_dot_$1_TARGET), \ 193 OUTPUT_FILE := $$($1_$2_SVG_TARGET), \ 194 SUPPORT_DIR := $$($1_MODULE_GRAPHS_DIR), \ 195 COMMAND := $$(DOT) -Tsvg -o $$($1_$2_SVG_TARGET) $$($1_$2_DOT_SRC), \ 196 )) 197 198 $1_GRAPHS_TARGETS += $$($1_$2_SVG_TARGET) 199 endef 200 201 # Helper function for creating a svg file for a class for which the SealedGraph 202 # taglet has generated a dot file. The dot file has a special name which 203 # encodes the module and class the graph belongs to. 204 # 205 # param 1: SetupJavadocGeneration namespace ($1) 206 # param 2: dot file name 207 # 208 define setup_sealed_graph_dot_to_svg 209 $1_$2_DOT_SRC := $$($1_SEALED_GRAPHS_DIR)/$2.dot 210 $1_$2_TARGET_CLASS := $$(word 2, $$(subst _, , $2)) 211 $1_$2_SLASHED_NAME := $$(subst .,/, $$($1_$2_TARGET_CLASS)) 212 $1_$2_TARGET_MODULE := $$(word 1, $$(subst _, , $2)) 213 $1_$2_TARGET_PATH := $$($1_TARGET_DIR)/$$($1_$2_TARGET_MODULE)/$$(dir $$($1_$2_SLASHED_NAME)) 214 $1_$2_TARGET_NAME := $$(notdir $$($1_$2_SLASHED_NAME)) 215 $1_$2_SVG_TARGET := $$($1_$2_TARGET_PATH)/$$($1_$2_TARGET_NAME)-sealed-graph.svg 216 $$(call MakeDir, $$($1_$2_TARGET_PATH)) 217 218 # For each class needing a graph, create a svg file from the dot file 219 # generated by the SealedGraph taglet and store it in the target dir. 220 $$(eval $$(call SetupExecute, sealed_graphs_svg_$1_$2, \ 221 INFO := Running dot for sealed graphs for $$($1_$2_TARGET_MODULE)/$$($1_$2_TARGET_CLASS), \ 222 DEPS := $$($1_$2_DOT_SRC), \ 223 OUTPUT_FILE := $$($1_$2_SVG_TARGET), \ 224 SUPPORT_DIR := $$($1_SEALED_GRAPHS_DIR), \ 225 COMMAND := $$(DOT) -Tsvg -o $$($1_$2_SVG_TARGET) $$($1_$2_DOT_SRC), \ 226 )) 227 228 $1_GRAPHS_TARGETS += $$($1_$2_SVG_TARGET) 229 endef 230 231 # Helper function to create the overview.html file to use with the -overview 232 # javadoc option. 233 # Returns the filename as $1_OVERVIEW. 234 # 235 # param 1: SetupJavadocGeneration namespace ($1) 236 define create_overview_file 237 $1_OVERVIEW_TEXT := \ 238 <!DOCTYPE html> \ 239 <html><head></head><body> \ 240 # 241 ifneq ($$($1_GROUPS), ) 242 $1_OVERVIEW_TEXT += \ 243 <p>This document is divided into \ 244 $$(subst 2,two,$$(subst 3,three,$$(words $$($1_GROUPS)))) sections:</p> \ 245 <blockquote><dl> \ 246 # 247 $1_OVERVIEW_TEXT += $$(foreach g, $$($1_GROUPS), \ 248 <dt style="margin-top: 8px;">$$($$g_GROUP_NAME)</dt> \ 249 <dd style="margin-top: 8px;">$$($$g_GROUP_DESCRIPTION)</dd> \ 250 ) 251 $1_OVERVIEW_TEXT += \ 252 </dl></blockquote> \ 253 # 254 endif 255 $1_OVERVIEW_TEXT += \ 256 </body></html> \ 257 # 258 259 $1_OVERVIEW := $$(SUPPORT_OUTPUTDIR)/docs/$1-overview.html 260 261 $1_OVERVIEW_VARDEPS_FILE := $$(call DependOnVariable, $1_OVERVIEW_TEXT, \ 262 $$($1_OVERVIEW).vardeps) 263 264 $$($1_OVERVIEW): $$($1_OVERVIEW_VARDEPS_FILE) 265 $$(call LogInfo, Creating overview.html for $1) 266 $$(call MakeDir, $$(@D)) 267 $$(PRINTF) > $$@ '$$($1_OVERVIEW_TEXT)' 268 endef 269 270 ################################################################################ 271 # Setup make rules to create an API documentation collection, using javadoc and 272 # other tools if needed. 273 # 274 # Parameter 1 is the name of the rule. This name is used as variable prefix. 275 # Targets generated are returned as $1_JAVADOC_TARGETS and 276 # $1_GRAPHS_TARGETS. Note that the index.html file will work as a "touch 277 # file" for all the magnitude of files that are generated by javadoc. 278 # 279 # Remaining parameters are named arguments. These include: 280 # MODULES - Modules to generate javadoc for 281 # GROUPS - Name of the groups to divide the modules into, if any 282 # SHORT_NAME - The short name of this documentation collection 283 # LONG_NAME - The long name of this documentation collection 284 # TARGET_DIR - Where to store the output 285 # OTHER_VERSIONS - URL for other page listing versions 286 # 287 SetupApiDocsGeneration = $(NamedParamsMacroTemplate) 288 define SetupApiDocsGenerationBody 289 290 # Figure out all modules, both specified and transitive indirect exports, that 291 # will be processed by javadoc. 292 $1_INDIRECT_EXPORTS := $$(call FindTransitiveIndirectDepsForModules, $$($1_MODULES)) 293 $1_ALL_MODULES := $$(sort $$($1_MODULES) $$($1_INDIRECT_EXPORTS)) 294 295 $1_JAVA_ARGS := -Dextlink.spec.version=$$(VERSION_SPECIFICATION) \ 296 -Djspec.version=$$(VERSION_SPECIFICATION) 297 298 ifeq ($$(ENABLE_FULL_DOCS), true) 299 $1_SEALED_GRAPHS_DIR := $$(SUPPORT_OUTPUTDIR)/docs/$1-sealed-graphs 300 301 # Tell the ModuleGraph and SealedGraph taglets to generate html links to 302 # soon-to-be-created svg files with module/sealed graphs. 303 $1_JAVA_ARGS += -DenableModuleGraph=true -DsealedDotOutputDir=$$($1_SEALED_GRAPHS_DIR) 304 $$(call MakeDir, $$($1_SEALED_GRAPHS_DIR)) 305 endif 306 307 # Start with basic options and tags 308 ifeq ($$($1_OPTIONS), ) 309 $1_OPTIONS := $$(JAVADOC_OPTIONS) 310 endif 311 ifeq ($$($1_TAGS), ) 312 $1_TAGS := $$(JAVADOC_TAGS) 313 endif 314 $1_OPTIONS += $$($1_TAGS) 315 316 $1_OPTIONS += --module-source-path $$(MODULES_SOURCE_PATH) 317 $1_OPTIONS += --module $$(call CommaList, $$($1_MODULES)) 318 319 # Create a string like "-Xdoclint:all,-syntax,-html,..." 320 $1_OPTIONS += -Xdoclint:all,$$(call CommaList, $$(addprefix -, \ 321 $$(JAVADOC_DISABLED_DOCLINT_WARNINGS))) 322 # Ignore the doclint warnings in certain packages 323 $1_OPTIONS += -Xdoclint/package:$$(call CommaList, $$(addprefix -, \ 324 $$(JAVADOC_DISABLED_DOCLINT_PACKAGES))) 325 $1_OPTIONS += $$(JAVA_WARNINGS_ARE_ERRORS) 326 327 $1_DOC_TITLE := $$($1_LONG_NAME)<br>Version $$(VERSION_SPECIFICATION) API \ 328 Specification 329 $1_WINDOW_TITLE := $$(subst &,&,$$($1_SHORT_NAME))$$(DRAFT_MARKER_TITLE) 330 $1_HEADER_TITLE := <div><strong>$$($1_SHORT_NAME)</strong> \ 331 $$(DRAFT_MARKER_STR)</div> 332 ifneq ($$($1_OTHER_VERSIONS), ) 333 $1_JAVADOC_BOTTOM := $$(call JAVADOC_BOTTOM, <a href="$$($1_OTHER_VERSIONS)">Other versions.</a>) 334 else 335 $1_JAVADOC_BOTTOM := $$(call JAVADOC_BOTTOM, ) 336 endif 337 338 $1_OPTIONS += -doctitle '$$($1_DOC_TITLE)' 339 $1_OPTIONS += -windowtitle '$$($1_WINDOW_TITLE)' 340 $1_OPTIONS += -header '$$($1_HEADER_TITLE)' 341 $1_OPTIONS += -bottom '$$($1_JAVADOC_BOTTOM)' 342 ifeq ($$(IS_DRAFT), true) 343 $1_OPTIONS += -top '$$(JAVADOC_TOP)' 344 endif 345 346 # Do not store debug level options in VARDEPS. 347 ifneq ($$(LOG_LEVEL), trace) 348 $1_LOG_OPTION += -quiet 349 else 350 $1_LOG_OPTION += -verbose 351 endif 352 353 # Generate the overview.html file. This will return the filename in 354 # $1_OVERVIEW. 355 $$(eval $$(call create_overview_file,$1)) 356 $1_OPTIONS += -overview $$($1_OVERVIEW) 357 358 # Add summary pages for new/deprecated APIs in recent releases 359 $1_OPTIONS += --since $(call CommaList, \ 360 $(filter-out $(VERSION_DOCS_API_SINCE), \ 361 $(call sequence, $(VERSION_DOCS_API_SINCE), $(VERSION_FEATURE)))) 362 $1_OPTIONS += --since-label "New API since JDK $(VERSION_DOCS_API_SINCE)" 363 364 $$(foreach g, $$($1_GROUPS), \ 365 $$(eval $1_OPTIONS += -group "$$($$g_GROUP_NAME)" "$$($$g_GROUP_MODULES)") \ 366 ) 367 368 ifeq ($$($1_JAVADOC_CMD), ) 369 $1_JAVADOC_CMD := $$(JAVA) -Djava.awt.headless=true $$($1_JAVA_ARGS) \ 370 $$(NEW_JAVADOC) 371 else 372 $1_OPTIONS += $$(addprefix -J, $$($1_JAVA_ARGS)) 373 endif 374 375 $1_VARDEPS := $$($1_JAVA_ARGS) $$($1_OPTIONS) $$(MODULES_SOURCE_PATH) \ 376 $$($1_ALL_MODULES) $$($1_JAVADOC_CMD) 377 $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, \ 378 $$(SUPPORT_OUTPUTDIR)/docs/$1.vardeps) 379 380 # Get a list of all files in all the source dirs for all included modules 381 $1_SOURCE_DEPS := $$(call FindFiles, $$(wildcard $$(foreach module, \ 382 $$($1_ALL_MODULES), $$(call FindModuleSrcDirs, $$(module))))) 383 384 $$(eval $$(call SetupExecute, javadoc_$1, \ 385 WARN := Generating $1 javadoc for $$(words $$($1_ALL_MODULES)) modules, \ 386 INFO := Javadoc modules: $$($1_ALL_MODULES), \ 387 DEPS := $$(BUILD_TOOLS_JDK) $$($1_VARDEPS_FILE) $$($1_SOURCE_DEPS) \ 388 $$($1_OVERVIEW), \ 389 OUTPUT_DIR := $$($1_TARGET_DIR), \ 390 SUPPORT_DIR := $$(SUPPORT_OUTPUTDIR)/docs, \ 391 COMMAND := $$($1_JAVADOC_CMD) -d $$($1_TARGET_DIR) $$($1_OPTIONS) \ 392 $$($1_LOG_OPTION), \ 393 )) 394 395 $1_JAVADOC_TARGETS := $$(javadoc_$1_TARGET) 396 397 ifeq ($$(ENABLE_FULL_DOCS), true) 398 # We have asked ModuleGraph to generate links to svg files. Now we must 399 # produce the svg files. 400 401 # Locate which modules has the @moduleGraph tag in their module-info.java 402 $1_MODULES_NEEDING_GRAPH := $$(strip $$(foreach m, $$($1_ALL_MODULES), \ 403 $$(if $$(shell $$(GREP) -e @moduleGraph \ 404 $$(wildcard $$(addsuffix /module-info.java, \ 405 $$(call FindModuleSrcDirs, $$m)))), \ 406 $$m) \ 407 )) 408 409 # First we run the GenGraph tool. It will query the module structure of the 410 # running JVM and output .dot files for all existing modules. 411 MODULE_GRAPHS_PROPS := \ 412 $$(TOPDIR)/make/jdk/src/classes/build/tools/jigsaw/javadoc-graphs.properties 413 414 $1_MODULE_GRAPHS_DIR := $$(SUPPORT_OUTPUTDIR)/docs/$1-module-graphs 415 416 $$(eval $$(call SetupExecute, module_graphs_dot_$1, \ 417 INFO := Generating module graphs for $1 documentation, \ 418 DEPS := $$(BUILD_JIGSAW_TOOLS) $$(MODULE_GRAPHS_PROPS), \ 419 OUTPUT_DIR := $$($1_MODULE_GRAPHS_DIR), \ 420 COMMAND := $$(TOOL_GENGRAPHS) --spec --output $$($1_MODULE_GRAPHS_DIR) \ 421 --dot-attributes $$(MODULE_GRAPHS_PROPS), \ 422 )) 423 424 # For each module needing a graph, create a svg file from the dot file 425 # generated by the GenGraphs tool and store it in the target dir. 426 # They will depend on module_graphs_dot_$1_TARGET, and will be added to 427 # $1_GRAPHS_TARGETS. 428 $$(foreach m, $$($1_MODULES_NEEDING_GRAPH), \ 429 $$(eval $$(call setup_module_graph_dot_to_svg,$1,$$m)) \ 430 ) 431 432 # We have asked SealedGraph to generate dot files and links to svg files. 433 # Now we must produce the svg files from the dot files. 434 435 # Get a list of classes for which SealedGraph has generated dot files 436 $1_SEALED_CLASSES := $$(patsubst %.dot,%,$$(patsubst \ 437 $$($1_SEALED_GRAPHS_DIR)/%,%, \ 438 $$(wildcard $$($1_SEALED_GRAPHS_DIR)/*.dot))) 439 440 # For each class needing a graph, create a svg file from the dot file 441 # generated by the SealedGraph taglet and store it in the target dir. 442 # They will will be added to $1_GRAPHS_TARGETS. 443 $$(foreach c, $$($1_SEALED_CLASSES), \ 444 $$(eval $$(call setup_sealed_graph_dot_to_svg,$1,$$c)) \ 445 ) 446 endif 447 endef 448 449 ################################################################################ 450 # Setup generation of the JDK API documentation (javadoc + graphs) 451 452 # Define the groups of the JDK API documentation 453 JavaSE_GROUP_NAME := Java SE 454 JavaSE_GROUP_MODULES := $(call ColonList, $(sort java.se \ 455 $(call FindTransitiveIndirectDepsForModules, java.se))) 456 JavaSE_GROUP_DESCRIPTION := \ 457 The Java Platform, Standard Edition (Java SE) APIs define the core Java \ 458 platform for general-purpose computing. These APIs are in modules whose \ 459 names start with {@code java}. \ 460 # 461 JDK_GROUPS += JavaSE 462 463 JDK_GROUP_NAME := JDK 464 JDK_GROUP_MODULES := jdk.* 465 JDK_GROUP_DESCRIPTION := \ 466 The Java Development Kit (JDK) APIs are specific to the JDK and will not \ 467 necessarily be available in all implementations of the Java SE Platform. \ 468 These APIs are in modules whose names start with {@code jdk}. \ 469 # 470 JDK_GROUPS += JDK 471 472 # If we are importing JavaFX, we need a JavaFX group. In an ideal world, this 473 # would have been abstracted away to a more proper generic handling of imported 474 # modules. 475 ifneq ($(findstring javafx., $(IMPORTED_MODULES)), ) 476 JavaFX_GROUP_NAME := JavaFX 477 JavaFX_GROUP_MODULES := javafx.* 478 JavaFX_GROUP_DESCRIPTION := \ 479 The JavaFX APIs define a set of user-interface controls, graphics, \ 480 media, and web packages for developing rich client applications. These \ 481 APIs are in modules whose names start with {@code javafx}. \ 482 # 483 JDK_GROUPS += JavaFX 484 endif 485 486 # All modules to have docs generated by docs-jdk-api target 487 JDK_MODULES := $(sort $(filter-out $(MODULES_FILTER), $(DOCS_MODULES))) 488 489 $(eval $(call SetupApiDocsGeneration, JDK_API, \ 490 MODULES := $(JDK_MODULES), \ 491 GROUPS := $(JDK_GROUPS), \ 492 SHORT_NAME := $(JDK_SHORT_NAME), \ 493 LONG_NAME := $(JDK_LONG_NAME), \ 494 TARGET_DIR := $(DOCS_OUTPUTDIR)/api, \ 495 OTHER_VERSIONS := $(OTHER_JDK_VERSIONS_URL), \ 496 )) 497 498 # Targets generated are returned in JDK_API_JAVADOC_TARGETS and 499 # JDK_API_GRAPHS_TARGETS. 500 501 ################################################################################ 502 # Setup generation of the Java SE API documentation (javadoc + graphs) 503 504 # The Java SE module scope is just java.se and its transitive indirect 505 # exports. 506 JAVASE_MODULES := java.se 507 508 $(eval $(call SetupApiDocsGeneration, JAVASE_API, \ 509 MODULES := $(JAVASE_MODULES), \ 510 SHORT_NAME := $(JAVASE_SHORT_NAME), \ 511 LONG_NAME := $(JAVASE_LONG_NAME), \ 512 TARGET_DIR := $(DOCS_JAVASE_IMAGE_DIR)/api, \ 513 )) 514 515 # Targets generated are returned in JAVASE_API_JAVADOC_TARGETS and 516 # JAVASE_API_GRAPHS_TARGETS. 517 518 ################################################################################ 519 # Setup generation of the reference Java SE API documentation (javadoc + graphs) 520 521 # The reference javadoc is just the same as javase, but using the BootJDK javadoc 522 # and a stable set of javadoc options. Typically it is used for generating 523 # diffs between the reference javadoc and a javadoc bundle of a specific build 524 # generated in the same way. 525 526 $(eval $(call SetupApiDocsGeneration, REFERENCE_API, \ 527 MODULES := $(JAVASE_MODULES), \ 528 SHORT_NAME := $(JAVASE_SHORT_NAME), \ 529 LONG_NAME := $(JAVASE_LONG_NAME), \ 530 TARGET_DIR := $(DOCS_REFERENCE_IMAGE_DIR)/api, \ 531 JAVADOC_CMD := $(DOCS_REFERENCE_JAVADOC), \ 532 OPTIONS := $(REFERENCE_OPTIONS), \ 533 TAGS := $(REFERENCE_TAGS), \ 534 )) 535 536 # Targets generated are returned in REFERENCE_API_JAVADOC_TARGETS and 537 # REFERENCE_API_GRAPHS_TARGETS. 538 539 ################################################################################ 540 541 # Use this variable to control which spec files are included in the output. 542 # Format: space-delimited list of names, including at most one '%' as a 543 # wildcard. Spec source files match if their filename or any enclosing folder 544 # name matches one of the items in SPEC_FILTER. 545 SPEC_FILTER := % 546 547 ApplySpecFilter = \ 548 $(strip $(foreach file, $(1), \ 549 $(eval searchkeys := $(subst /, ,$(subst $(WORKSPACE_ROOT),,$(file)))) \ 550 $(if $(filter $(SPEC_FILTER), $(searchkeys)), \ 551 $(file) \ 552 ) \ 553 )) 554 555 # Copy the global resources, including the top-level redirect index.html 556 GLOBAL_SPECS_RESOURCES_DIR := $(TOPDIR)/make/data/docs-resources 557 $(eval $(call SetupCopyFiles, COPY_GLOBAL_RESOURCES, \ 558 SRC := $(GLOBAL_SPECS_RESOURCES_DIR), \ 559 FILES := $(call ApplySpecFilter, $(call FindFiles, $(GLOBAL_SPECS_RESOURCES_DIR))), \ 560 DEST := $(DOCS_OUTPUTDIR), \ 561 )) 562 JDK_INDEX_TARGETS += $(COPY_GLOBAL_RESOURCES) 563 564 # Copy the legal notices distributed with the docs bundle 565 $(eval $(call SetupCopyFiles, COPY_DOCS_LEGAL_NOTICES, \ 566 SRC := $(TOPDIR)/src/jdk.javadoc/share/legal, \ 567 FILES := $(call ApplySpecFilter, $(wildcard $(TOPDIR)/src/jdk.javadoc/share/legal/*)), \ 568 DEST := $(DOCS_OUTPUTDIR)/legal, \ 569 )) 570 JDK_INDEX_TARGETS += $(COPY_DOCS_LEGAL_NOTICES) 571 572 ################################################################################ 573 # Copy JDK specs files 574 575 # For all non html/md files in $module/share/specs directories, copy them 576 # unmodified 577 578 ALL_MODULES := $(call FindAllModules) 579 COPY_SPEC_FILTER := %.gif %.jpg %.mib %.css 580 581 $(foreach m, $(ALL_MODULES), \ 582 $(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \ 583 $(foreach d, $(SPECS_$m), \ 584 $(if $(call ApplySpecFilter, $(filter $(COPY_SPEC_FILTER), $(call FindFiles, $d))), \ 585 $(eval $(call SetupCopyFiles, COPY_$m, \ 586 SRC := $d, \ 587 FILES := $(call ApplySpecFilter, $(filter $(COPY_SPEC_FILTER), $(call FindFiles, $d))), \ 588 DEST := $(DOCS_OUTPUTDIR)/specs/, \ 589 )) \ 590 $(eval JDK_SPECS_TARGETS += $(COPY_$m)) \ 591 ) \ 592 ) \ 593 ) 594 595 # Create copyright footer variables. We need different variables for different 596 # relative paths to the copyright.html file. The number 0-2 below represent how 597 # many extra directory levels down below the specs dir the specs html file is 598 # located. 599 SPECS_BOTTOM = <footer class="legal-footer"><hr/>$(COPYRIGHT_BOTTOM)</footer> 600 # The legal dir is one ../ below the specs dir, so start with one ../. 601 specs_bottom_rel_path := ../ 602 $(foreach n, 0 1 2, \ 603 $(eval SPECS_BOTTOM_$n := $(call SPECS_BOTTOM,$(specs_bottom_rel_path))) \ 604 $(eval specs_bottom_rel_path := $(specs_bottom_rel_path)../) \ 605 ) 606 607 SPECS_TOP := $(if $(filter true, $(IS_DRAFT)), <header class="draft-header" role="banner">$(DRAFT_TEXT)</header>) 608 609 # For all html files in $module/share/specs directories, copy and add the 610 # copyright footer. 611 612 $(foreach m, $(ALL_MODULES), \ 613 $(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \ 614 $(foreach d, $(SPECS_$m), \ 615 $(foreach f, $(call ApplySpecFilter, $(filter %.html, $(call FindFiles, $d))), \ 616 $(eval $m_$f_NOF_SUBDIRS := $(words $(subst /, $(SPACE), $(subst $d, , $(dir $f))))) \ 617 $(eval $m_$f_NAME := PROCESS_HTML_$m_$(strip $(call RelativePath, $f, $(TOPDIR)))) \ 618 $(eval $(call SetupTextFileProcessing, $($m_$f_NAME), \ 619 SOURCE_FILES := $f, \ 620 SOURCE_BASE_DIR := $d, \ 621 OUTPUT_DIR := $(DOCS_OUTPUTDIR)/specs/, \ 622 REPLACEMENTS := \ 623 <body> => <body>$(SPECS_TOP) ; \ 624 </body> => $(SPECS_BOTTOM_$($m_$f_NOF_SUBDIRS))</body>, \ 625 )) \ 626 $(eval JDK_SPECS_TARGETS += $($($m_$f_NAME))) \ 627 ) \ 628 ) \ 629 ) 630 631 ifeq ($(ENABLE_PANDOC), true) 632 # For all markdown files in $module/share/specs directories, convert them to 633 # html, if we have pandoc (otherwise we'll just skip this). 634 635 GLOBAL_SPECS_DEFAULT_CSS_FILE := $(DOCS_OUTPUTDIR)/resources/jdk-default.css 636 # Unset the following to suppress the link to the tool guides 637 NAV_LINK_GUIDES := --nav-link-guides 638 HEADER_RIGHT_SIDE_INFO := <strong>$(subst &,&,$(JDK_SHORT_NAME))</strong>$(DRAFT_MARKER_STR) 639 640 $(foreach m, $(ALL_MODULES), \ 641 $(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \ 642 $(foreach d, $(SPECS_$m), \ 643 $(foreach f, $(call ApplySpecFilter, $(filter %.md, $(call FindFiles, $d))), \ 644 $(eval $m_$f_NOF_SUBDIRS := $(words $(subst /, $(SPACE), $(subst $d, , $(dir $f))))) \ 645 $(eval $m_$f_NAME := SPECS_TO_HTML_$m_$(strip $(call RelativePath, $f, $(TOPDIR)))) \ 646 $(eval $(call SetupProcessMarkdown, $($m_$f_NAME), \ 647 SRC := $d, \ 648 FILES := $f, \ 649 DEST := $(DOCS_OUTPUTDIR)/specs/, \ 650 CSS := $(GLOBAL_SPECS_DEFAULT_CSS_FILE), \ 651 OPTIONS := -V include-before='$(SPECS_TOP)' -V include-after='$(SPECS_BOTTOM_$($m_$f_NOF_SUBDIRS))', \ 652 REPLACEMENTS := \ 653 @@VERSION_SPECIFICATION@@ => $(VERSION_SPECIFICATION) ; \ 654 @@VERSION_STRING@@ => $(VERSION_STRING), \ 655 POST_PROCESS := $(TOOL_FIXUPPANDOC) --insert-nav --nav-right-info '$(HEADER_RIGHT_SIDE_INFO)' \ 656 --nav-subdirs $($m_$f_NOF_SUBDIRS) $(NAV_LINK_GUIDES), \ 657 )) \ 658 $(eval JDK_SPECS_TARGETS += $($($m_$f_NAME))) \ 659 ) \ 660 ) \ 661 ) 662 663 # For all markdown files in $module/share/man directories, convert them to 664 # html. 665 666 # Create dynamic man pages from markdown using pandoc. We need 667 # PANDOC_HTML_MANPAGE_FILTER, a wrapper around 668 # PANDOC_HTML_MANPAGE_FILTER_JAVASCRIPT. This is created by buildtools-jdk. 669 670 # We should also depend on the source code for the filter 671 PANDOC_HTML_MANPAGE_FILTER_SOURCE := $(call FindFiles, \ 672 $(TOPDIR)/make/jdk/src/classes/build/tools/pandocfilter) 673 674 $(foreach m, $(ALL_MODULES), \ 675 $(eval MAN_$m := $(call ApplySpecFilter, $(filter %.md, $(call FindFiles, \ 676 $(call FindModuleManDirsForDocs, $m))))) \ 677 $(if $(MAN_$m), \ 678 $(eval $(call SetupProcessMarkdown, MAN_TO_HTML_$m, \ 679 FILES := $(MAN_$m), \ 680 DEST := $(DOCS_OUTPUTDIR)/specs/man, \ 681 FILTER := $(PANDOC_HTML_MANPAGE_FILTER), \ 682 CSS := $(GLOBAL_SPECS_DEFAULT_CSS_FILE), \ 683 REPLACEMENTS := \ 684 @@COPYRIGHT_YEAR@@ => $(COPYRIGHT_YEAR) ; \ 685 @@VERSION_SHORT@@ => $(VERSION_SHORT) ; \ 686 @@VERSION_SPECIFICATION@@ => $(VERSION_SPECIFICATION), \ 687 OPTIONS := --toc -V include-before='$(SPECS_TOP)' -V include-after='$(SPECS_BOTTOM_1)', \ 688 POST_PROCESS := $(TOOL_FIXUPPANDOC) --insert-nav --nav-right-info '$(HEADER_RIGHT_SIDE_INFO)' \ 689 --nav-subdirs 1 --nav-link-guides, \ 690 EXTRA_DEPS := $(PANDOC_HTML_MANPAGE_FILTER) \ 691 $(PANDOC_HTML_MANPAGE_FILTER_SOURCE), \ 692 )) \ 693 $(eval JDK_SPECS_TARGETS += $(MAN_TO_HTML_$m)) \ 694 ) \ 695 ) 696 697 # The html generated from markdown also needs the css file 698 JDK_SPECS_TARGETS += $(COPY_GLOBAL_RESOURCES) 699 endif 700 701 # Special treatment for generated documentation 702 703 SPEC_HEADER_BLOCK := \ 704 <header id="title-block-header"> \ 705 <div class="navbar"> \ 706 <div>$(HEADER_RIGHT_SIDE_INFO)</div> \ 707 <nav><ul><li><a href="PATH_TO_SPECS/../api/index.html">API</a> \ 708 <li><a href="PATH_TO_SPECS/index.html">OTHER SPECIFICATIONS</a> \ 709 <li><a href="PATH_TO_SPECS/man/index.html">TOOL GUIDES</a></ul></nav> \ 710 </div> \ 711 </header> 712 713 JDWP_PROTOCOL := $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html 714 ifneq ($(call ApplySpecFilter, $(JDWP_PROTOCOL)), ) 715 JDWP_HEADER_BLOCK := $(subst PATH_TO_SPECS,..,$(SPEC_HEADER_BLOCK)) 716 $(eval $(call SetupTextFileProcessing, PROCESS_JDWP_PROTOCOL, \ 717 SOURCE_FILES := $(JDWP_PROTOCOL), \ 718 OUTPUT_DIR := $(DOCS_OUTPUTDIR)/specs/jdwp, \ 719 REPLACEMENTS := \ 720 <style> => <link rel="stylesheet" href="../../resources/jdk-default.css"/><style> ; \ 721 <body> => <body>$(SPECS_TOP)$(JDWP_HEADER_BLOCK) ; \ 722 </body> => $(SPECS_BOTTOM_1)</body>, \ 723 )) 724 JDK_SPECS_TARGETS += $(PROCESS_JDWP_PROTOCOL) 725 endif 726 727 # Get jvmti.html from the main jvm variant (all variants' jvmti.html are identical). 728 JVMTI_HTML ?= $(HOTSPOT_OUTPUTDIR)/variant-$(JVM_VARIANT_MAIN)/gensrc/jvmtifiles/jvmti.html 729 ifneq ($(call ApplySpecFilter, $(JVMTI_HTML)), ) 730 JVMTI_HEADER_BLOCK := $(subst PATH_TO_SPECS,.,$(SPEC_HEADER_BLOCK)) 731 $(eval $(call SetupTextFileProcessing, PROCESS_JVMTI_HTML, \ 732 SOURCE_FILES := $(JVMTI_HTML), \ 733 OUTPUT_DIR := $(DOCS_OUTPUTDIR)/specs/, \ 734 REPLACEMENTS := \ 735 <style> => <link rel="stylesheet" href="../resources/jdk-default.css"/><style> ; \ 736 <body> => <body>$(SPECS_TOP)$(JVMTI_HEADER_BLOCK) ; \ 737 </body> => $(SPECS_BOTTOM_0)</body>, \ 738 )) 739 JDK_SPECS_TARGETS += $(PROCESS_JVMTI_HTML) 740 endif 741 742 ################################################################################ 743 # Optional target which bundles all generated javadocs into a zip archive. 744 745 JAVADOC_ZIP_NAME := jdk-$(VERSION_STRING)-docs.zip 746 JAVADOC_ZIP_FILE := $(OUTPUTDIR)/bundles/$(JAVADOC_ZIP_NAME) 747 748 $(eval $(call SetupZipArchive, BUILD_JAVADOC_ZIP, \ 749 SRC := $(DOCS_OUTPUTDIR), \ 750 ZIP := $(JAVADOC_ZIP_FILE), \ 751 EXTRA_DEPS := $(JDK_API_JAVADOC_TARGETS) $(JDK_API_GRAPHS_TARGETS) \ 752 $(JDK_SPECS_TARGETS), \ 753 )) 754 755 ZIP_TARGETS += $(BUILD_JAVADOC_ZIP) 756 757 ################################################################################ 758 # Bundles all generated specs into a zip archive, skipping javadocs. 759 760 SPECS_ZIP_NAME := jdk-$(VERSION_STRING)-specs.zip 761 SPECS_ZIP_FILE := $(OUTPUTDIR)/bundles/$(SPECS_ZIP_NAME) 762 763 $(eval $(call SetupZipArchive, BUILD_SPECS_ZIP, \ 764 SRC := $(DOCS_OUTPUTDIR), \ 765 ZIP := $(SPECS_ZIP_FILE), \ 766 EXTRA_DEPS := $(JDK_SPECS_TARGETS), \ 767 )) 768 769 SPECS_ZIP_TARGETS += $(BUILD_SPECS_ZIP) 770 771 ################################################################################ 772 773 docs-jdk-api-javadoc: $(JDK_API_JAVADOC_TARGETS) $(JDK_API_CUSTOM_TARGETS) 774 775 docs-jdk-api-graphs: $(JDK_API_GRAPHS_TARGETS) 776 777 docs-javase-api-javadoc: $(JAVASE_API_JAVADOC_TARGETS) $(JAVASE_API_CUSTOM_TARGETS) 778 779 docs-javase-api-graphs: $(JAVASE_API_GRAPHS_TARGETS) 780 781 docs-reference-api-javadoc: $(REFERENCE_API_JAVADOC_TARGETS) $(REFERENCE_API_CUSTOM_TARGETS) 782 783 docs-reference-api-graphs: $(REFERENCE_API_GRAPHS_TARGETS) 784 785 docs-jdk-specs: $(JDK_SPECS_TARGETS) 786 787 docs-jdk-index: $(JDK_INDEX_TARGETS) 788 789 docs-zip: $(ZIP_TARGETS) 790 791 docs-specs-zip: $(SPECS_ZIP_TARGETS) 792 793 all: docs-jdk-api-javadoc docs-jdk-api-graphs docs-javase-api-javadoc \ 794 docs-javase-api-graphs docs-reference-api-javadoc \ 795 docs-reference-api-graphs docs-jdk-specs docs-jdk-index docs-zip \ 796 docs-specs-zip 797 798 .PHONY: docs-jdk-api-javadoc docs-jdk-api-graphs \ 799 docs-javase-api-javadoc docs-javase-api-graphs \ 800 docs-reference-api-javadoc docs-reference-api-graphs docs-jdk-specs \ 801 docs-jdk-index docs-zip docs-specs-zip 802 803 ################################################################################ 804 805 include MakeFileEnd.gmk