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 $(SPEC) 26 include MakeBase.gmk 27 28 ################################################################# 29 # 30 # CORE_PKGS environment variable has been moved to the following file 31 # 32 include CORE_PKGS.gmk 33 # 34 # Load environment variables for API package names that are not part of 35 # the Java SE platform 36 # 37 include NON_CORE_PKGS.gmk 38 39 40 .SUFFIXES: # Delete the default suffixes 41 .SUFFIXES: .java 42 43 # 44 # Definitions for directories 45 # 46 47 DOCSDIR := $(DOCS_IMAGE_DIR) 48 DOCSTMPDIR = $(SUPPORT_OUTPUTDIR)/docs 49 50 HOTSPOT_DOCS_IMPORT_PATH=$(HOTSPOT_OUTPUTDIR)/docs 51 52 JAVADOC_CMD = $(JAVA) \ 53 -Djava.awt.headless=true \ 54 $(NEW_JAVADOC) 55 56 JAVADOC_CMD_SMALL = $(JAVA_SMALL) \ 57 -Djava.awt.headless=true \ 58 $(NEW_JAVADOC) 59 60 # Copyright year for beginning of Java and some of the apis 61 # (Needed when creating the javadocs) 62 FIRST_COPYRIGHT_YEAR = 1993 63 DOMAPI_FIRST_COPYRIGHT_YEAR = 2005 64 MIRROR_FIRST_COPYRIGHT_YEAR = 2004 65 DOCLETAPI_FIRST_COPYRIGHT_YEAR = 1993 66 TAGLETAPI_FIRST_COPYRIGHT_YEAR = 1993 67 JDI_FIRST_COPYRIGHT_YEAR = 1999 68 JAAS_FIRST_COPYRIGHT_YEAR = 1998 69 JGSS_FIRST_COPYRIGHT_YEAR = 2000 70 SMARTCARDIO_FIRST_COPYRIGHT_YEAR = 2005 71 HTTPSERVER_FIRST_COPYRIGHT_YEAR = 2005 72 MGMT_FIRST_COPYRIGHT_YEAR = 2003 73 ATTACH_FIRST_COPYRIGHT_YEAR = 2005 74 JCONSOLE_FIRST_COPYRIGHT_YEAR = 2006 75 SCTPAPI_FIRST_COPYRIGHT_YEAR = 2009 76 TRACING_FIRST_COPYRIGHT_YEAR = 2008 77 JSHELLAPI_FIRST_COPYRIGHT_YEAR = 2015 78 TREEAPI_FIRST_COPYRIGHT_YEAR = 2005 79 NASHORNAPI_FIRST_COPYRIGHT_YEAR = 2014 80 DYNALINKAPI_FIRST_COPYRIGHT_YEAR = 2015 81 JNLP_FIRST_COPYRIGHT_YEAR = 1998 82 PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007 83 JDKNET_FIRST_COPYRIGHT_YEAR = 2014 84 JACCESSAPI_FIRST_COPYRIGHT_YEAR = 2002 85 JSOBJECT_FIRST_COPYRIGHT_YEAR = 1993 86 87 # Oracle name 88 FULL_COMPANY_NAME = Oracle and/or its affiliates 89 90 # Copyright address 91 COMPANY_ADDRESS = 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA. 92 93 # The trademark symbol 94 TRADEMARK = ™ 95 96 # Common copyright lines used 97 # The word "Copyright" might optionally be a link to the file cpyr.html. 98 # The first year of copyright may vary or not be available. 99 # The address to the company might be optional. 100 COMMA:= , 101 EMPTY:= 102 SPACE:=$(EMPTY) $(EMPTY) 103 COPYRIGHT_SYMBOL = &\#x00a9; 104 # Macro to construct the copyright line 105 # (The GNU make 3.78.1 "if" conditional is broken, fixed in GNU make 3.81) 106 define CopyrightLine # optionalurl optionalfirstyear optionaladdress 107 $(if $(strip $1),<a href="$(strip $1)">Copyright</a>,Copyright) \ 108 $(COPYRIGHT_SYMBOL) $(if $2,$2${COMMA},) $(COPYRIGHT_YEAR),\ 109 $(FULL_COMPANY_NAME). $3 All rights reserved. 110 endef 111 112 # Url to root of documents 113 DOCSDIR_URL = {@docroot}/$(GET2DOCSDIR) 114 115 # Url to copyright html file 116 COPYRIGHT_URL = $(DOCSDIR_URL)/legal/cpyr.html 117 118 # Url to bug filing site 119 BUG_SUBMIT_URL = http://bugreport.java.com/bugreport/ 120 121 # Common line for how to submit a bug or rfe 122 BUG_SUBMIT_LINE = <a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a> 123 124 # Url to devdocs page 125 DOCS_BASE_URL = http://docs.oracle.com/javase/$(VERSION_SPECIFICATION)/docs 126 DEV_DOCS_URL = $(DOCS_BASE_URL)/index.html 127 128 # Common Java trademark line 129 JAVA_TRADEMARK_LINE = Java is a trademark or registered trademark of \ 130 $(FULL_COMPANY_NAME) in the US and other countries. 131 132 ################################################################# 133 # Macros: 134 135 136 # List of all possible directories for javadoc to look for sources 137 # NOTE: Quotes are required around sourcepath argument only on Windows. 138 # Otherwise, you get "No packages or classes specified." due 139 # to $(PATH_SEP) being interpreted as an end of 140 # command (newline or shell ; character) 141 ALL_SOURCE_DIRS := $(wildcard \ 142 $(SUPPORT_OUTPUTDIR)/gensrc/j* \ 143 $(if $(IMPORT_MODULES_SRC), $(IMPORT_MODULES_SRC)/*) \ 144 $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS)/classes \ 145 $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS_TYPE)/classes \ 146 $(JDK_TOPDIR)/src/*/share/classes \ 147 $(HOTSPOT_TOPDIR)/src/*/share/classes \ 148 $(LANGTOOLS_TOPDIR)/src/*/share/classes \ 149 $(NASHORN_TOPDIR)/src/*/share/classes \ 150 $(CORBA_TOPDIR)/src/*/share/classes \ 151 $(JAXP_TOPDIR)/src/*/share/classes \ 152 $(JAXWS_TOPDIR)/src/*/share/classes \ 153 $(SUPPORT_OUTPUTDIR)/rmic/j* \ 154 $(JDK_TOPDIR)/src/*/share/doc/stub \ 155 ) \ 156 # 157 158 ALL_MODULE_SOURCE_DIRS := \ 159 $(SUPPORT_OUTPUTDIR)/gensrc/* \ 160 $(if $(IMPORT_MODULES_SRC), $(IMPORT_MODULES_SRC)/*) \ 161 $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS)/classes \ 162 $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS_TYPE)/classes \ 163 $(JDK_TOPDIR)/src/*/share/classes \ 164 $(HOTSPOT_TOPDIR)/src/*/share/classes \ 165 $(LANGTOOLS_TOPDIR)/src/*/share/classes \ 166 $(NASHORN_TOPDIR)/src/*/share/classes \ 167 $(CORBA_TOPDIR)/src/*/share/classes \ 168 $(JAXP_TOPDIR)/src/*/share/classes \ 169 $(JAXWS_TOPDIR)/src/*/share/classes \ 170 $(SUPPORT_OUTPUTDIR)/rmic/* \ 171 $(JDK_TOPDIR)/src/*/share/doc/stub \ 172 # 173 174 175 # List with classpath separator between them 176 EMPTY:= 177 SPACE:= $(EMPTY) $(EMPTY) 178 RELEASEDOCS_SOURCEPATH = \ 179 $(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_SOURCE_DIRS))) 180 181 RELEASEDOCS_MODULESOURCEPATH = \ 182 $(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_MODULE_SOURCE_DIRS))) 183 184 define prep-target 185 $(MKDIR) -p $(@D) 186 $(RM) $@ 187 endef 188 189 # Prep for javadoc creation, assumes $@ is an index.html file 190 define prep-javadoc 191 @if [ -f "$@" -a "$?" != "" ] ; then \ 192 $(ECHO) "# Dependencies have changed: $?"; \ 193 fi 194 $(RM) -r $(@D) 195 $(MKDIR) -p $(@D) 196 endef 197 198 $(eval $(call FillCacheFind, $(ALL_SOURCE_DIRS))) 199 define PackageDependencies 200 $(call CacheFind, $(wildcard $(foreach p, $(subst .,/,$1), $(addsuffix /$p, $(ALL_SOURCE_DIRS))))) 201 endef 202 203 # Given a list of packages, add packages that exist to $@, print summary 204 define PackageFilter # packages 205 @if [ "$1" != "" ] ; then \ 206 for p in $1 ; do \ 207 pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \ 208 found="false"; \ 209 for cp in $(ALL_SOURCE_DIRS) ; do \ 210 if [ -d $${cp}/$${pd} ] ; then \ 211 $(ECHO) "$${p}" >> $@; \ 212 found="true"; \ 213 break; \ 214 fi; \ 215 done; \ 216 if [ "$${found}" = "false" ] ; then \ 217 $(ECHO) "WARNING: Package not found: $${p}"; \ 218 fi; \ 219 done; \ 220 fi 221 endef 222 223 # Print out a summary of the javadoc command about to be run 224 define JavadocSummary # optionsfile packagesfile 225 @$(ECHO) "# Running javadoc for $(patsubst $(OUTPUT_ROOT)/%,%,$@)" $(LOG_WARN) 226 @($(ECHO) "# Options (`$(BASENAME) $1`):"; $(SED) -e 's@^@# @' $1) $(LOG_DEBUG) 227 @($(ECHO) "# Packages (`$(BASENAME) $2`):";$(SED) -e 's@^@# @' $2) $(LOG_DEBUG) 228 endef 229 230 # 231 # Different api directories created from root directory 232 # 233 COREAPI_DOCSDIR = $(DOCSDIR)/api 234 JDK_API_DOCSDIR = $(DOCSDIR)/jdk/api 235 JRE_API_DOCSDIR = $(DOCSDIR)/jre/api 236 PLATFORM_DOCSDIR = $(DOCSDIR)/platform 237 238 JAVADOC_ARCHIVE_NAME := jdk-$(VERSION_STRING)-docs.zip 239 JAVADOC_ARCHIVE_ASSEMBLY_DIR := $(DOCSTMPDIR)/zip-docs 240 JAVADOC_ARCHIVE_DIR := $(OUTPUT_ROOT)/bundles 241 JAVADOC_ARCHIVE := $(JAVADOC_ARCHIVE_DIR)/$(JAVADOC_ARCHIVE_NAME) 242 243 # The core api index file is the target for the core api javadocs rule 244 # and needs to be defined early so that all other javadoc rules may 245 # depend on it. 246 COREAPI_INDEX_FILE = $(COREAPI_DOCSDIR)/index.html 247 248 # The non-core api javadocs need to be able to access the root of the core 249 # api directory, so for jdk/api or jre/api to get to the core api/ 250 # directory we would use this: 251 JDKJRE2COREAPI = ../../api 252 253 # Common bottom argument 254 define CommonBottom # year 255 <font size="-1"><br> $(call CopyrightLine,,$1,)</font> 256 endef 257 258 # Common trademark bottom argument (Not sure why this is used sometimes) 259 define CommonTrademarkBottom # year 260 <font size="-1">\ 261 $(BUG_SUBMIT_LINE)<br>$(JAVA_TRADEMARK_LINE)<br>\ 262 $(call CopyrightLine,,$1,$(COMPANY_ADDRESS))\ 263 </font> 264 endef 265 266 # Common echo of option 267 define OptionOnly # opt 268 if [ "$(strip $1)" != "" ] ; then \ 269 $(PRINTF) "%s\n" "$(strip $1)"; \ 270 fi 271 endef 272 273 define OptionPair # opt arg 274 $(PRINTF) "%s '%s'\n" "$(strip $1)" '$(strip $2)' 275 endef 276 277 define OptionTrip # opt arg arg 278 $(PRINTF) "%s '%s' '%s'\n" "$(strip $1)" '$(strip $2)' '$(strip $3)' 279 endef 280 281 # Core api bottom argument (with special sauce) 282 COREAPI_BOTTOM = <font size="-1"> $(BUG_SUBMIT_LINE)\ 283 <br>For further API reference and developer documentation, \ 284 see <a href="$(DEV_DOCS_URL)" target="_blank">Java SE Documentation</a>. \ 285 That documentation contains more detailed, developer-targeted descriptions, \ 286 with conceptual overviews, definitions of terms, workarounds, \ 287 and working code examples.<br>\ 288 $(call CopyrightLine,$(COPYRIGHT_URL),$(FIRST_COPYRIGHT_YEAR),)\ 289 </font> 290 291 # Common javadoc options used by all bundles 292 293 # This flag may be overridden from a custom makefile 294 DOCROOTPARENT_FLAG = -Xdocrootparent $(DOCS_BASE_URL) 295 296 define COMMON_JAVADOCFLAGS 297 $(call OptionOnly,-XDignore.symbol.file=true) ; \ 298 $(call OptionOnly,-quiet) ; \ 299 $(call OptionOnly,-use) ; \ 300 $(call OptionOnly,-keywords) ; \ 301 $(call OptionOnly,$(DOCROOTPARENT_FLAG)) 302 endef 303 304 # Common javadoc tags used by all bundles 305 306 # Java language specification cite 307 TAG_JLS = jls:a:See <cite> \ 308 The Java™ Language Specification</cite>: 309 310 # Java virtual machine specification cite 311 TAG_JVMS = jvms:a:See <cite> \ 312 The Java™ Virtual Machine Specification</cite>: 313 314 # In order to get a specific ordering it's necessary to specify the total 315 # ordering of tags as the tags are otherwise ordered in order of definition. 316 define COMMON_JAVADOCTAGS 317 $(call OptionPair,-tag,beaninfo:X) ; \ 318 $(call OptionPair,-tag,revised:X) ; \ 319 $(call OptionPair,-tag,since.unbundled:X) ; \ 320 $(call OptionPair,-tag,spec:X) ; \ 321 $(call OptionPair,-tag,specdefault:X) ; \ 322 $(call OptionPair,-tag,Note:X) ; \ 323 $(call OptionPair,-tag,ToDo:X) ; \ 324 $(call OptionPair,-tag,apiNote:a:API Note:) ; \ 325 $(call OptionPair,-tag,implSpec:a:Implementation Requirements:) ; \ 326 $(call OptionPair,-tag,implNote:a:Implementation Note:) ; \ 327 $(call OptionPair,-tag,param) ; \ 328 $(call OptionPair,-tag,return) ; \ 329 $(call OptionPair,-tag,throws) ; \ 330 $(call OptionPair,-tag,since) ; \ 331 $(call OptionPair,-tag,version) ; \ 332 $(call OptionPair,-tag,serialData) ; \ 333 $(call OptionPair,-tag,factory) ; \ 334 $(call OptionPair,-tag,see) ; \ 335 $(call OptionPair,-tag,$(TAG_JVMS)) ; \ 336 $(call OptionPair,-tag,$(TAG_JLS)) 337 endef 338 339 340 341 # Assume we need a draft format when the version string is not a GA version. 342 ifeq ($(VERSION_IS_GA), false) 343 DRAFT_HEADER := <br><strong>DRAFT $(VERSION_STRING)</strong> 344 DRAFT_BOTTOM := <br><strong>DRAFT $(VERSION_STRING)</strong> 345 DRAFT_WINTITLE := $(VERSION_BUILD) 346 # Early access top text (not used in FCS releases) 347 COREAPI_TOP_EARLYACCESS := \ 348 <div style="background-color: \#EEEEEE"> \ 349 <div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; \ 350 margin-left: 6px; margin-right: 6px; text-align: justify; \ 351 font-size: 80%; font-family: Helvetica, Arial, sans-serif; \ 352 font-weight: normal;"> \ 353 Please note that the specifications and other information \ 354 contained herein are not final and are subject to change. \ 355 The information is being made available to you solely for purpose of \ 356 evaluation. \ 357 </div> </div> 358 else 359 DRAFT_HEADER := 360 DRAFT_BOTTOM := 361 DRAFT_WINTITLE := 362 COREAPI_TOP_EARLYACCESS := 363 endif 364 365 ################################################################# 366 367 # 368 # Load custom Javadoc rules 369 # 370 371 $(eval $(call IncludeCustomExtension, , Javadoc.gmk)) 372 373 ################################################################# 374 375 # 376 # Default target is same as docs target, create core api and all others it can 377 # 378 379 all: docs 380 docs: coredocs otherdocs 381 382 # 383 # Optional target which bundles all generated javadocs into a zip archive. 384 # The dependency on docs is handled in Main.gmk. 385 # 386 387 zip-docs: $(JAVADOC_ARCHIVE) 388 389 ############################################################# 390 # 391 # coredocs 392 # 393 COREAPI_DOCTITLE = Java$(TRADEMARK) Platform, Standard Edition \ 394 $(VERSION_SPECIFICATION)<br>API Specification 395 COREAPI_WINDOWTITLE = Java Platform SE $(VERSION_SPECIFICATION) 396 COREAPI_HEADER = \ 397 <strong>Java$(TRADEMARK) Platform<br>Standard Ed. $(VERSION_SPECIFICATION)</strong> 398 399 # Overview file for core apis 400 COREAPI_OVERVIEW = $(JDK_TOPDIR)/src/java.base/share/classes/overview-core.html 401 402 # The options and packages files 403 COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options 404 COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages 405 406 # The modules required to be documented 407 COREAPI_MODULES = java.se.ee 408 409 coredocs: $(COREAPI_INDEX_FILE) 410 411 # Set relative location to core api document root 412 $(COREAPI_INDEX_FILE): GET2DOCSDIR=.. 413 414 # Run javadoc if the index file is out of date or missing 415 $(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE) 416 $(prep-javadoc) 417 $(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE)) 418 $(JAVADOC_CMD) -d $(@D) \ 419 @$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE) 420 421 # Create file with javadoc options in it 422 $(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW) 423 $(prep-target) 424 @($(call COMMON_JAVADOCFLAGS) ; \ 425 $(call COMMON_JAVADOCTAGS) ; \ 426 $(call OptionOnly,-Xdoclint:reference) ; \ 427 $(call OptionOnly,-Xdoclint/package:-org.omg.*$(COMMA)jdk.internal.logging.*) ; \ 428 $(call OptionPair,--system,none) ; \ 429 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 430 $(call OptionPair,--add-modules,$(COREAPI_MODULES)) ; \ 431 $(call OptionPair,-encoding,ISO-8859-1) ; \ 432 $(call OptionOnly,-splitIndex) ; \ 433 $(call OptionPair,-overview,$(COREAPI_OVERVIEW)) ; \ 434 $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE)) ; \ 435 $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ; \ 436 $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER)) ; \ 437 $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 438 ) >> $@ 439 ifdef COREAPI_TOP_EARLYACCESS 440 @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@ 441 endif 442 443 # Create a file with the package names in it 444 $(COREAPI_PACKAGES_FILE): $(call PackageDependencies,$(CORE_PKGS)) 445 $(prep-target) 446 $(call PackageFilter,$(CORE_PKGS)) 447 448 ############################################################# 449 # 450 # docletapidocs 451 # 452 453 ALL_OTHER_TARGETS += docletapidocs 454 455 DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet 456 DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI) 457 DOCLETAPI_DOCTITLE := Doclet API 458 DOCLETAPI_WINDOWTITLE := Doclet API 459 DOCLETAPI_HEADER := <strong>Doclet API</strong> 460 DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR)) 461 DOCLETAPI_GROUPNAME := Packages 462 DOCLETAPI_REGEXP := jdk.javadoc.doclet* 463 # DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk 464 465 # The index.html, options, and packages files 466 DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html 467 DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options 468 DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages 469 470 # The modules required to be documented 471 DOCLETAPI_MODULES = jdk.javadoc 472 473 docletapidocs: $(DOCLETAPI_INDEX_FILE) 474 475 # Set relative location to core api document root 476 $(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/.. 477 478 # Run javadoc if the index file is out of date or missing 479 $(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 480 $(prep-javadoc) 481 $(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE)) 482 $(JAVADOC_CMD_SMALL) -d $(@D) \ 483 @$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE) 484 485 # Create file with javadoc options in it 486 $(DOCLETAPI_OPTIONS_FILE): 487 $(prep-target) 488 @($(call COMMON_JAVADOCFLAGS) ; \ 489 $(call COMMON_JAVADOCTAGS) ; \ 490 $(call OptionOnly,-Xdoclint:all) ; \ 491 $(call OptionPair,--system,none) ; \ 492 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 493 $(call OptionPair,--add-modules,$(DOCLETAPI_MODULES)) ; \ 494 $(call OptionPair,-encoding,ascii) ; \ 495 $(call OptionOnly,-breakiterator) ; \ 496 $(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \ 497 $(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 498 $(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \ 499 $(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 500 $(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \ 501 $(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 502 ) >> $@ 503 504 # Create a file with the package names in it 505 $(DOCLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(DOCLETAPI_PKGS)) 506 $(prep-target) 507 $(call PackageFilter,$(DOCLETAPI_PKGS)) 508 509 ############################################################# 510 # 511 # old docletapidocs 512 # 513 514 ALL_OTHER_TARGETS += olddocletapidocs 515 516 OLD_DOCLET_DIR := $(JDK_API_DOCSDIR)/javadoc/old 517 OLD_DOCLETAPI_DOCDIR := $(OLD_DOCLET_DIR)/doclet 518 OLD_DOCLETAPI2COREAPI := ../../../$(JDKJRE2COREAPI) 519 OLD_DOCLETAPI_DOCTITLE := Doclet API 520 OLD_DOCLETAPI_WINDOWTITLE := Doclet API 521 OLD_DOCLETAPI_HEADER := <strong>Doclet API</strong> 522 OLD_DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR)) 523 OLD_DOCLETAPI_GROUPNAME := Packages 524 OLD_DOCLETAPI_REGEXP := com.sun.javadoc 525 # OLD_DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk 526 527 # The index.html, options, and packages files 528 OLD_DOCLETAPI_INDEX_FILE = $(OLD_DOCLETAPI_DOCDIR)/index.html 529 OLD_DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/old-docletapi.options 530 OLD_DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/old-docletapi.packages 531 532 # The modules required to be documented 533 OLD_DOCLETAPI_MODULES = jdk.javadoc 534 535 olddocletapidocs: $(OLD_DOCLETAPI_INDEX_FILE) 536 537 # Set relative location to core api document root 538 $(OLD_DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(OLD_DOCLETAPI2COREAPI)/.. 539 540 # Run javadoc if the index file is out of date or missing 541 $(OLD_DOCLETAPI_INDEX_FILE): $(OLD_DOCLETAPI_OPTIONS_FILE) $(OLD_DOCLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 542 $(prep-javadoc) 543 $(call JavadocSummary,$(OLD_DOCLETAPI_OPTIONS_FILE),$(OLD_DOCLETAPI_PACKAGES_FILE)) 544 $(JAVADOC_CMD_SMALL) -d $(@D) \ 545 @$(OLD_DOCLETAPI_OPTIONS_FILE) @$(OLD_DOCLETAPI_PACKAGES_FILE) 546 547 # Create file with javadoc options in it 548 $(OLD_DOCLETAPI_OPTIONS_FILE): 549 $(prep-target) 550 @($(call COMMON_JAVADOCFLAGS) ; \ 551 $(call COMMON_JAVADOCTAGS) ; \ 552 $(call OptionOnly,-Xdoclint:all) ; \ 553 $(call OptionPair,--system,none) ; \ 554 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 555 $(call OptionPair,--add-modules,$(OLD_DOCLETAPI_MODULES)) ; \ 556 $(call OptionPair,-encoding,ascii) ; \ 557 $(call OptionOnly,-breakiterator) ; \ 558 $(call OptionPair,-doctitle,$(OLD_DOCLETAPI_DOCTITLE)) ; \ 559 $(call OptionPair,-windowtitle,$(OLD_DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 560 $(call OptionPair,-header,$(OLD_DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \ 561 $(call OptionPair,-bottom,$(OLD_DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 562 $(call OptionTrip,-group,$(OLD_DOCLETAPI_GROUPNAME),$(OLD_DOCLETAPI_REGEXP)); \ 563 $(call OptionTrip,-linkoffline,$(OLD_DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 564 ) >> $@ 565 566 # Create a file with the package names in it 567 $(OLD_DOCLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(OLD_DOCLETAPI_PKGS)) 568 $(prep-target) 569 $(call PackageFilter,$(OLD_DOCLETAPI_PKGS)) 570 571 ############################################################# 572 # 573 # tagletapidocs 574 # 575 576 ALL_OTHER_TARGETS += tagletapidocs 577 TAGLETAPI_DOCDIR := $(OLD_DOCLET_DIR)/taglet 578 TAGLETAPI2COREAPI := ../../../$(JDKJRE2COREAPI) 579 TAGLETAPI_DOCTITLE := Taglet API 580 TAGLETAPI_WINDOWTITLE := Taglet API 581 TAGLETAPI_HEADER := <strong>Taglet API</strong> 582 TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR)) 583 # TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk 584 585 # The index.html, options, and packages files 586 TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/index.html 587 TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options 588 TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages 589 590 # The modules required to be documented 591 TAGLETAPI_MODULES = jdk.javadoc 592 593 tagletapidocs: $(TAGLETAPI_INDEX_FILE) 594 595 # Run javadoc if the index file is out of date or missing 596 $(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 597 $(prep-javadoc) 598 $(call JavadocSummary,$(TAGLETAPI_OPTIONS_FILE),$(TAGLETAPI_PACKAGES_FILE)) 599 $(JAVADOC_CMD_SMALL) -d $(@D) \ 600 @$(TAGLETAPI_OPTIONS_FILE) @$(TAGLETAPI_PACKAGES_FILE) 601 602 # Create file with javadoc options in it 603 $(TAGLETAPI_OPTIONS_FILE): 604 $(prep-target) 605 @($(call COMMON_JAVADOCFLAGS) ; \ 606 $(call COMMON_JAVADOCTAGS) ; \ 607 $(call OptionOnly,-Xdoclint:all) ; \ 608 $(call OptionPair,--system,none) ; \ 609 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 610 $(call OptionPair,--add-modules,$(TAGLETAPI_MODULES)) ; \ 611 $(call OptionPair,-encoding,ascii) ; \ 612 $(call OptionOnly,-breakiterator) ; \ 613 $(call OptionPair,-doctitle,$(TAGLETAPI_DOCTITLE)) ; \ 614 $(call OptionPair,-windowtitle,$(TAGLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 615 $(call OptionPair,-header,$(TAGLETAPI_HEADER)$(DRAFT_HEADER)) ; \ 616 $(call OptionOnly,-nonavbar) ; \ 617 $(call OptionOnly,-noindex) ; \ 618 $(call OptionPair,-bottom,$(TAGLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 619 $(call OptionTrip,-linkoffline,$(TAGLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 620 ) >> $@ 621 622 # Create a file with the package names in it 623 $(TAGLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(TAGLETAPI_PKGS)) 624 $(prep-target) 625 @($(ECHO) "$(LANGTOOLS_TOPDIR)/src/jdk.javadoc/share/classes/$(TAGLETAPI_FILE)" ) > $@ 626 627 ############################################################# 628 # 629 # domapidocs 630 # 631 632 ALL_OTHER_TARGETS += domapidocs 633 634 DOMAPI_DOCDIR := $(JRE_API_DOCSDIR)/plugin/dom 635 DOMAPI2COREAPI := ../../$(JDKJRE2COREAPI) 636 DOMAPI_DOCTITLE := Common DOM API 637 DOMAPI_WINDOWTITLE := Common DOM API 638 DOMAPI_HEADER := <strong>Common DOM API</strong> 639 DOMAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOMAPI_FIRST_COPYRIGHT_YEAR)) 640 DOMAPI_GROUPNAME := Packages 641 DOMAPI_REGEXP := org.w3c.dom* 642 # DOMAPI_PKGS is located in NON_CORE_PKGS.gmk 643 644 # The index.html, options, and packages files 645 DOMAPI_INDEX_FILE = $(DOMAPI_DOCDIR)/index.html 646 DOMAPI_OPTIONS_FILE = $(DOCSTMPDIR)/domapi.options 647 DOMAPI_PACKAGES_FILE = $(DOCSTMPDIR)/domapi.packages 648 649 # The modules required to be documented 650 DOMAPI_MODULES = java.xml,jdk.xml.dom 651 652 domapidocs: $(DOMAPI_INDEX_FILE) 653 654 # Set relative location to core api document root 655 $(DOMAPI_INDEX_FILE): GET2DOCSDIR=$(DOMAPI2COREAPI)/.. 656 657 # Run javadoc if the index file is out of date or missing 658 $(DOMAPI_INDEX_FILE): $(DOMAPI_OPTIONS_FILE) $(DOMAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 659 $(prep-javadoc) 660 $(call JavadocSummary,$(DOMAPI_OPTIONS_FILE),$(DOMAPI_PACKAGES_FILE)) 661 $(JAVADOC_CMD_SMALL) -d $(@D) \ 662 @$(DOMAPI_OPTIONS_FILE) @$(DOMAPI_PACKAGES_FILE) 663 664 # Create file with javadoc options in it 665 $(DOMAPI_OPTIONS_FILE): 666 $(prep-target) 667 @($(call COMMON_JAVADOCFLAGS) ; \ 668 $(call COMMON_JAVADOCTAGS) ; \ 669 $(call OptionOnly,-Xdoclint:none) ; \ 670 $(call OptionPair,--system,none) ; \ 671 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 672 $(call OptionPair,--add-modules,$(DOMAPI_MODULES)) ; \ 673 $(call OptionPair,-encoding,ascii) ; \ 674 $(call OptionOnly,-splitIndex) ; \ 675 $(call OptionPair,-doctitle,$(DOMAPI_DOCTITLE)) ; \ 676 $(call OptionPair,-windowtitle,$(DOMAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 677 $(call OptionPair,-header,$(DOMAPI_HEADER)$(DRAFT_HEADER)) ; \ 678 $(call OptionPair,-bottom,$(DOMAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 679 $(call OptionTrip,-group,$(DOMAPI_GROUPNAME),$(DOMAPI_REGEXP)); \ 680 $(call OptionTrip,-linkoffline,$(DOMAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 681 ) >> $@ 682 683 # Create a file with the package names in it 684 $(DOMAPI_PACKAGES_FILE): $(call PackageDependencies,$(DOMAPI_PKGS)) 685 $(prep-target) 686 $(call PackageFilter,$(DOMAPI_PKGS)) 687 688 ############################################################# 689 # 690 # jpdadocs 691 # 692 693 ALL_OTHER_TARGETS += jpdadocs 694 695 jpdadocs: jdidocs jdwpdocs jvmtidocs 696 697 ############################################################# 698 # 699 # jdidocs 700 # 701 702 ALL_OTHER_TARGETS += jdidocs 703 704 JDI_DOCDIR := $(JDK_API_DOCSDIR)/jpda/jdi 705 JDI2COREAPI := ../../$(JDKJRE2COREAPI) 706 JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface 707 JDI_WINDOWTITLE := Java Debug Interface 708 JDI_HEADER := <strong>Java Debug Interface</strong> 709 JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR)) 710 JDI_OVERVIEW := $(JDK_TOPDIR)/src/jdk.jdi/share/classes/jdi-overview.html 711 # JDI_PKGS is located in NON_CORE_PKGS.gmk 712 713 # The index.html, options, and packages files 714 JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html 715 JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options 716 JDI_PACKAGES_FILE = $(DOCSTMPDIR)/jdi.packages 717 718 # The modules required to be documented 719 JDI_MODULES = jdk.jdi 720 721 jdidocs: $(JDI_INDEX_FILE) 722 723 # Set relative location to core api document root 724 $(JDI_INDEX_FILE): GET2DOCSDIR=$(JDI2COREAPI)/.. 725 726 # Run javadoc if the index file is out of date or missing 727 $(JDI_INDEX_FILE): $(JDI_OPTIONS_FILE) $(JDI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 728 $(prep-javadoc) 729 $(call JavadocSummary,$(JDI_OPTIONS_FILE),$(JDI_PACKAGES_FILE)) 730 $(JAVADOC_CMD_SMALL) -d $(@D) \ 731 @$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE) 732 733 # Create file with javadoc options in it 734 $(JDI_OPTIONS_FILE): $(JDI_OVERVIEW) 735 $(prep-target) 736 @($(call COMMON_JAVADOCFLAGS) ; \ 737 $(call COMMON_JAVADOCTAGS) ; \ 738 $(call OptionOnly,-Xdoclint:none) ; \ 739 $(call OptionPair,--system,none) ; \ 740 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 741 $(call OptionPair,--add-modules,$(JDI_MODULES)) ; \ 742 $(call OptionPair,-encoding,ascii) ; \ 743 $(call OptionPair,-overview,$(JDI_OVERVIEW)) ; \ 744 $(call OptionPair,-doctitle,$(JDI_DOCTITLE)) ; \ 745 $(call OptionPair,-windowtitle,$(JDI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 746 $(call OptionPair,-header,$(JDI_HEADER)$(DRAFT_HEADER)) ; \ 747 $(call OptionPair,-bottom,$(JDI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 748 $(call OptionTrip,-linkoffline,$(JDI2COREAPI),$(COREAPI_DOCSDIR)/); \ 749 ) >> $@ 750 751 # Create a file with the package names in it 752 $(JDI_PACKAGES_FILE): $(call PackageDependencies,$(JDI_PKGS)) 753 $(prep-target) 754 $(call PackageFilter,$(JDI_PKGS)) 755 756 ############################################################# 757 # 758 # jdwpdocs 759 # 760 761 ALL_OTHER_TARGETS += jdwpdocs 762 763 JDWP_DOCDIR = $(PLATFORM_DOCSDIR)/jpda/jdwp 764 765 jdwpdocs: $(JDWP_DOCDIR)/jdwp-protocol.html 766 $(JDWP_DOCDIR)/jdwp-protocol.html : $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html 767 $(MKDIR) -p $(@D) 768 $(RM) $@ 769 $(CP) $< $@ 770 771 ############################################################# 772 # 773 # jvmtidocs 774 # 775 776 JVMTI_DOCDIR := $(PLATFORM_DOCSDIR)/jvmti 777 # Pick jvmti.html from any jvm variant, they are all the same. 778 JVMTI_HTML := $(firstword \ 779 $(wildcard $(HOTSPOT_OUTPUTDIR)/variant-*/gensrc/jvmtifiles/jvmti.html)) 780 781 $(eval $(call SetupCopyFiles, COPY_JVMTI_HTML, \ 782 FILES := $(JVMTI_HTML), \ 783 DEST := $(PLATFORM_DOCSDIR)/jvmti, \ 784 )) 785 786 jvmtidocs: $(COPY_JVMTI_HTML) 787 788 ############################################################# 789 # 790 # jaasdocs 791 # 792 793 ALL_OTHER_TARGETS += jaasdocs 794 795 JAAS_DOCDIR := $(JRE_API_DOCSDIR)/security/jaas/spec 796 JAAS2COREAPI := ../../../$(JDKJRE2COREAPI) 797 JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service 798 JAAS_WINDOWTITLE := Java Authentication and Authorization Service 799 JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong> 800 JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR)) 801 # JAAS_PKGS is located in NON_CORE_PKGS.gmk 802 JAAS_OVERVIEW := $(JDK_TOPDIR)/src/jdk.security.auth/share/classes/jaas-overview.html 803 804 # The index.html, options, and packages files 805 JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html 806 JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options 807 JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages 808 809 # The modules required to be documented 810 JAAS_MODULES = jdk.security.auth 811 812 jaasdocs: $(JAAS_INDEX_FILE) 813 814 # Set relative location to core api document root 815 $(JAAS_INDEX_FILE): GET2DOCSDIR=$(JAAS2COREAPI)/.. 816 817 # Run javadoc if the index file is out of date or missing 818 $(JAAS_INDEX_FILE): $(JAAS_OPTIONS_FILE) $(JAAS_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 819 $(prep-javadoc) 820 $(call JavadocSummary,$(JAAS_OPTIONS_FILE),$(JAAS_PACKAGES_FILE)) 821 $(JAVADOC_CMD_SMALL) -d $(@D) \ 822 @$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE) 823 824 # Create file with javadoc options in it 825 $(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW) 826 $(prep-target) 827 @($(call COMMON_JAVADOCFLAGS) ; \ 828 $(call COMMON_JAVADOCTAGS) ; \ 829 $(call OptionOnly,-Xdoclint:none) ; \ 830 $(call OptionPair,--system,none) ; \ 831 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 832 $(call OptionPair,--add-modules,$(JAAS_MODULES)) ; \ 833 $(call OptionPair,-encoding,ascii) ; \ 834 $(call OptionPair,-overview,$(JAAS_OVERVIEW)) ; \ 835 $(call OptionPair,-doctitle,$(JAAS_DOCTITLE)) ; \ 836 $(call OptionPair,-windowtitle,$(JAAS_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 837 $(call OptionPair,-header,$(JAAS_HEADER)$(DRAFT_HEADER)) ; \ 838 $(call OptionPair,-bottom,$(JAAS_BOTTOM)$(DRAFT_BOTTOM)) ; \ 839 $(call OptionTrip,-linkoffline,$(JAAS2COREAPI),$(COREAPI_DOCSDIR)/); \ 840 ) >> $@ 841 842 # Create a file with the package names in it 843 $(JAAS_PACKAGES_FILE): $(call PackageDependencies,$(JAAS_PKGS)) 844 $(prep-target) 845 $(call PackageFilter,$(JAAS_PKGS)) 846 847 ############################################################# 848 # 849 # jgssdocs 850 # 851 852 ALL_OTHER_TARGETS += jgssdocs 853 854 JGSS_DOCDIR := $(JRE_API_DOCSDIR)/security/jgss/spec 855 JGSS2COREAPI := ../../../$(JDKJRE2COREAPI) 856 JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities 857 JGSS_WINDOWTITLE := Java GSS-API Utilities 858 JGSS_HEADER := <strong>Java GSS-API Utilities</strong> 859 JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR)) 860 JGSS_OVERVIEW := $(JDK_TOPDIR)/src/java.security.jgss/share/classes/jgss-overview.html 861 # JGSS_PKGS is located in NON_CORE_PKGS.gmk 862 863 # The index.html, options, and packages files 864 JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html 865 JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options 866 JGSS_PACKAGES_FILE = $(DOCSTMPDIR)/jgss.packages 867 868 # The modules required to be documented 869 JGSS_MODULES = jdk.security.jgss 870 871 jgssdocs: $(JGSS_INDEX_FILE) 872 873 # Set relative location to core api document root 874 $(JGSS_INDEX_FILE): GET2DOCSDIR=$(JGSS2COREAPI)/.. 875 876 # Run javadoc if the index file is out of date or missing 877 $(JGSS_INDEX_FILE): $(JGSS_OPTIONS_FILE) $(JGSS_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 878 $(prep-javadoc) 879 $(call JavadocSummary,$(JGSS_OPTIONS_FILE),$(JGSS_PACKAGES_FILE)) 880 $(JAVADOC_CMD_SMALL) -d $(@D) \ 881 @$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE) 882 883 # Create file with javadoc options in it 884 $(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW) 885 $(prep-target) 886 @($(call COMMON_JAVADOCFLAGS) ; \ 887 $(call COMMON_JAVADOCTAGS) ; \ 888 $(call OptionOnly,-Xdoclint:none) ; \ 889 $(call OptionPair,--system,none) ; \ 890 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 891 $(call OptionPair,--add-modules,$(JGSS_MODULES)) ; \ 892 $(call OptionPair,-encoding,ascii) ; \ 893 $(call OptionOnly,-nodeprecatedlist) ; \ 894 $(call OptionPair,-overview,$(JGSS_OVERVIEW)) ; \ 895 $(call OptionPair,-doctitle,$(JGSS_DOCTITLE)) ; \ 896 $(call OptionPair,-windowtitle,$(JGSS_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 897 $(call OptionPair,-header,$(JGSS_HEADER)$(DRAFT_HEADER)) ; \ 898 $(call OptionPair,-bottom,$(JGSS_BOTTOM)$(DRAFT_BOTTOM)) ; \ 899 $(call OptionTrip,-linkoffline,$(JGSS2COREAPI),$(COREAPI_DOCSDIR)/); \ 900 ) >> $@ 901 902 # Create a file with the package names in it 903 $(JGSS_PACKAGES_FILE): $(call PackageDependencies,$(JGSS_PKGS)) 904 $(prep-target) 905 $(call PackageFilter,$(JGSS_PKGS)) 906 907 ############################################################# 908 # 909 # smartcardiodocs 910 # 911 912 ALL_OTHER_TARGETS += smartcardiodocs 913 914 SMARTCARDIO_DOCDIR := $(JRE_API_DOCSDIR)/security/smartcardio/spec 915 SMARTCARDIO2COREAPI := ../../../$(JDKJRE2COREAPI) 916 SMARTCARDIO_DOCTITLE := Java$(TRADEMARK) Smart Card I/O 917 SMARTCARDIO_WINDOWTITLE := Java Smart Card I/O 918 SMARTCARDIO_HEADER := <strong>Java Smart Card I/O</strong> 919 SMARTCARDIO_BOTTOM := $(call CommonBottom,$(SMARTCARDIO_FIRST_COPYRIGHT_YEAR)) 920 # SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk 921 922 # The index.html, options, and packages files 923 SMARTCARDIO_INDEX_FILE = $(SMARTCARDIO_DOCDIR)/index.html 924 SMARTCARDIO_OPTIONS_FILE = $(DOCSTMPDIR)/smartcardio.options 925 SMARTCARDIO_PACKAGES_FILE = $(DOCSTMPDIR)/smartcardio.packages 926 927 # The modules required to be documented 928 SMARTCARDIO_MODULES = java.smartcardio 929 930 smartcardiodocs: $(SMARTCARDIO_INDEX_FILE) 931 932 # Set relative location to core api document root 933 $(SMARTCARDIO_INDEX_FILE): GET2DOCSDIR=$(SMARTCARDIO2COREAPI)/.. 934 935 # Run javadoc if the index file is out of date or missing 936 $(SMARTCARDIO_INDEX_FILE): $(SMARTCARDIO_OPTIONS_FILE) $(SMARTCARDIO_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 937 $(prep-javadoc) 938 $(call JavadocSummary,$(SMARTCARDIO_OPTIONS_FILE),$(SMARTCARDIO_PACKAGES_FILE)) 939 $(JAVADOC_CMD_SMALL) -d $(@D) \ 940 @$(SMARTCARDIO_OPTIONS_FILE) @$(SMARTCARDIO_PACKAGES_FILE) 941 942 # Create file with javadoc options in it 943 $(SMARTCARDIO_OPTIONS_FILE): 944 $(prep-target) 945 @($(call COMMON_JAVADOCFLAGS) ; \ 946 $(call COMMON_JAVADOCTAGS) ; \ 947 $(call OptionOnly,-Xdoclint:none) ; \ 948 $(call OptionPair,--system,none) ; \ 949 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 950 $(call OptionPair,--add-modules,$(SMARTCARDIO_MODULES)) ; \ 951 $(call OptionPair,-encoding,ascii) ; \ 952 $(call OptionOnly,-nodeprecatedlist) ; \ 953 $(call OptionPair,-doctitle,$(SMARTCARDIO_DOCTITLE)) ; \ 954 $(call OptionPair,-windowtitle,$(SMARTCARDIO_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 955 $(call OptionPair,-header,$(SMARTCARDIO_HEADER)$(DRAFT_HEADER)); \ 956 $(call OptionPair,-bottom,$(SMARTCARDIO_BOTTOM)$(DRAFT_BOTTOM)); \ 957 $(call OptionTrip,-linkoffline,$(SMARTCARDIO2COREAPI),$(COREAPI_DOCSDIR)/); \ 958 ) >> $@ 959 960 # Create a file with the package names in it 961 $(SMARTCARDIO_PACKAGES_FILE): $(call PackageDependencies,$(SMARTCARDIO_PKGS)) 962 $(prep-target) 963 $(call PackageFilter,$(SMARTCARDIO_PKGS)) 964 965 ############################################################# 966 # 967 # httpserverdocs 968 # 969 970 ALL_OTHER_TARGETS += httpserverdocs 971 972 HTTPSERVER_DOCDIR := $(JRE_API_DOCSDIR)/net/httpserver/spec 973 HTTPSERVER2COREAPI := ../../../$(JDKJRE2COREAPI) 974 HTTPSERVER_DOCTITLE := Java$(TRADEMARK) HTTP Server 975 HTTPSERVER_WINDOWTITLE := Java HTTP Server 976 HTTPSERVER_HEADER := <strong>Java HTTP Server</strong> 977 HTTPSERVER_BOTTOM := $(call CommonBottom,$(HTTPSERVER_FIRST_COPYRIGHT_YEAR)) 978 # HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk 979 980 HTTPSERVER_INDEX_HTML = $(HTTPSERVER_DOCDIR)/index.html 981 HTTPSERVER_OPTIONS_FILE = $(DOCSTMPDIR)/httpserver.options 982 HTTPSERVER_PACKAGES_FILE = $(DOCSTMPDIR)/httpserver.packages 983 984 # The modules required to be documented 985 HTTPSERVER_MODULES = jdk.httpserver 986 987 httpserverdocs: $(HTTPSERVER_INDEX_HTML) 988 989 # Set relative location to core api document root 990 $(HTTPSERVER_INDEX_HTML): GET2DOCSDIR=$(HTTPSERVER2COREAPI)/.. 991 992 # Run javadoc if the index file is out of date or missing 993 $(HTTPSERVER_INDEX_HTML): $(HTTPSERVER_OPTIONS_FILE) $(HTTPSERVER_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 994 $(prep-javadoc) 995 $(call JavadocSummary,$(HTTPSERVER_OPTIONS_FILE),$(HTTPSERVER_PACKAGES_FILE)) 996 $(JAVADOC_CMD_SMALL) -d $(@D) \ 997 @$(HTTPSERVER_OPTIONS_FILE) @$(HTTPSERVER_PACKAGES_FILE) 998 999 # Create file with javadoc options in it 1000 $(HTTPSERVER_OPTIONS_FILE): 1001 $(prep-target) 1002 @($(call COMMON_JAVADOCFLAGS) ; \ 1003 $(call COMMON_JAVADOCTAGS) ; \ 1004 $(call OptionOnly,-Xdoclint:none) ; \ 1005 $(call OptionPair,--system,none) ; \ 1006 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1007 $(call OptionPair,--add-modules,$(HTTPSERVER_MODULES)) ; \ 1008 $(call OptionPair,-encoding,ascii) ; \ 1009 $(call OptionOnly,-nodeprecatedlist) ; \ 1010 $(call OptionPair,-doctitle,$(HTTPSERVER_DOCTITLE)) ; \ 1011 $(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1012 $(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \ 1013 $(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \ 1014 $(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \ 1015 ) >> $@ 1016 1017 # Create a file with the package names in it 1018 $(HTTPSERVER_PACKAGES_FILE): $(call PackageDependencies,$(HTTPSERVER_PKGS)) 1019 $(prep-target) 1020 $(call PackageFilter,$(HTTPSERVER_PKGS)) 1021 1022 ############################################################# 1023 # 1024 # jsobjectdocs 1025 # 1026 1027 ALL_OTHER_TARGETS += jsobjectdocs 1028 1029 JSOBJECT_DOCDIR := $(JRE_API_DOCSDIR)/plugin/jsobject 1030 JSOBJECT2COREAPI := ../../$(JDKJRE2COREAPI) 1031 JSOBJECT_DOCTITLE := Java$(TRADEMARK) JSObject Doc 1032 JSOBJECT_WINDOWTITLE := Java JSObject Doc 1033 JSOBJECT_HEADER := <strong>Java JSObject Doc</strong> 1034 JSOBJECT_BOTTOM := $(call CommonBottom,$(JSOBJECT_FIRST_COPYRIGHT_YEAR)) 1035 # JSOBJECT_PKGS is located in NON_CORE_PKGS.gmk 1036 1037 JSOBJECT_INDEX_HTML = $(JSOBJECT_DOCDIR)/index.html 1038 JSOBJECT_OPTIONS_FILE = $(DOCSTMPDIR)/jsobject.options 1039 JSOBJECT_PACKAGES_FILE = $(DOCSTMPDIR)/jsobject.packages 1040 1041 # The modules required to be documented 1042 JSOBJECT_MODULES = jdk.jsobject 1043 1044 jsobjectdocs: $(JSOBJECT_INDEX_HTML) 1045 1046 # Set relative location to core api document root 1047 $(JSOBJECT_INDEX_HTML): GET2DOCSDIR=$(JSOBJECT2COREAPI)/.. 1048 1049 # Run javadoc if the index file is out of date or missing 1050 $(JSOBJECT_INDEX_HTML): $(JSOBJECT_OPTIONS_FILE) $(JSOBJECT_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1051 $(prep-javadoc) 1052 $(call JavadocSummary,$(JSOBJECT_OPTIONS_FILE),$(JSOBJECT_PACKAGES_FILE)) 1053 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1054 @$(JSOBJECT_OPTIONS_FILE) @$(JSOBJECT_PACKAGES_FILE) 1055 1056 # Create file with javadoc options in it 1057 $(JSOBJECT_OPTIONS_FILE): 1058 $(prep-target) 1059 @($(call COMMON_JAVADOCFLAGS) ; \ 1060 $(call COMMON_JAVADOCTAGS) ; \ 1061 $(call OptionOnly,-Xdoclint:none) ; \ 1062 $(call OptionPair,--system,none) ; \ 1063 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1064 $(call OptionPair,--add-modules,$(JSOBJECT_MODULES)) ; \ 1065 $(call OptionPair,-encoding,ascii) ; \ 1066 $(call OptionOnly,-nodeprecatedlist) ; \ 1067 $(call OptionPair,-doctitle,$(JSOBJECT_DOCTITLE)) ; \ 1068 $(call OptionPair,-windowtitle,$(JSOBJECT_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1069 $(call OptionPair,-header,$(JSOBJECT_HEADER)$(DRAFT_HEADER)); \ 1070 $(call OptionPair,-bottom,$(JSOBJECT_BOTTOM)$(DRAFT_BOTTOM)); \ 1071 $(call OptionTrip,-linkoffline,$(JSOBJECT2COREAPI),$(COREAPI_DOCSDIR)/); \ 1072 ) >> $@ 1073 1074 # Create a file with the package names in it 1075 $(JSOBJECT_PACKAGES_FILE): $(call PackageDependencies,$(JSOBJECT_PKGS)) 1076 $(prep-target) 1077 $(call PackageFilter,$(JSOBJECT_PKGS)) 1078 1079 1080 ############################################################# 1081 # 1082 # mgmtdocs 1083 # 1084 1085 ALL_OTHER_TARGETS += mgmtdocs 1086 1087 MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension 1088 MGMT2COREAPI := ../../$(JDKJRE2COREAPI) 1089 MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform 1090 MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform 1091 MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong> 1092 MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR)) 1093 MGMT_OVERVIEW := $(JDK_TOPDIR)/src/java.management/share/classes/mgmt-overview.html 1094 # MGMT_PKGS is located in NON_CORE_PKGS.gmk 1095 1096 # The index.html, options, and packages files 1097 MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html 1098 MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options 1099 MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages 1100 1101 # The modules required to be documented 1102 MGMT_MODULES = jdk.management 1103 1104 mgmtdocs: $(MGMT_INDEX_FILE) 1105 1106 # Set relative location to core api document root 1107 $(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/.. 1108 1109 # Run javadoc if the index file is out of date or missing 1110 $(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1111 $(prep-javadoc) 1112 $(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE)) 1113 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1114 @$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE) 1115 1116 # Create file with javadoc options in it 1117 $(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW) 1118 $(prep-target) 1119 @($(call COMMON_JAVADOCFLAGS) ; \ 1120 $(call COMMON_JAVADOCTAGS) ; \ 1121 $(call OptionOnly,-Xdoclint:none) ; \ 1122 $(call OptionPair,--system,none) ; \ 1123 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1124 $(call OptionPair,--add-modules,$(MGMT_MODULES)) ; \ 1125 $(call OptionPair,-encoding,ascii) ; \ 1126 $(call OptionOnly,-nodeprecatedlist) ; \ 1127 $(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \ 1128 $(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \ 1129 $(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1130 $(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \ 1131 $(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1132 $(call OptionTrip,-linkoffline,$(MGMT2COREAPI),$(COREAPI_DOCSDIR)/); \ 1133 ) >> $@ 1134 1135 # Create a file with the package names in it 1136 $(MGMT_PACKAGES_FILE): $(call PackageDependencies,$(MGMT_PKGS)) 1137 $(prep-target) 1138 $(call PackageFilter,$(MGMT_PKGS)) 1139 1140 ############################################################# 1141 # 1142 # attachdocs 1143 # 1144 1145 ALL_OTHER_TARGETS += attachdocs 1146 1147 ATTACH_DOCDIR := $(JDK_API_DOCSDIR)/attach/spec 1148 ATTACH2COREAPI := ../../$(JDKJRE2COREAPI) 1149 ATTACH_DOCTITLE := Attach API 1150 ATTACH_WINDOWTITLE := Attach API 1151 ATTACH_HEADER := <strong>Attach API</strong> 1152 ATTACH_BOTTOM := $(call CommonBottom,$(ATTACH_FIRST_COPYRIGHT_YEAR)) 1153 # ATTACH_PKGS is located in NON_CORE_PKGS.gmk 1154 1155 ATTACH_INDEX_HTML = $(ATTACH_DOCDIR)/index.html 1156 ATTACH_OPTIONS_FILE = $(DOCSTMPDIR)/attach.options 1157 ATTACH_PACKAGES_FILE = $(DOCSTMPDIR)/attach.packages 1158 1159 # The modules required to be documented 1160 ATTACH_MODULES = jdk.attach 1161 1162 attachdocs: $(ATTACH_INDEX_HTML) 1163 1164 # Set relative location to core api document root 1165 $(ATTACH_INDEX_HTML): GET2DOCSDIR=$(ATTACH2COREAPI)/.. 1166 1167 # Run javadoc if the index file is out of date or missing 1168 $(ATTACH_INDEX_HTML): $(ATTACH_OPTIONS_FILE) $(ATTACH_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1169 $(prep-javadoc) 1170 $(call JavadocSummary,$(ATTACH_OPTIONS_FILE),$(ATTACH_PACKAGES_FILE)) 1171 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1172 @$(ATTACH_OPTIONS_FILE) @$(ATTACH_PACKAGES_FILE) 1173 1174 # Create file with javadoc options in it 1175 $(ATTACH_OPTIONS_FILE): 1176 $(prep-target) 1177 @($(call COMMON_JAVADOCFLAGS) ; \ 1178 $(call COMMON_JAVADOCTAGS) ; \ 1179 $(call OptionOnly,-Xdoclint:none) ; \ 1180 $(call OptionPair,--system,none) ; \ 1181 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1182 $(call OptionPair,--add-modules,$(ATTACH_MODULES)) ; \ 1183 $(call OptionPair,-encoding,ascii) ; \ 1184 $(call OptionOnly,-nodeprecatedlist) ; \ 1185 $(call OptionPair,-doctitle,$(ATTACH_DOCTITLE)) ; \ 1186 $(call OptionPair,-windowtitle,$(ATTACH_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1187 $(call OptionPair,-header,$(ATTACH_HEADER)$(DRAFT_HEADER)) ; \ 1188 $(call OptionPair,-bottom,$(ATTACH_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1189 $(call OptionTrip,-linkoffline,$(ATTACH2COREAPI),$(COREAPI_DOCSDIR)/); \ 1190 ) >> $@ 1191 1192 # Create a file with the package names in it 1193 $(ATTACH_PACKAGES_FILE): $(call PackageDependencies,$(ATTACH_PKGS)) 1194 $(prep-target) 1195 $(call PackageFilter,$(ATTACH_PKGS)) 1196 1197 ############################################################# 1198 # 1199 # jconsoledocs 1200 # 1201 1202 ALL_OTHER_TARGETS += jconsoledocs 1203 1204 JCONSOLE_DOCDIR := $(JDK_API_DOCSDIR)/jconsole/spec 1205 JCONSOLE2COREAPI := ../../$(JDKJRE2COREAPI) 1206 JCONSOLE_DOCTITLE := JConsole API 1207 JCONSOLE_WINDOWTITLE := JConsole API 1208 JCONSOLE_HEADER := <strong>JConsole API</strong> 1209 JCONSOLE_BOTTOM := $(call CommonBottom,$(JCONSOLE_FIRST_COPYRIGHT_YEAR)) 1210 # JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk 1211 1212 JCONSOLE_INDEX_HTML = $(JCONSOLE_DOCDIR)/index.html 1213 JCONSOLE_OPTIONS_FILE = $(DOCSTMPDIR)/jconsole.options 1214 JCONSOLE_PACKAGES_FILE = $(DOCSTMPDIR)/jconsole.packages 1215 1216 # The modules required to be documented 1217 JCONSOLE_MODULES = jdk.jconsole 1218 1219 jconsoledocs: $(JCONSOLE_INDEX_HTML) 1220 1221 # Set relative location to core api document root 1222 $(JCONSOLE_INDEX_HTML): GET2DOCSDIR=$(JCONSOLE2COREAPI)/.. 1223 1224 # Run javadoc if the index file is out of date or missing 1225 $(JCONSOLE_INDEX_HTML): $(JCONSOLE_OPTIONS_FILE) $(JCONSOLE_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1226 $(prep-javadoc) 1227 $(call JavadocSummary,$(JCONSOLE_OPTIONS_FILE),$(JCONSOLE_PACKAGES_FILE)) 1228 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1229 @$(JCONSOLE_OPTIONS_FILE) @$(JCONSOLE_PACKAGES_FILE) 1230 1231 # Create file with javadoc options in it 1232 $(JCONSOLE_OPTIONS_FILE): 1233 $(prep-target) 1234 @($(call COMMON_JAVADOCFLAGS) ; \ 1235 $(call COMMON_JAVADOCTAGS) ; \ 1236 $(call OptionOnly,-Xdoclint:none) ; \ 1237 $(call OptionPair,--system,none) ; \ 1238 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1239 $(call OptionPair,--add-modules,$(JCONSOLE_MODULES)) ; \ 1240 $(call OptionPair,-encoding,ascii) ; \ 1241 $(call OptionOnly,-nodeprecatedlist) ; \ 1242 $(call OptionPair,-doctitle,$(JCONSOLE_DOCTITLE)) ; \ 1243 $(call OptionPair,-windowtitle,$(JCONSOLE_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1244 $(call OptionPair,-header,$(JCONSOLE_HEADER)$(DRAFT_HEADER)) ; \ 1245 $(call OptionPair,-bottom,$(JCONSOLE_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1246 $(call OptionTrip,-linkoffline,$(JCONSOLE2COREAPI),$(COREAPI_DOCSDIR)/); \ 1247 ) >> $@ 1248 1249 # Create a file with the package names in it 1250 $(JCONSOLE_PACKAGES_FILE): $(call PackageDependencies,$(JCONSOLE_PKGS)) 1251 $(prep-target) 1252 $(call PackageFilter,$(JCONSOLE_PKGS)) 1253 1254 ############################################################# 1255 # 1256 # jshellapidocs 1257 # 1258 1259 ALL_OTHER_TARGETS += jshellapidocs 1260 1261 JSHELLAPI_DOCDIR := $(JDK_API_DOCSDIR)/jshell 1262 JSHELLAPI2COREAPI := ../../$(JDKJRE2COREAPI) 1263 JSHELLAPI_DOCTITLE := JShell API 1264 JSHELLAPI_WINDOWTITLE := JShell API 1265 JSHELLAPI_HEADER := <strong>JSHELL API</strong> 1266 JSHELLAPI_BOTTOM := $(call CommonBottom,$(JSHELLAPI_FIRST_COPYRIGHT_YEAR)) 1267 JSHELLAPI_OVERVIEW := $(LANGTOOLS_TOPDIR)/src/jdk.jshell/share/classes/jdk/jshell/overview.html 1268 # JSHELLAPI_PKGS is located in NON_CORE_PKGS.gmk 1269 1270 JSHELLAPI_INDEX_HTML = $(JSHELLAPI_DOCDIR)/index.html 1271 JSHELLAPI_OPTIONS_FILE = $(DOCSTMPDIR)/jshellapi.options 1272 JSHELLAPI_PACKAGES_FILE = $(DOCSTMPDIR)/jshellapi.packages 1273 1274 # The modules required to be documented 1275 JSHELLAPI_MODULES = jdk.jshell 1276 1277 jshellapidocs: $(JSHELLAPI_INDEX_HTML) 1278 1279 # Set relative location to core api document root 1280 $(JSHELLAPI_INDEX_HTML): GET2DOCSDIR=$(JSHELLAPI2COREAPI)/.. 1281 1282 # Run javadoc if the index file is out of date or missing 1283 $(JSHELLAPI_INDEX_HTML): $(JSHELLAPI_OPTIONS_FILE) $(JSHELLAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1284 $(prep-javadoc) 1285 $(call JavadocSummary,$(JSHELLAPI_OPTIONS_FILE),$(JSHELLAPI_PACKAGES_FILE)) 1286 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1287 @$(JSHELLAPI_OPTIONS_FILE) @$(JSHELLAPI_PACKAGES_FILE) 1288 1289 # Create file with javadoc options in it 1290 $(JSHELLAPI_OPTIONS_FILE): 1291 $(prep-target) 1292 @($(call COMMON_JAVADOCFLAGS) ; \ 1293 $(call COMMON_JAVADOCTAGS) ; \ 1294 $(call OptionOnly,-Xdoclint:all) ; \ 1295 $(call OptionPair,--system,none) ; \ 1296 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1297 $(call OptionPair,--add-modules,$(JSHELLAPI_MODULES)) ; \ 1298 $(call OptionPair,-encoding,ascii) ; \ 1299 $(call OptionPair,-overview,$(JSHELLAPI_OVERVIEW)) ; \ 1300 $(call OptionPair,-doctitle,$(JSHELLAPI_DOCTITLE)) ; \ 1301 $(call OptionPair,-windowtitle,$(JSHELLAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1302 $(call OptionPair,-header,$(JSHELLAPI_HEADER)$(DRAFT_HEADER)) ; \ 1303 $(call OptionPair,-bottom,$(JSHELLAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1304 $(call OptionTrip,-linkoffline,$(JSHELLAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1305 ) >> $@ 1306 1307 # Create a file with the package names in it 1308 $(JSHELLAPI_PACKAGES_FILE): $(call PackageDependencies,$(JSHELLAPI_PKGS)) 1309 $(prep-target) 1310 $(call PackageFilter,$(JSHELLAPI_PKGS)) 1311 1312 ############################################################# 1313 # 1314 # treeapidocs 1315 # 1316 1317 ALL_OTHER_TARGETS += treeapidocs 1318 1319 TREEAPI_DOCDIR := $(JDK_API_DOCSDIR)/javac/tree 1320 TREEAPI2COREAPI := ../../$(JDKJRE2COREAPI) 1321 TREEAPI_DOCTITLE := Compiler Tree API 1322 TREEAPI_WINDOWTITLE := Compiler Tree API 1323 TREEAPI_HEADER := <strong>Compiler Tree API</strong> 1324 TREEAPI_BOTTOM := $(call CommonBottom,$(TREEAPI_FIRST_COPYRIGHT_YEAR)) 1325 TREEAPI_GROUPNAME := Packages 1326 TREEAPI_REGEXP := com.sun.source.* 1327 # TREEAPI_PKGS is located in NON_CORE_PKGS.gmk 1328 1329 TREEAPI_INDEX_HTML = $(TREEAPI_DOCDIR)/index.html 1330 TREEAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options 1331 TREEAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages 1332 1333 # The modules required to be documented 1334 TREEAPI_MODULES = jdk.compiler 1335 1336 treeapidocs: $(TREEAPI_INDEX_HTML) 1337 1338 # Set relative location to core api document root 1339 $(TREEAPI_INDEX_HTML): GET2DOCSDIR=$(TREEAPI2COREAPI)/.. 1340 1341 # Run javadoc if the index file is out of date or missing 1342 $(TREEAPI_INDEX_HTML): $(TREEAPI_OPTIONS_FILE) $(TREEAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1343 $(prep-javadoc) 1344 $(call JavadocSummary,$(TREEAPI_OPTIONS_FILE),$(TREEAPI_PACKAGES_FILE)) 1345 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1346 @$(TREEAPI_OPTIONS_FILE) @$(TREEAPI_PACKAGES_FILE) 1347 1348 # Create file with javadoc options in it 1349 $(TREEAPI_OPTIONS_FILE): 1350 $(prep-target) 1351 @($(call COMMON_JAVADOCFLAGS) ; \ 1352 $(call COMMON_JAVADOCTAGS) ; \ 1353 $(call OptionOnly,-Xdoclint:all) ; \ 1354 $(call OptionPair,--system,none) ; \ 1355 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1356 $(call OptionPair,--add-modules,$(TREEAPI_MODULES)) ; \ 1357 $(call OptionPair,-encoding,ascii) ; \ 1358 $(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \ 1359 $(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1360 $(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \ 1361 $(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1362 $(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \ 1363 $(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1364 ) >> $@ 1365 1366 # Create a file with the package names in it 1367 $(TREEAPI_PACKAGES_FILE): $(call PackageDependencies,$(TREEAPI_PKGS)) 1368 $(prep-target) 1369 $(call PackageFilter,$(TREEAPI_PKGS)) 1370 1371 ############################################################# 1372 # 1373 # nashornapidocs 1374 # 1375 1376 ALL_OTHER_TARGETS += nashornapidocs 1377 1378 NASHORNAPI_DOCDIR := $(JDK_API_DOCSDIR)/nashorn 1379 NASHORNAPI2COREAPI := ../$(JDKJRE2COREAPI) 1380 NASHORNAPI_DOCTITLE := Nashorn API 1381 NASHORNAPI_WINDOWTITLE := Nashorn API 1382 NASHORNAPI_HEADER := <strong>Nashorn API</strong> 1383 NASHORNAPI_BOTTOM := $(call CommonBottom,$(NASHORNAPI_FIRST_COPYRIGHT_YEAR)) 1384 NASHORNAPI_GROUPNAME := Packages 1385 NASHORNAPI_REGEXP := jdk.nashorn.api.* 1386 # NASHORNAPI_PKGS is located in NON_CORE_PKGS.gmk 1387 1388 NASHORNAPI_INDEX_HTML = $(NASHORNAPI_DOCDIR)/index.html 1389 NASHORNAPI_OPTIONS_FILE = $(DOCSTMPDIR)/nashornapi.options 1390 NASHORNAPI_PACKAGES_FILE = $(DOCSTMPDIR)/nashornapi.packages 1391 1392 # The modules required to be documented 1393 NASHORNAPI_MODULES = jdk.scripting.nashorn 1394 1395 nashornapidocs: $(NASHORNAPI_INDEX_HTML) 1396 1397 # Set relative location to core api document root 1398 $(NASHORNAPI_INDEX_HTML): GET2DOCSDIR=$(NASHORNAPI2COREAPI)/.. 1399 1400 # Run javadoc if the index file is out of date or missing 1401 $(NASHORNAPI_INDEX_HTML): $(NASHORNAPI_OPTIONS_FILE) $(NASHORNAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1402 $(prep-javadoc) 1403 $(call JavadocSummary,$(NASHORNAPI_OPTIONS_FILE),$(NASHORNAPI_PACKAGES_FILE)) 1404 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1405 @$(NASHORNAPI_OPTIONS_FILE) @$(NASHORNAPI_PACKAGES_FILE) 1406 1407 # Create file with javadoc options in it 1408 $(NASHORNAPI_OPTIONS_FILE): 1409 $(prep-target) 1410 @($(call COMMON_JAVADOCFLAGS) ; \ 1411 $(call COMMON_JAVADOCTAGS) ; \ 1412 $(call OptionOnly,-Xdoclint:all) ; \ 1413 $(call OptionPair,--system,none) ; \ 1414 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1415 $(call OptionPair,--add-modules,$(NASHORNAPI_MODULES)) ; \ 1416 $(call OptionPair,-encoding,ascii) ; \ 1417 $(call OptionPair,-doctitle,$(NASHORNAPI_DOCTITLE)) ; \ 1418 $(call OptionPair,-windowtitle,$(NASHORNAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1419 $(call OptionPair,-header,$(NASHORNAPI_HEADER)$(DRAFT_HEADER)) ; \ 1420 $(call OptionPair,-bottom,$(NASHORNAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1421 $(call OptionTrip,-group,$(NASHORNAPI_GROUPNAME),$(NASHORNAPI_REGEXP)); \ 1422 $(call OptionTrip,-linkoffline,$(NASHORNAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1423 ) >> $@ 1424 1425 # Create a file with the package names in it 1426 $(NASHORNAPI_PACKAGES_FILE): $(call PackageDependencies,$(NASHORNAPI_PKGS)) 1427 $(prep-target) 1428 $(call PackageFilter,$(NASHORNAPI_PKGS)) 1429 1430 ############################################################# 1431 # 1432 # dynalinkapidocs 1433 # 1434 1435 ALL_OTHER_TARGETS += dynalinkapidocs 1436 1437 DYNALINKAPI_DOCDIR := $(JDK_API_DOCSDIR)/dynalink 1438 DYNALINKAPI2COREAPI := ../$(JDKJRE2COREAPI) 1439 DYNALINKAPI_DOCTITLE := Dynalink API 1440 DYNALINKAPI_WINDOWTITLE := Dynalink API 1441 DYNALINKAPI_HEADER := <strong>Dynalink API</strong> 1442 DYNALINKAPI_BOTTOM := $(call CommonBottom,$(DYNALINKAPI_FIRST_COPYRIGHT_YEAR)) 1443 DYNALINKAPI_GROUPNAME := Packages 1444 DYNALINKAPI_REGEXP := jdk.dynalink.* 1445 # DYNALINKAPI_PKGS is located in NON_CORE_PKGS.gmk 1446 1447 DYNALINKAPI_INDEX_HTML = $(DYNALINKAPI_DOCDIR)/index.html 1448 DYNALINKAPI_OPTIONS_FILE = $(DOCSTMPDIR)/dynalinkapi.options 1449 DYNALINKAPI_PACKAGES_FILE = $(DOCSTMPDIR)/dynalinkapi.packages 1450 1451 # The modules required to be documented 1452 DYNALINKAPI_MODULES = jdk.dynalink 1453 1454 dynalinkapidocs: $(DYNALINKAPI_INDEX_HTML) 1455 1456 # Set relative location to core api document root 1457 $(DYNALINKAPI_INDEX_HTML): GET2DOCSDIR=$(DYNALINKAPI2COREAPI)/.. 1458 1459 # Run javadoc if the index file is out of date or missing 1460 $(DYNALINKAPI_INDEX_HTML): $(DYNALINKAPI_OPTIONS_FILE) $(DYNALINKAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1461 $(prep-javadoc) 1462 $(call JavadocSummary,$(DYNALINKAPI_OPTIONS_FILE),$(DYNALINKAPI_PACKAGES_FILE)) 1463 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1464 @$(DYNALINKAPI_OPTIONS_FILE) @$(DYNALINKAPI_PACKAGES_FILE) 1465 1466 # Create file with javadoc options in it 1467 $(DYNALINKAPI_OPTIONS_FILE): 1468 $(prep-target) 1469 @($(call COMMON_JAVADOCFLAGS) ; \ 1470 $(call COMMON_JAVADOCTAGS) ; \ 1471 $(call OptionOnly,-Xdoclint:all) ; \ 1472 $(call OptionPair,--system,none) ; \ 1473 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1474 $(call OptionPair,--add-modules,$(DYNALINKAPI_MODULES)) ; \ 1475 $(call OptionPair,-encoding,ascii) ; \ 1476 $(call OptionPair,-doctitle,$(DYNALINKAPI_DOCTITLE)) ; \ 1477 $(call OptionPair,-windowtitle,$(DYNALINKAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1478 $(call OptionPair,-header,$(DYNALINKAPI_HEADER)$(DRAFT_HEADER)) ; \ 1479 $(call OptionPair,-bottom,$(DYNALINKAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1480 $(call OptionTrip,-linkoffline,$(DYNALINKAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1481 ) >> $@ 1482 1483 # Create a file with the package names in it 1484 $(DYNALINKAPI_PACKAGES_FILE): $(call PackageDependencies,$(DYNALINKAPI_PKGS)) 1485 $(prep-target) 1486 $(call PackageFilter,$(DYNALINKAPI_PKGS)) 1487 1488 ############################################################# 1489 # 1490 # sctpdocs 1491 # 1492 1493 ALL_OTHER_TARGETS += sctpdocs 1494 1495 SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec 1496 SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI) 1497 SCTPAPI_DOCTITLE := SCTP API 1498 SCTPAPI_WINDOWTITLE := SCTP API 1499 SCTPAPI_HEADER := <strong>SCTP API</strong> 1500 SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR)) 1501 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk 1502 1503 SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html 1504 SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options 1505 SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages 1506 1507 # The modules required to be documented 1508 SCTPAPI_MODULES = jdk.sctp 1509 1510 sctpdocs: $(SCTPAPI_INDEX_HTML) 1511 1512 # Set relative location to core api document root 1513 $(SCTPAPI_INDEX_HTML): GET2DOCSDIR=$(SCTPAPI2COREAPI)/.. 1514 1515 # Run javadoc if the index file is out of date or missing 1516 $(SCTPAPI_INDEX_HTML): $(SCTPAPI_OPTIONS_FILE) $(SCTPAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1517 $(prep-javadoc) 1518 $(call JavadocSummary,$(SCTPAPI_OPTIONS_FILE),$(SCTPAPI_PACKAGES_FILE)) 1519 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1520 @$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE) 1521 1522 # Create file with javadoc options in it 1523 $(SCTPAPI_OPTIONS_FILE): 1524 $(prep-target) 1525 @($(call COMMON_JAVADOCFLAGS) ; \ 1526 $(call COMMON_JAVADOCTAGS) ; \ 1527 $(call OptionOnly,-Xdoclint:none) ; \ 1528 $(call OptionPair,--system,none) ; \ 1529 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1530 $(call OptionPair,--add-modules,$(SCTPAPI_MODULES)) ; \ 1531 $(call OptionPair,-encoding,ascii) ; \ 1532 $(call OptionOnly,-nodeprecatedlist) ; \ 1533 $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \ 1534 $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1535 $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \ 1536 $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1537 $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1538 ) >> $@ 1539 1540 # Create a file with the package names in it 1541 $(SCTPAPI_PACKAGES_FILE): $(call PackageDependencies,$(SCTPAPI_PKGS)) 1542 $(prep-target) 1543 $(call PackageFilter,$(SCTPAPI_PKGS)) 1544 1545 ############################################################# 1546 # 1547 # jaccessdocs - Java Accessibility Utilities 1548 # 1549 1550 ALL_OTHER_TARGETS += jaccessdocs 1551 1552 JACCESSAPI_DOCDIR := $(JRE_API_DOCSDIR)/accessibility/jaccess/spec 1553 JACCESSAPI2COREAPI := ../../../$(JDKJRE2COREAPI) 1554 JACCESSAPI_DOCTITLE := JACCESS API 1555 JACCESSAPI_WINDOWTITLE := JACCESS API 1556 JACCESSAPI_HEADER := <strong>JACCESS API</strong> 1557 JACCESSAPI_BOTTOM := $(call CommonBottom,$(JACCESSAPI_FIRST_COPYRIGHT_YEAR)) 1558 # JACCESSAPI_PKGS is located in NON_CORE_PKGS.gmk 1559 1560 JACCESSAPI_INDEX_HTML = $(JACCESSAPI_DOCDIR)/index.html 1561 JACCESSAPI_OPTIONS_FILE = $(DOCSTMPDIR)/jaccess.options 1562 JACCESSAPI_PACKAGES_FILE = $(DOCSTMPDIR)/jaccess.packages 1563 1564 # The modules required to be documented 1565 JACCESSAPI_MODULES = jdk.accessibility 1566 1567 jaccessdocs: $(JACCESSAPI_INDEX_HTML) 1568 1569 # Set relative location to core api document root 1570 $(JACCESSAPI_INDEX_HTML): GET2DOCSDIR=$(JACCESSAPI2COREAPI)/.. 1571 1572 # Run javadoc if the index file is out of date or missing 1573 $(JACCESSAPI_INDEX_HTML): $(JACCESSAPI_OPTIONS_FILE) $(JACCESSAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1574 $(prep-javadoc) 1575 $(call JavadocSummary,$(JACCESSAPI_OPTIONS_FILE),$(JACCESSAPI_PACKAGES_FILE)) 1576 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1577 @$(JACCESSAPI_OPTIONS_FILE) @$(JACCESSAPI_PACKAGES_FILE) 1578 1579 # Create file with javadoc options in it 1580 $(JACCESSAPI_OPTIONS_FILE): 1581 $(prep-target) 1582 @($(call COMMON_JAVADOCFLAGS) ; \ 1583 $(call COMMON_JAVADOCTAGS) ; \ 1584 $(call OptionOnly,-Xdoclint:all) ; \ 1585 $(call OptionPair,--system,none) ; \ 1586 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1587 $(call OptionPair,--add-modules,$(JACCESSAPI_MODULES)) ; \ 1588 $(call OptionPair,-encoding,ascii) ; \ 1589 $(call OptionOnly,-nodeprecatedlist) ; \ 1590 $(call OptionPair,-doctitle,$(JACCESSAPI_DOCTITLE)) ; \ 1591 $(call OptionPair,-windowtitle,$(JACCESSAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1592 $(call OptionPair,-header,$(JACCESSAPI_HEADER)$(DRAFT_HEADER)) ; \ 1593 $(call OptionPair,-bottom,$(JACCESSAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1594 $(call OptionTrip,-linkoffline,$(JACCESSAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1595 ) >> $@ 1596 1597 # Create a file with the package names in it 1598 $(JACCESSAPI_PACKAGES_FILE): $(call PackageDependencies,$(JACCESSAPI_PKGS)) 1599 $(prep-target) 1600 $(call PackageFilter,$(JACCESSAPI_PKGS)) 1601 1602 ############################################################# 1603 # 1604 # jdk.net docs 1605 # 1606 1607 ALL_OTHER_TARGETS += jdknetdocs 1608 1609 JDKNET_DOCDIR := $(JRE_API_DOCSDIR)/net/socketoptions/spec 1610 JDKNET2COREAPI := ../../../$(JDKJRE2COREAPI) 1611 JDKNET_DOCTITLE := jdk.net API 1612 JDKNET_WINDOWTITLE := jdk.net API 1613 JDKNET_HEADER := <strong>jdk.net API</strong> 1614 JDKNET_BOTTOM := $(call CommonBottom,$(JDKNET_FIRST_COPYRIGHT_YEAR)) 1615 JDKNET_PKGS := jdk.net 1616 1617 JDKNET_INDEX_HTML = $(JDKNET_DOCDIR)/index.html 1618 JDKNET_OPTIONS_FILE = $(DOCSTMPDIR)/jdknet.options 1619 JDKNET_PACKAGES_FILE = $(DOCSTMPDIR)/jdknet.packages 1620 1621 # The modules required to be documented 1622 JDKNET_MODULES = jdk.net 1623 1624 jdknetdocs: $(JDKNET_INDEX_HTML) 1625 1626 # Set relative location to core api document root 1627 $(JDKNET_INDEX_HTML): GET2DOCSDIR=$(JDKNET2COREAPI)/.. 1628 1629 # Run javadoc if the index file is out of date or missing 1630 $(JDKNET_INDEX_HTML): $(JDKNET_OPTIONS_FILE) $(JDKNET_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1631 $(prep-javadoc) 1632 $(call JavadocSummary,$(JDKNET_OPTIONS_FILE),$(JDKNET_PACKAGES_FILE)) 1633 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1634 @$(JDKNET_OPTIONS_FILE) @$(JDKNET_PACKAGES_FILE) 1635 1636 # Create file with javadoc options in it 1637 $(JDKNET_OPTIONS_FILE): 1638 $(prep-target) 1639 @($(call COMMON_JAVADOCFLAGS) ; \ 1640 $(call COMMON_JAVADOCTAGS) ; \ 1641 $(call OptionOnly,-Xdoclint:none) ; \ 1642 $(call OptionPair,--system,none) ; \ 1643 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1644 $(call OptionPair,--add-modules,$(JDKNET_MODULES)) ; \ 1645 $(call OptionPair,-encoding,ascii) ; \ 1646 $(call OptionOnly,-nodeprecatedlist) ; \ 1647 $(call OptionPair,-doctitle,$(JDKNET_DOCTITLE)) ; \ 1648 $(call OptionPair,-windowtitle,$(JDKNET_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1649 $(call OptionPair,-header,$(JDKNET_HEADER)$(DRAFT_HEADER)); \ 1650 $(call OptionPair,-bottom,$(JDKNET_BOTTOM)$(DRAFT_BOTTOM)); \ 1651 $(call OptionTrip,-linkoffline,$(JDKNET2COREAPI),$(COREAPI_DOCSDIR)/); \ 1652 ) >> $@ 1653 1654 # Create a file with the package names in it 1655 $(JDKNET_PACKAGES_FILE): $(call PackageDependencies,$(JDKNET_PKGS)) 1656 $(prep-target) 1657 $(call PackageFilter,$(JDKNET_PKGS)) 1658 1659 ############################################################# 1660 # 1661 # jlink plugin API docs 1662 # 1663 # TODO: Need to decide when the plugin API is ready to publish as experimental API. 1664 # This target is temporarily added for internal use for now. 1665 # 1666 1667 ALL_OTHER_TARGETS += jlinkdocs 1668 1669 JLINK_PLUGIN_FIRST_COPYRIGHT_YEAR = 2015 1670 JLINK_PLUGIN_DOCDIR := $(JDK_API_DOCSDIR)/jlink 1671 JLINK_PLUGIN2COREAPI := ../$(JDKJRE2COREAPI) 1672 JLINK_PLUGIN_DOCTITLE := JLink Plugin API - EXPERIMENTAL 1673 JLINK_PLUGIN_WINDOWTITLE := JLink Plugin API - EXPERIMENTAL 1674 JLINK_PLUGIN_HEADER := <strong>JLink Plugin API - EXPERIMENTAL</strong> 1675 JLINK_PLUGIN_BOTTOM := $(call CommonBottom,$(JLINK_PLUGIN_FIRST_COPYRIGHT_YEAR)) 1676 JLINK_PLUGIN_PKGS = jdk.tools.jlink.plugin 1677 1678 JLINK_PLUGIN_INDEX_HTML = $(JLINK_PLUGIN_DOCDIR)/index.html 1679 JLINK_PLUGIN_OPTIONS_FILE = $(DOCSTMPDIR)/jlinkplugins.options 1680 JLINK_PLUGIN_PACKAGES_FILE = $(DOCSTMPDIR)/jlinkplugins.packages 1681 1682 # The modules required to be documented 1683 JLINK_PLUGIN_MODULES = jdk.jlink 1684 1685 jlinkdocs: $(JLINK_PLUGIN_INDEX_HTML) 1686 1687 # Set relative location to core api document root 1688 $(JLINK_PLUGIN_INDEX_HTML): GET2DOCSDIR=$(JLINK_PLUGIN2COREAPI)/.. 1689 1690 # Run javadoc if the index file is out of date or missing 1691 $(JLINK_PLUGIN_INDEX_HTML): $(JLINK_PLUGIN_OPTIONS_FILE) $(JLINK_PLUGIN_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1692 $(prep-javadoc) 1693 $(call JavadocSummary,$(JLINK_PLUGIN_OPTIONS_FILE),$(JLINK_PLUGIN_PACKAGES_FILE)) 1694 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1695 @$(JLINK_PLUGIN_OPTIONS_FILE) @$(JLINK_PLUGIN_PACKAGES_FILE) 1696 1697 # Create file with javadoc options in it 1698 $(JLINK_PLUGIN_OPTIONS_FILE): 1699 $(prep-target) 1700 @($(call COMMON_JAVADOCFLAGS) ; \ 1701 $(call COMMON_JAVADOCTAGS) ; \ 1702 $(call OptionOnly,-Xdoclint:none) ; \ 1703 $(call OptionPair,--system,none) ; \ 1704 $(call OptionPair,--module-source-path,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1705 $(call OptionPair,--add-modules,$(JLINK_PLUGIN_MODULES)) ; \ 1706 $(call OptionPair,-encoding,ascii) ; \ 1707 $(call OptionOnly,-nodeprecatedlist) ; \ 1708 $(call OptionPair,-doctitle,$(JLINK_PLUGIN_DOCTITLE)) ; \ 1709 $(call OptionPair,-windowtitle,$(JLINK_PLUGIN_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1710 $(call OptionPair,-header,$(JLINK_PLUGIN_HEADER)$(DRAFT_HEADER)); \ 1711 $(call OptionPair,-bottom,$(JLINK_PLUGIN_BOTTOM)$(DRAFT_BOTTOM)); \ 1712 $(call OptionTrip,-linkoffline,$(JLINK_PLUGIN2COREAPI),$(COREAPI_DOCSDIR)/); \ 1713 ) >> $@ 1714 1715 # Create a file with the package names in it 1716 $(JLINK_PLUGIN_PACKAGES_FILE): $(call PackageDependencies,$(JLINK_PLUGIN_PKGS)) 1717 $(prep-target) 1718 $(call PackageFilter,$(JLINK_PLUGIN_PKGS)) 1719 1720 1721 otherdocs: $(ALL_OTHER_TARGETS) 1722 1723 # 1724 # Add the core docs as prerequisite to the archive to trigger a rebuild 1725 # if the core docs were rebuilt. Ideally any doc rebuild should trigger 1726 # this, but the way prerequisites are currently setup in this file, that 1727 # is hard to achieve. 1728 # 1729 1730 $(JAVADOC_ARCHIVE): $(COREAPI_INDEX_FILE) 1731 $(call LogInfo, Compressing javadoc to single $(JAVADOC_ARCHIVE_NAME)) 1732 $(MKDIR) -p $(JAVADOC_ARCHIVE_DIR) 1733 $(RM) -r $(JAVADOC_ARCHIVE_ASSEMBLY_DIR) 1734 $(MKDIR) -p $(JAVADOC_ARCHIVE_ASSEMBLY_DIR) 1735 all_roots=`$(FIND) $(DOCSDIR) | $(GREP) index.html | grep -v old/doclet`; \ 1736 pushd $(JAVADOC_ARCHIVE_ASSEMBLY_DIR); \ 1737 for index_file in $${all_roots} ; do \ 1738 target_dir=`dirname $${index_file}`; \ 1739 name=`$(ECHO) $${target_dir} | $(SED) "s;/spec;;" | $(SED) "s;.*/;;"`; \ 1740 $(LN) -s $${target_dir} $${name}; \ 1741 done; \ 1742 $(ZIP) -q -r $(JAVADOC_ARCHIVE) * ; \ 1743 popd ; 1744 1745 ############################################################# 1746 .PHONY: all docs coredocs otherdocs \ 1747 $(ALL_OTHER_TARGETS) zip-docs 1748 1749 ################################################################################ 1750 1751 $(eval $(call IncludeCustomExtension, , Javadoc-post.gmk)) | 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 default: all 26 27 include $(SPEC) 28 include MakeBase.gmk 29 30 ################################################################################ 31 32 # List of all possible directories for javadoc to look for sources 33 # Allow custom to overwrite. 34 JAVADOC_SOURCE_DIRS = \ 35 $(SUPPORT_OUTPUTDIR)/gensrc/* \ 36 $(if $(IMPORT_MODULES_SRC), $(IMPORT_MODULES_SRC)/*) \ 37 $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS)/classes \ 38 $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS_TYPE)/classes \ 39 $(JDK_TOPDIR)/src/*/share/classes \ 40 $(HOTSPOT_TOPDIR)/src/*/share/classes \ 41 $(LANGTOOLS_TOPDIR)/src/*/share/classes \ 42 $(NASHORN_TOPDIR)/src/*/share/classes \ 43 $(CORBA_TOPDIR)/src/*/share/classes \ 44 $(JAXP_TOPDIR)/src/*/share/classes \ 45 $(JAXWS_TOPDIR)/src/*/share/classes \ 46 $(SUPPORT_OUTPUTDIR)/rmic/* \ 47 $(JDK_TOPDIR)/src/*/share/doc/stub \ 48 # 49 50 # Should we use -Xdocrootparent? Allow custom to overwrite. 51 DOCROOTPARENT_FLAG = TRUE 52 53 # The core api index file is the target for the core api javadocs rule 54 # and needs to be defined early so that all other javadoc rules may 55 # depend on it. 56 CORE_INDEX_FILE := $(JAVADOC_OUTPUTDIR)/api/index.html 57 58 # Symbols 59 TRADEMARK := ™ 60 COPYRIGHT_SYMBOL := &$(HASH)x00a9; 61 COPYRIGHT_TEXT := Copyright 62 ALL_RIGHTS_RESERVED := All rights reserved. 63 64 # URLs 65 JAVADOC_BASE_URL := http://docs.oracle.com/javase/$(VERSION_SPECIFICATION)/docs 66 BUG_SUBMIT_URL := http://bugreport.java.com/bugreport/ 67 68 ################################################################################ 69 # Text snippets 70 71 FULL_COMPANY_NAME := Oracle and/or its affiliates 72 COMPANY_ADDRESS := 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA. 73 BUG_SUBMIT_LINE := <a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a> 74 JAVA_TRADEMARK_LINE := Java is a trademark or registered trademark of \ 75 $(FULL_COMPANY_NAME) in the US and other countries. 76 77 COMMON_BOTTOM_ADDRESS := $(COMPANY_ADDRESS) 78 COMMON_BOTTOM_TEXT := $(BUG_SUBMIT_LINE)<br>$(JAVA_TRADEMARK_LINE) 79 80 CORE_BOTTOM_COPYRIGHT_URL := {@docroot}/../legal/cpyr.html 81 CORE_BOTTOM_TEXT := $(BUG_SUBMIT_LINE)\ 82 <br>For further API reference and developer documentation, \ 83 see <a href="$(JAVADOC_BASE_URL)/index.html" target="_blank">Java SE \ 84 Documentation</a>. That documentation contains more detailed, \ 85 developer-targeted descriptions, with conceptual overviews, definitions of \ 86 terms, workarounds, and working code examples. 87 88 ifeq ($(VERSION_IS_GA), true) 89 DRAFT_HEADER := 90 DRAFT_BOTTOM := 91 DRAFT_WINTITLE := 92 CORE_TOP_EARLYACCESS := 93 else 94 # We need a draft format when not building the GA version. 95 DRAFT_HEADER := <br><strong>DRAFT $(VERSION_STRING)</strong> 96 DRAFT_BOTTOM := <br><strong>DRAFT $(VERSION_STRING)</strong> 97 DRAFT_WINTITLE := $(VERSION_BUILD) 98 CORE_TOP_EARLYACCESS := \ 99 <div style="background-color: $$(HASH)EEEEEE"> \ 100 <div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; \ 101 margin-left: 6px; margin-right: 6px; text-align: justify; \ 102 font-size: 80%; font-family: Helvetica, Arial, sans-serif; \ 103 font-weight: normal;"> \ 104 Please note that the specifications and other information \ 105 contained herein are not final and are subject to change. \ 106 The information is being made available to you solely for purpose of \ 107 evaluation. \ 108 </div> </div> 109 endif 110 111 ################################################################################ 112 # Support functions for SetupJavadocGeneration 113 114 # Print an option line to the target file 115 # Arguments: 116 # arg 1: the option name 117 # arg 2-3: optional arguments to the option 118 define AddOption 119 $(PRINTF) "%s$(if $(strip $2), '%s',)$(if $(strip $3), '%s',)\n" \ 120 "$(strip $1)"$(if $(strip $2), '$(strip $2)',)$(if $(strip $3), \ 121 '$(strip $3)',) >> $@ 122 endef 123 124 # This function goes to great pains to exactly mimic the old behavior 125 # in all details, including whitespace. 126 # Note that COPYRIGHT_YEAR is the current year (from spec.gmk) 127 # Arguments: 128 # arg 1: first copyright year 129 # arg 2: copyright url (optional) 130 # arg 3: company address (optional) 131 # arg 4: free-form text snippet (optional) 132 define GenerateBottom 133 <font size="-1">$(if $(strip $4), $(strip $4))<br> $(if \ 134 $(strip $2),<a href="$(strip $2)">$(COPYRIGHT_TEXT)</a>,$(COPYRIGHT_TEXT)) \ 135 $(COPYRIGHT_SYMBOL) $(strip $1), $(COPYRIGHT_YEAR),\ 136 $(FULL_COMPANY_NAME). $(strip $3) \ 137 $(ALL_RIGHTS_RESERVED)$(if $(strip $4), )</font> 138 endef 139 140 # Speed up finding by filling cache 141 $(eval $(call FillCacheFind, $(wildcard $(JAVADOC_SOURCE_DIRS)))) 142 143 # Prevent # from expanding 144 EscapeHash = $(subst $(HASH),{hash},$(strip $1)) 145 146 ################################################################################ 147 # Setup make rules for running javadoc. 148 # 149 # Parameter 1 is the name of the rule. This name is used as variable prefix, 150 # and the targets generated are listed in a variable by that name. Note that 151 # the index.html file will work as a "touch file" for all the magnitude of 152 # files that are generated by javadoc. 153 # 154 # Remaining parameters are named arguments. These include: 155 # MODULES - Modules to include 156 # PACKAGES - Packages to include 157 # REGEXP - Filter for packages 158 # IS_CORE - Set to TRUE for the Core API package which needs special treatment 159 # API_ROOT - Where to base the documentation (jre or jdk) 160 # DEST_DIR - A directory relative to the API root 161 # OVERVIEW - Path to a html overview file 162 # TITLE - Default title to use for the more specific versions below 163 # WINDOW_TITLE - Title to use in -windowtitle. Computed from TITLE if empty. 164 # HEADER_TITLE - Title to use in -header. Computed from TITLE if empty. 165 # DOC_TITLE - Title to use in -doctitle. Computed from TITLE if empty. 166 # FIRST_COPYRIGHT_YEAR - First year this bundle was introduced 167 # DOCLINT - Doclint level. Defaults to "all". 168 # DOCLINT_PACKAGES - Optional -Xdoclint/package value 169 # ENCODING - Change character encoding (defaults to 'ascii') 170 # SPLIT_INDEX - Enable -splitIndex 171 # BREAKITERATOR - Enable -breakiterator 172 # NODEPRECATEDLIST - Enable nodeprecatedlist 173 # NOINDEX - Enable -noindex and -nonavbar 174 # BOTTOM_COPYRIGHT_URL - Copyright URL to use in -bottom 175 # BOTTOM_ADDRESS - Company address to use in -bottom 176 # BOTTOM_TEXT - Extra text to use in -bottom 177 # EXTRA_TOP - Additional -top data 178 # 179 SetupJavadocGeneration = $(NamedParamsMacroTemplate) 180 define SetupJavadocGenerationBody 181 ifeq ($$($1_IS_CORE), TRUE) 182 $1_JAVA := $$(JAVA) 183 $1_OUTPUT_DIRNAME := api 184 else 185 $1_JAVA := $$(JAVA_SMALL) 186 $1_OUTPUT_DIRNAME := $$($1_API_ROOT)/api/$$($1_DEST_DIR) 187 188 ifeq ($$($1_RELATIVE_CORE_DIR),) 189 # Compute a relative path to core root. 190 # The non-core api javadocs need to be able to access the root of the core 191 # api directory, so for jdk/api or jre/api to get to the core api/ 192 # directory we would use this 193 # NOTE: Need to be able to override for broken old code in JShell 194 $1_RELATIVE_CORE_DIR := $$(strip $$(subst $$(call DirToDotDot, \ 195 $$(JAVADOC_OUTPUTDIR))/,, $$(call DirToDotDot, \ 196 $$(JAVADOC_OUTPUTDIR)/$$($1_OUTPUT_DIRNAME)))) 197 endif 198 199 $1_DEPS += $(CORE_INDEX_FILE) 200 endif 201 202 ifneq ($$($1_OVERVIEW), ) 203 $1_DEPS += $$($1_OVERVIEW) 204 endif 205 206 ifeq ($$($1_ENCODING), ) 207 $1_ENCODING := ascii 208 endif 209 210 ifeq ($$($1_DOCLINT), ) 211 $1_DOCLINT := all 212 endif 213 214 ifeq ($$($1_DOC_TITLE), ) 215 $1_DOC_TITLE := $$($1_TITLE) 216 endif 217 218 ifeq ($$($1_WINDOW_TITLE), ) 219 $1_WINDOW_TITLE := $$(strip $$(subst $$(TRADEMARK),, $$($1_TITLE))) 220 endif 221 222 ifeq ($$($1_HEADER_TITLE), ) 223 $1_HEADER_TITLE := $$(strip $$(subst $$(TRADEMARK),, $$($1_TITLE))) 224 endif 225 $1_HEADER := <strong>$$($1_HEADER_TITLE)</strong> 226 227 $1_BOTTOM := $$(call GenerateBottom, $$($1_FIRST_COPYRIGHT_YEAR), \ 228 $$($1_BOTTOM_COPYRIGHT_URL), $$($1_BOTTOM_ADDRESS), $$($1_BOTTOM_TEXT)) 229 230 # The index.html, options, and packages files 231 $1_INDEX_FILE := $$(JAVADOC_OUTPUTDIR)/$$($1_OUTPUT_DIRNAME)/index.html 232 $1_OPTIONS_FILE := $$(SUPPORT_OUTPUTDIR)/docs/$1.options 233 $1_PACKAGES_FILE := $$(SUPPORT_OUTPUTDIR)/docs/$1.packages 234 235 $1_PACKAGES_VARDEPS := $$($1_PACKAGES) $$($1_PACKAGES_SINGLE_CLASS) 236 $1_PACKAGES_VARDEPS_FILE := $$(call DependOnVariable, $1_PACKAGES_VARDEPS, \ 237 $$($1_PACKAGES_FILE).vardeps) 238 239 # Rule for creating a file with the package names in it 240 $$($1_PACKAGES_FILE): $$($1_PACKAGES_VARDEPS_FILE) 241 $$(call LogInfo, Creating Javadoc package file for $1) 242 $$(call MakeDir, $$(@D)) 243 ifeq ($$($1_PACKAGES_SINGLE_CLASS), ) 244 $$(ECHO) $$($1_PACKAGES) | $$(TR) ' ' '\n' > $$@ 245 else 246 # NOTE: This is for backwards compatibility for taglet 247 $$(ECHO) $$($1_PACKAGES_SINGLE_CLASS) > $$@ 248 endif 249 250 # NOTE: Not including $$($1_EXTRA_TOP) due to $$(HASH) 251 $1_OPTIONS_VARDEPS := $$(call EscapeHash, \ 252 $$($DOCROOTPARENT_FLAG) $$(JAVADOC_BASE_URL) $$($1_NO_COMMON_TAGS) \ 253 $$($1_DOCLINT) $$($1_DOCLINT_PACKAGES) $$(JAVADOC_SOURCE_DIRS) \ 254 $$($1_MODULES) $$($1_ENCODING) $$($1_NODEPRECATEDLIST) \ 255 $$($1_BREAKITERATOR) $$($1_SPLIT_INDEX) $$($1_OVERVIEW) \ 256 $$($1_DOC_TITLE) $$($1_WINDOW_TITLE) $$(DRAFT_WINTITLE) \ 257 $$($1_HEADER) $$(DRAFT_HEADER) $$($1_NOINDEX) $$($1_EXTRA_TOP_2) \ 258 $$($1_BOTTOM) $$(DRAFT_BOTTOM)) $$($1_REGEXP) $$($1_RELATIVE_CORE_DIR) \ 259 $$(JAVADOC_OUTPUTDIR) \ 260 ) 261 $1_OPTIONS_VARDEPS_FILE := $$(call DependOnVariable, $1_OPTIONS_VARDEPS, \ 262 $$($1_OPTIONS_FILE).vardeps) 263 264 # Rule for creating a file with javadoc options in it 265 $$($1_OPTIONS_FILE): $$($1_OPTIONS_VARDEPS_FILE) 266 $$(call LogInfo, Creating Javadoc options file for $1) 267 $$(call MakeDir, $$(@D)) 268 $$(RM) $$@ 269 $$(call AddOption, -XDignore.symbol.file=true) 270 ifneq ($$(LOG_LEVEL), trace) 271 $$(call AddOption, -quiet) 272 endif 273 $$(call AddOption, -use) 274 $$(call AddOption, -keywords) 275 ifneq ($$($DOCROOTPARENT_FLAG), ) 276 # NOTE: Argument to -Xdocrootparent is not quoted to keep backwards compatibility. 277 $$(call AddOption, -Xdocrootparent $(JAVADOC_BASE_URL)) 278 endif 279 ifneq ($$($1_NO_COMMON_TAGS), TRUE) 280 # In order to get a specific ordering it's necessary to specify the total 281 # ordering of tags as the tags are otherwise ordered in order of definition. 282 $$(call AddOption, -tag, beaninfo:X) 283 $$(call AddOption, -tag, revised:X) 284 $$(call AddOption, -tag, since.unbundled:X) 285 $$(call AddOption, -tag, spec:X) 286 $$(call AddOption, -tag, specdefault:X) 287 $$(call AddOption, -tag, Note:X) 288 $$(call AddOption, -tag, ToDo:X) 289 $$(call AddOption, -tag, apiNote:a:API Note:) 290 $$(call AddOption, -tag, implSpec:a:Implementation Requirements:) 291 $$(call AddOption, -tag, implNote:a:Implementation Note:) 292 $$(call AddOption, -tag, param) 293 $$(call AddOption, -tag, return) 294 $$(call AddOption, -tag, throws) 295 $$(call AddOption, -tag, since) 296 $$(call AddOption, -tag, version) 297 $$(call AddOption, -tag, serialData) 298 $$(call AddOption, -tag, factory) 299 $$(call AddOption, -tag, see) 300 $$(call AddOption, -tag, \ 301 jvms:a:See <cite> The Java™ Virtual Machine Specification</cite>:) 302 $$(call AddOption, -tag, \ 303 jls:a:See <cite> The Java™ Language Specification</cite>:) 304 endif 305 $$(call AddOption, -Xdoclint:$$($1_DOCLINT)) 306 ifneq ($$($1_DOCLINT_PACKAGES), ) 307 $$(call AddOption, -Xdoclint/package:$$(call CommaList, $$($1_DOCLINT_PACKAGES))) 308 endif 309 $$(call AddOption, --system, none) 310 $$(call AddOption, --module-source-path, $$(subst ",, $$(call PathList, $$(JAVADOC_SOURCE_DIRS)))) 311 $$(call AddOption, --add-modules, $$(call CommaList, $$($1_MODULES))) 312 $$(call AddOption, -encoding, $$($1_ENCODING)) 313 ifneq ($$($1_NODEPRECATEDLIST), ) 314 $$(call AddOption, -nodeprecatedlist) 315 endif 316 ifneq ($$($1_BREAKITERATOR), ) 317 $$(call AddOption, -breakiterator) 318 endif 319 ifneq ($$($1_SPLIT_INDEX), ) 320 $$(call AddOption, -splitIndex) 321 endif 322 ifneq ($$($1_OVERVIEW), ) 323 $$(call AddOption, -overview, $$($1_OVERVIEW)) 324 endif 325 $$(call AddOption, -doctitle, $$($1_DOC_TITLE)) 326 $$(call AddOption, -windowtitle, $$($1_WINDOW_TITLE) $$(DRAFT_WINTITLE)) 327 $$(call AddOption, -header, $$($1_HEADER)$$(DRAFT_HEADER)) 328 ifneq ($$($1_NOINDEX), ) 329 $$(call AddOption, -nonavbar) 330 $$(call AddOption, -noindex) 331 endif 332 ifneq ($$($1_EXTRA_TOP_2), ) 333 $$(call AddOption, -top,$$($1_EXTRA_TOP_2)) 334 endif 335 $$(call AddOption, -bottom, $$($1_BOTTOM)$$(DRAFT_BOTTOM)) 336 ifneq ($$($1_REGEXP), ) 337 $$(call AddOption, -group, Packages, $$($1_REGEXP)) 338 endif 339 ifneq ($$($1_RELATIVE_CORE_DIR), ) 340 $$(call AddOption, -linkoffline, $$($1_RELATIVE_CORE_DIR)/api, $$(JAVADOC_OUTPUTDIR)/api/) 341 endif 342 ifneq ($$($1_EXTRA_TOP), ) 343 $$(call AddOption, -top, $$($1_EXTRA_TOP)) 344 endif 345 346 $1_PACKAGE_DEPS := $$(call CacheFind, $$(wildcard $$(foreach p, \ 347 $$(subst .,/,$$(strip $$($1_PACKAGES))), \ 348 $$(addsuffix /$$p, $$(wildcard $$(JAVADOC_SOURCE_DIRS)))))) 349 350 # Rule for actually running javadoc 351 $$($1_INDEX_FILE): $$($1_OPTIONS_FILE) $$($1_PACKAGES_FILE) \ 352 $$($1_PACKAGE_DEPS) $$($1_DEPS) 353 $$(call LogWarn, Generating Javadoc for $$($1_OUTPUT_DIRNAME)) 354 $$(call MakeDir, $$(@D)) 355 ifneq ($$(findstring $$(LOG_LEVEL), debug trace),) 356 $$(ECHO) "Contents of $$($1_OPTIONS_FILE):" `$$(CAT) $$($1_OPTIONS_FILE)` 357 $$(ECHO) "Contents of $$($1_PACKAGES_FILE):" `$$(CAT) $$($1_PACKAGES_FILE)` 358 endif 359 $$(call ExecuteWithLog, $$(SUPPORT_OUTPUTDIR)/docs/$1.javadoc, \ 360 $$($1_JAVA) -Djava.awt.headless=true $(NEW_JAVADOC) -d $$(@D) \ 361 @$$($1_OPTIONS_FILE) @$$($1_PACKAGES_FILE)) 362 $$(TOUCH) $$($1_INDEX_FILE) 363 364 # The output returned will be the index.html file 365 $1 := $$($1_INDEX_FILE) 366 endef 367 368 ################################################################################ 369 370 CORE_PACKAGES := \ 371 java.applet \ 372 java.awt \ 373 java.awt.color \ 374 java.awt.datatransfer \ 375 java.awt.desktop \ 376 java.awt.dnd \ 377 java.awt.event \ 378 java.awt.font \ 379 java.awt.geom \ 380 java.awt.im \ 381 java.awt.im.spi \ 382 java.awt.image \ 383 java.awt.image.renderable \ 384 java.awt.print \ 385 java.beans \ 386 java.beans.beancontext \ 387 java.io \ 388 java.lang \ 389 java.lang.annotation \ 390 java.lang.instrument \ 391 java.lang.invoke \ 392 java.lang.management \ 393 java.lang.module \ 394 java.lang.ref \ 395 java.lang.reflect \ 396 java.math \ 397 java.net \ 398 java.net.http \ 399 java.net.spi \ 400 java.nio \ 401 java.nio.channels \ 402 java.nio.channels.spi \ 403 java.nio.charset \ 404 java.nio.charset.spi \ 405 java.nio.file \ 406 java.nio.file.attribute \ 407 java.nio.file.spi \ 408 java.rmi \ 409 java.rmi.activation \ 410 java.rmi.dgc \ 411 java.rmi.registry \ 412 java.rmi.server \ 413 java.security \ 414 java.security.acl \ 415 java.security.cert \ 416 java.security.interfaces \ 417 java.security.spec \ 418 java.sql \ 419 java.text \ 420 java.text.spi \ 421 java.time \ 422 java.time.chrono \ 423 java.time.format \ 424 java.time.temporal \ 425 java.time.zone \ 426 java.util \ 427 java.util.concurrent \ 428 java.util.concurrent.atomic \ 429 java.util.concurrent.locks \ 430 java.util.function \ 431 java.util.jar \ 432 java.util.logging \ 433 java.util.prefs \ 434 java.util.regex \ 435 java.util.spi \ 436 java.util.stream \ 437 java.util.zip \ 438 javax.accessibility \ 439 javax.activation \ 440 javax.activity \ 441 javax.annotation \ 442 javax.annotation.processing \ 443 javax.crypto \ 444 javax.crypto.interfaces \ 445 javax.crypto.spec \ 446 javax.imageio \ 447 javax.imageio.event \ 448 javax.imageio.metadata \ 449 javax.imageio.plugins.jpeg \ 450 javax.imageio.plugins.bmp \ 451 javax.imageio.plugins.tiff \ 452 javax.imageio.spi \ 453 javax.imageio.stream \ 454 javax.jws \ 455 javax.jws.soap \ 456 javax.lang.model \ 457 javax.lang.model.element \ 458 javax.lang.model.type \ 459 javax.lang.model.util \ 460 javax.management \ 461 javax.management.loading \ 462 javax.management.monitor \ 463 javax.management.relation \ 464 javax.management.openmbean \ 465 javax.management.timer \ 466 javax.management.modelmbean \ 467 javax.management.remote \ 468 javax.management.remote.rmi \ 469 javax.naming \ 470 javax.naming.directory \ 471 javax.naming.event \ 472 javax.naming.ldap \ 473 javax.naming.spi \ 474 javax.net \ 475 javax.net.ssl \ 476 javax.print \ 477 javax.print.attribute \ 478 javax.print.attribute.standard \ 479 javax.print.event \ 480 javax.rmi \ 481 javax.rmi.CORBA \ 482 javax.rmi.ssl \ 483 javax.script \ 484 javax.security.auth \ 485 javax.security.auth.callback \ 486 javax.security.auth.kerberos \ 487 javax.security.auth.login \ 488 javax.security.auth.spi \ 489 javax.security.auth.x500 \ 490 javax.security.cert \ 491 javax.security.sasl \ 492 javax.sound.sampled \ 493 javax.sound.sampled.spi \ 494 javax.sound.midi \ 495 javax.sound.midi.spi \ 496 javax.sql \ 497 javax.sql.rowset \ 498 javax.sql.rowset.serial \ 499 javax.sql.rowset.spi \ 500 javax.swing \ 501 javax.swing.border \ 502 javax.swing.colorchooser \ 503 javax.swing.filechooser \ 504 javax.swing.event \ 505 javax.swing.table \ 506 javax.swing.text \ 507 javax.swing.text.html \ 508 javax.swing.text.html.parser \ 509 javax.swing.text.rtf \ 510 javax.swing.tree \ 511 javax.swing.undo \ 512 javax.swing.plaf \ 513 javax.swing.plaf.basic \ 514 javax.swing.plaf.metal \ 515 javax.swing.plaf.multi \ 516 javax.swing.plaf.nimbus \ 517 javax.swing.plaf.synth \ 518 javax.tools \ 519 javax.transaction \ 520 javax.transaction.xa \ 521 javax.xml.catalog \ 522 javax.xml.parsers \ 523 javax.xml.bind \ 524 javax.xml.bind.annotation \ 525 javax.xml.bind.annotation.adapters \ 526 javax.xml.bind.attachment \ 527 javax.xml.bind.helpers \ 528 javax.xml.bind.util \ 529 javax.xml.soap \ 530 javax.xml.ws \ 531 javax.xml.ws.handler \ 532 javax.xml.ws.handler.soap \ 533 javax.xml.ws.http \ 534 javax.xml.ws.soap \ 535 javax.xml.ws.spi \ 536 javax.xml.ws.spi.http \ 537 javax.xml.ws.wsaddressing \ 538 javax.xml.transform \ 539 javax.xml.transform.sax \ 540 javax.xml.transform.dom \ 541 javax.xml.transform.stax \ 542 javax.xml.transform.stream \ 543 javax.xml \ 544 javax.xml.crypto \ 545 javax.xml.crypto.dom \ 546 javax.xml.crypto.dsig \ 547 javax.xml.crypto.dsig.dom \ 548 javax.xml.crypto.dsig.keyinfo \ 549 javax.xml.crypto.dsig.spec \ 550 javax.xml.datatype \ 551 javax.xml.validation \ 552 javax.xml.namespace \ 553 javax.xml.xpath \ 554 javax.xml.stream \ 555 javax.xml.stream.events \ 556 javax.xml.stream.util \ 557 org.ietf.jgss \ 558 org.omg.CORBA \ 559 org.omg.CORBA.DynAnyPackage \ 560 org.omg.CORBA.ORBPackage \ 561 org.omg.CORBA.TypeCodePackage \ 562 org.omg.stub.java.rmi \ 563 org.omg.CORBA.portable \ 564 org.omg.CORBA_2_3 \ 565 org.omg.CORBA_2_3.portable \ 566 org.omg.CosNaming \ 567 org.omg.CosNaming.NamingContextExtPackage \ 568 org.omg.CosNaming.NamingContextPackage \ 569 org.omg.SendingContext \ 570 org.omg.PortableServer \ 571 org.omg.PortableServer.CurrentPackage \ 572 org.omg.PortableServer.POAPackage \ 573 org.omg.PortableServer.POAManagerPackage \ 574 org.omg.PortableServer.ServantLocatorPackage \ 575 org.omg.PortableServer.portable \ 576 org.omg.PortableInterceptor \ 577 org.omg.PortableInterceptor.ORBInitInfoPackage \ 578 org.omg.Messaging \ 579 org.omg.IOP \ 580 org.omg.IOP.CodecFactoryPackage \ 581 org.omg.IOP.CodecPackage \ 582 org.omg.Dynamic \ 583 org.omg.DynamicAny \ 584 org.omg.DynamicAny.DynAnyPackage \ 585 org.omg.DynamicAny.DynAnyFactoryPackage \ 586 org.w3c.dom \ 587 org.w3c.dom.events \ 588 org.w3c.dom.bootstrap \ 589 org.w3c.dom.ls \ 590 org.w3c.dom.ranges \ 591 org.w3c.dom.traversal \ 592 org.w3c.dom.views \ 593 org.xml.sax \ 594 org.xml.sax.ext \ 595 org.xml.sax.helpers 596 597 $(eval $(call SetupJavadocGeneration, coredocs, \ 598 MODULES := java.se.ee, \ 599 PACKAGES := $(CORE_PACKAGES), \ 600 IS_CORE := TRUE, \ 601 OVERVIEW := $(JDK_TOPDIR)/src/java.base/share/classes/overview-core.html, \ 602 WINDOW_TITLE := Java Platform SE $(VERSION_SPECIFICATION), \ 603 HEADER_TITLE := Java$(TRADEMARK) Platform<br>Standard Ed. $(VERSION_SPECIFICATION), \ 604 DOC_TITLE := Java$(TRADEMARK) Platform$(COMMA) Standard Edition \ 605 $(VERSION_SPECIFICATION)<br>API Specification, \ 606 FIRST_COPYRIGHT_YEAR := 1993, \ 607 DOCLINT := reference, \ 608 DOCLINT_PACKAGES := -org.omg.* jdk.internal.logging.*, \ 609 ENCODING := ISO-8859-1, \ 610 SPLIT_INDEX := TRUE, \ 611 BOTTOM_COPYRIGHT_URL := $(CORE_BOTTOM_COPYRIGHT_URL), \ 612 BOTTOM_TEXT := $(CORE_BOTTOM_TEXT), \ 613 EXTRA_TOP := $(CORE_TOP_EARLYACCESS), \ 614 )) 615 616 TARGETS += $(coredocs) 617 618 ################################################################################ 619 620 $(eval $(call SetupJavadocGeneration, docletapi, \ 621 MODULES := jdk.javadoc, \ 622 PACKAGES := \ 623 jdk.javadoc.doclet \ 624 jdk.javadoc.doclet.taglet \ 625 jdk.javadoc.doclets, \ 626 REGEXP := jdk.javadoc.doclet*, \ 627 API_ROOT := jdk,\ 628 DEST_DIR := javadoc/doclet,\ 629 TITLE := Doclet API, \ 630 FIRST_COPYRIGHT_YEAR := 1993, \ 631 BREAKITERATOR := TRUE, \ 632 BOTTOM_ADDRESS := $(COMMON_BOTTOM_ADDRESS), \ 633 BOTTOM_TEXT := $(COMMON_BOTTOM_TEXT), \ 634 )) 635 636 TARGETS += $(docletapi) 637 638 ################################################################################ 639 640 $(eval $(call SetupJavadocGeneration, old-docletapi, \ 641 MODULES := jdk.javadoc, \ 642 PACKAGES := com.sun.javadoc, \ 643 REGEXP := com.sun.javadoc, \ 644 API_ROOT := jdk,\ 645 DEST_DIR := javadoc/old/doclet,\ 646 TITLE := Doclet API, \ 647 FIRST_COPYRIGHT_YEAR := 1993, \ 648 BREAKITERATOR := TRUE, \ 649 BOTTOM_ADDRESS := $(COMMON_BOTTOM_ADDRESS), \ 650 BOTTOM_TEXT := $(COMMON_BOTTOM_TEXT), \ 651 )) 652 653 TARGETS += $(old-docletapi) 654 655 ################################################################################ 656 657 # Specify a single class instead of a package 658 TAGLET_PACKAGE_SINGLE_CLASS := com/sun/tools/doclets/Taglet.java 659 TAGLET_PACKAGE_DIR := $(LANGTOOLS_TOPDIR)/src/jdk.javadoc/share/classes 660 661 $(eval $(call SetupJavadocGeneration, tagletapi, \ 662 MODULES := jdk.javadoc, \ 663 PACKAGES := com.sun.tools.doclets, \ 664 PACKAGES_SINGLE_CLASS := $(TAGLET_PACKAGE_DIR)/$(TAGLET_PACKAGE_SINGLE_CLASS), \ 665 API_ROOT := jdk,\ 666 DEST_DIR := javadoc/old/taglet,\ 667 TITLE := Taglet API, \ 668 FIRST_COPYRIGHT_YEAR := 1993, \ 669 BREAKITERATOR := TRUE, \ 670 NOINDEX := TRUE, \ 671 BOTTOM_ADDRESS := $(COMMON_BOTTOM_ADDRESS), \ 672 BOTTOM_TEXT := $(COMMON_BOTTOM_TEXT), \ 673 )) 674 675 TARGETS += $(tagletapi) 676 677 ################################################################################ 678 679 $(eval $(call SetupJavadocGeneration, domapi, \ 680 MODULES := \ 681 java.xml \ 682 jdk.xml.dom, \ 683 PACKAGES := \ 684 org.w3c.dom \ 685 org.w3c.dom.bootstrap \ 686 org.w3c.dom.ls \ 687 org.w3c.dom.ranges \ 688 org.w3c.dom.traversal \ 689 org.w3c.dom.html \ 690 org.w3c.dom.stylesheets \ 691 org.w3c.dom.css \ 692 org.w3c.dom.events \ 693 org.w3c.dom.views, \ 694 REGEXP := org.w3c.dom*, \ 695 API_ROOT := jre,\ 696 DEST_DIR := plugin/dom,\ 697 TITLE := Common DOM API, \ 698 FIRST_COPYRIGHT_YEAR := 2005, \ 699 DOCLINT := none, \ 700 SPLIT_INDEX := TRUE, \ 701 BOTTOM_ADDRESS := $(COMMON_BOTTOM_ADDRESS), \ 702 BOTTOM_TEXT := $(COMMON_BOTTOM_TEXT), \ 703 )) 704 705 TARGETS += $(domapi) 706 707 ################################################################################ 708 709 $(eval $(call SetupJavadocGeneration, jdi, \ 710 MODULES := jdk.jdi, \ 711 PACKAGES := \ 712 com.sun.jdi \ 713 com.sun.jdi.event \ 714 com.sun.jdi.request \ 715 com.sun.jdi.connect \ 716 com.sun.jdi.connect.spi, \ 717 API_ROOT := jdk,\ 718 DEST_DIR := jpda/jdi,\ 719 OVERVIEW := $(JDK_TOPDIR)/src/jdk.jdi/share/classes/jdi-overview.html, \ 720 TITLE := Java$(TRADEMARK) Debug Interface, \ 721 FIRST_COPYRIGHT_YEAR := 1999, \ 722 DOCLINT := none, \ 723 )) 724 725 TARGETS += $(jdi) 726 727 ################################################################################ 728 729 $(eval $(call SetupJavadocGeneration, jaas, \ 730 MODULES := jdk.security.auth, \ 731 PACKAGES := \ 732 com.sun.security.auth \ 733 com.sun.security.auth.callback \ 734 com.sun.security.auth.login \ 735 com.sun.security.auth.module, \ 736 API_ROOT := jre,\ 737 DEST_DIR := security/jaas/spec,\ 738 OVERVIEW := $(JDK_TOPDIR)/src/jdk.security.auth/share/classes/jaas-overview.html, \ 739 TITLE := Java$(TRADEMARK) Authentication and Authorization Service, \ 740 FIRST_COPYRIGHT_YEAR := 1998, \ 741 DOCLINT := none, \ 742 )) 743 744 TARGETS += $(jaas) 745 746 ################################################################################ 747 748 $(eval $(call SetupJavadocGeneration, jgss, \ 749 MODULES := jdk.security.jgss, \ 750 PACKAGES := com.sun.security.jgss, \ 751 API_ROOT := jre,\ 752 DEST_DIR := security/jgss/spec,\ 753 OVERVIEW := $(JDK_TOPDIR)/src/java.security.jgss/share/classes/jgss-overview.html, \ 754 TITLE := Java$(TRADEMARK) GSS-API Utilities, \ 755 FIRST_COPYRIGHT_YEAR := 2000, \ 756 DOCLINT := none, \ 757 NODEPRECATEDLIST := TRUE, \ 758 )) 759 760 TARGETS += $(jgss) 761 762 ################################################################################ 763 764 $(eval $(call SetupJavadocGeneration, smartcardio, \ 765 MODULES := java.smartcardio, \ 766 PACKAGES := javax.smartcardio, \ 767 API_ROOT := jre,\ 768 DEST_DIR := security/smartcardio/spec,\ 769 TITLE := Java$(TRADEMARK) Smart Card I/O, \ 770 FIRST_COPYRIGHT_YEAR := 2005, \ 771 DOCLINT := none, \ 772 NODEPRECATEDLIST := TRUE, \ 773 )) 774 775 TARGETS += $(smartcardio) 776 777 ################################################################################ 778 779 $(eval $(call SetupJavadocGeneration, httpserver, \ 780 MODULES := jdk.httpserver, \ 781 PACKAGES := \ 782 com.sun.net.httpserver \ 783 com.sun.net.httpserver.spi, \ 784 API_ROOT := jre,\ 785 DEST_DIR := net/httpserver/spec,\ 786 TITLE := Java$(TRADEMARK) HTTP Server, \ 787 FIRST_COPYRIGHT_YEAR := 2005, \ 788 DOCLINT := none, \ 789 NODEPRECATEDLIST := TRUE, \ 790 )) 791 792 TARGETS += $(httpserver) 793 794 ################################################################################ 795 796 $(eval $(call SetupJavadocGeneration, jsobject, \ 797 MODULES := jdk.jsobject, \ 798 PACKAGES := netscape.javascript, \ 799 API_ROOT := jre,\ 800 DEST_DIR := plugin/jsobject,\ 801 FIRST_COPYRIGHT_YEAR := 1993, \ 802 TITLE := Java$(TRADEMARK) JSObject Doc, \ 803 DOCLINT := none, \ 804 NODEPRECATEDLIST := TRUE, \ 805 )) 806 807 TARGETS += $(jsobject) 808 809 ################################################################################ 810 811 $(eval $(call SetupJavadocGeneration, mgmt, \ 812 MODULES := jdk.management, \ 813 PACKAGES := com.sun.management, \ 814 API_ROOT := jre,\ 815 DEST_DIR := management/extension,\ 816 OVERVIEW := $(JDK_TOPDIR)/src/java.management/share/classes/mgmt-overview.html, \ 817 TITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform, \ 818 FIRST_COPYRIGHT_YEAR := 2003, \ 819 DOCLINT := none, \ 820 NODEPRECATEDLIST := TRUE, \ 821 )) 822 823 TARGETS += $(mgmt) 824 825 ################################################################################ 826 827 $(eval $(call SetupJavadocGeneration, attach, \ 828 MODULES := jdk.attach, \ 829 PACKAGES := \ 830 com.sun.tools.attach \ 831 com.sun.tools.attach.spi, \ 832 API_ROOT := jdk,\ 833 DEST_DIR := attach/spec,\ 834 TITLE := Attach API, \ 835 FIRST_COPYRIGHT_YEAR := 2005, \ 836 DOCLINT := none, \ 837 NODEPRECATEDLIST := TRUE, \ 838 )) 839 840 TARGETS += $(attach) 841 842 ################################################################################ 843 844 $(eval $(call SetupJavadocGeneration, jconsole, \ 845 MODULES := jdk.jconsole, \ 846 PACKAGES := com.sun.tools.jconsole, \ 847 API_ROOT := jdk,\ 848 DEST_DIR := jconsole/spec,\ 849 TITLE := JConsole API, \ 850 FIRST_COPYRIGHT_YEAR := 2006, \ 851 DOCLINT := none, \ 852 NODEPRECATEDLIST := TRUE, \ 853 )) 854 855 TARGETS += $(jconsole) 856 857 ################################################################################ 858 859 # NOTE: Need to override RELATIVE_CORE_DIR to be bug compatible with old code. 860 $(eval $(call SetupJavadocGeneration, jshellapi, \ 861 MODULES := jdk.jshell, \ 862 PACKAGES := \ 863 jdk.jshell \ 864 jdk.jshell.spi \ 865 jdk.jshell.execution, \ 866 API_ROOT := jdk,\ 867 DEST_DIR := jshell,\ 868 RELATIVE_CORE_DIR := ../../../.., \ 869 OVERVIEW := $(LANGTOOLS_TOPDIR)/src/jdk.jshell/share/classes/jdk/jshell/overview.html, \ 870 TITLE := JShell API, \ 871 HEADER_TITLE := JSHELL API, \ 872 FIRST_COPYRIGHT_YEAR := 2015, \ 873 )) 874 875 TARGETS += $(jshellapi) 876 877 ################################################################################ 878 879 $(eval $(call SetupJavadocGeneration, treeapi, \ 880 MODULES := jdk.compiler, \ 881 PACKAGES := \ 882 com.sun.source.doctree \ 883 com.sun.source.tree \ 884 com.sun.source.util, \ 885 REGEXP := com.sun.source.*, \ 886 API_ROOT := jdk,\ 887 DEST_DIR := javac/tree,\ 888 TITLE := Compiler Tree API, \ 889 FIRST_COPYRIGHT_YEAR := 2005, \ 890 )) 891 892 TARGETS += $(treeapi) 893 894 ################################################################################ 895 896 $(eval $(call SetupJavadocGeneration, nashornapi, \ 897 MODULES := jdk.scripting.nashorn, \ 898 PACKAGES := \ 899 jdk.nashorn.api.scripting \ 900 jdk.nashorn.api.tree, \ 901 REGEXP := jdk.nashorn.api.*, \ 902 API_ROOT := jdk,\ 903 DEST_DIR := nashorn,\ 904 TITLE := Nashorn API, \ 905 FIRST_COPYRIGHT_YEAR := 2014, \ 906 )) 907 908 TARGETS += $(nashornapi) 909 910 ################################################################################ 911 912 $(eval $(call SetupJavadocGeneration, dynalinkapi, \ 913 MODULES := jdk.dynalink, \ 914 PACKAGES := \ 915 jdk.dynalink \ 916 jdk.dynalink.beans \ 917 jdk.dynalink.linker \ 918 jdk.dynalink.linker.support \ 919 jdk.dynalink.support, \ 920 API_ROOT := jdk,\ 921 DEST_DIR := dynalink,\ 922 TITLE := Dynalink API, \ 923 FIRST_COPYRIGHT_YEAR := 2015, \ 924 )) 925 926 TARGETS += $(dynalinkapi) 927 928 ################################################################################ 929 930 $(eval $(call SetupJavadocGeneration, sctp, \ 931 MODULES := jdk.sctp, \ 932 PACKAGES := com.sun.nio.sctp, \ 933 API_ROOT := jre,\ 934 DEST_DIR := nio/sctp/spec,\ 935 TITLE := SCTP API, \ 936 FIRST_COPYRIGHT_YEAR := 2009, \ 937 DOCLINT := none, \ 938 NODEPRECATEDLIST := TRUE, \ 939 )) 940 941 TARGETS += $(sctp) 942 943 ################################################################################ 944 945 $(eval $(call SetupJavadocGeneration, jaccess, \ 946 MODULES := jdk.accessibility, \ 947 PACKAGES := com.sun.java.accessibility.util, \ 948 API_ROOT := jre,\ 949 DEST_DIR := accessibility/jaccess/spec,\ 950 TITLE := JACCESS API, \ 951 FIRST_COPYRIGHT_YEAR := 2002, \ 952 NODEPRECATEDLIST := TRUE, \ 953 )) 954 955 TARGETS += $(jaccess) 956 957 ################################################################################ 958 959 $(eval $(call SetupJavadocGeneration, jdknet, \ 960 MODULES := jdk.net, \ 961 PACKAGES := jdk.net, \ 962 API_ROOT := jre,\ 963 DEST_DIR := net/socketoptions/spec,\ 964 TITLE := jdk.net API, \ 965 FIRST_COPYRIGHT_YEAR := 2014, \ 966 DOCLINT := none, \ 967 NODEPRECATEDLIST := TRUE, \ 968 )) 969 970 TARGETS += $(jdknet) 971 972 ################################################################################ 973 974 # TODO: Need to decide when the plugin API is ready to publish as experimental API. 975 # This target is temporarily added for internal use for now. 976 $(eval $(call SetupJavadocGeneration, jlinkplugins, \ 977 MODULES := jdk.jlink, \ 978 PACKAGES := jdk.tools.jlink.plugin, \ 979 API_ROOT := jdk,\ 980 DEST_DIR := jlink,\ 981 TITLE := JLink Plugin API - EXPERIMENTAL, \ 982 FIRST_COPYRIGHT_YEAR := 2015, \ 983 DOCLINT := none, \ 984 NODEPRECATEDLIST := TRUE, \ 985 )) 986 987 TARGETS += $(jlinkplugins) 988 989 ################################################################################ 990 # Copy JDWP html file 991 992 JDWP_HTML := $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html 993 994 $(eval $(call SetupCopyFiles, COPY_JDWP_HTML, \ 995 FILES := $(JDWP_HTML), \ 996 DEST := $(JAVADOC_OUTPUTDIR)/platform/jpda/jdwp, \ 997 )) 998 999 COPY_TARGETS += $(COPY_JDWP_HTML) 1000 1001 ################################################################################ 1002 # Copy JVMTI html file 1003 1004 # Pick jvmti.html from any jvm variant, they are all the same. 1005 JVMTI_HTML := $(firstword \ 1006 $(wildcard $(HOTSPOT_OUTPUTDIR)/variant-*/gensrc/jvmtifiles/jvmti.html)) 1007 1008 $(eval $(call SetupCopyFiles, COPY_JVMTI_HTML, \ 1009 FILES := $(JVMTI_HTML), \ 1010 DEST := $(JAVADOC_OUTPUTDIR)/platform/jvmti, \ 1011 )) 1012 1013 COPY_TARGETS += $(COPY_JVMTI_HTML) 1014 1015 ################################################################################ 1016 # Optional target which bundles all generated javadocs into a zip archive. 1017 # The dependency on docs is handled in Main.gmk. 1018 1019 # Add the core docs as prerequisite to the archive to trigger a rebuild 1020 # if the core docs were rebuilt. Ideally any doc rebuild should trigger 1021 # this, but the way prerequisites are currently setup in this file, that 1022 # is hard to achieve. 1023 1024 JAVADOC_ARCHIVE_NAME := jdk-$(VERSION_STRING)-docs.zip 1025 JAVADOC_ARCHIVE_ASSEMBLY_DIR := $(SUPPORT_OUTPUTDIR)/docs/zip-docs 1026 JAVADOC_ARCHIVE_DIR := $(OUTPUT_ROOT)/bundles 1027 JAVADOC_ARCHIVE := $(JAVADOC_ARCHIVE_DIR)/$(JAVADOC_ARCHIVE_NAME) 1028 1029 $(JAVADOC_ARCHIVE): $(CORE_INDEX_FILE) 1030 $(call LogInfo, Compressing javadoc to single $(JAVADOC_ARCHIVE_NAME)) 1031 $(MKDIR) -p $(JAVADOC_ARCHIVE_DIR) 1032 $(RM) -r $(JAVADOC_ARCHIVE_ASSEMBLY_DIR) 1033 $(MKDIR) -p $(JAVADOC_ARCHIVE_ASSEMBLY_DIR) 1034 all_roots=`$(FIND) $(JAVADOC_OUTPUTDIR) | $(GREP) index.html | grep -v old/doclet`; \ 1035 pushd $(JAVADOC_ARCHIVE_ASSEMBLY_DIR); \ 1036 for index_file in $${all_roots} ; do \ 1037 target_dir=`dirname $${index_file}`; \ 1038 name=`$(ECHO) $${target_dir} | $(SED) "s;/spec;;" | $(SED) "s;.*/;;"`; \ 1039 $(LN) -s $${target_dir} $${name}; \ 1040 done; \ 1041 $(ZIP) -q -r $(JAVADOC_ARCHIVE) * ; \ 1042 popd ; 1043 1044 ZIP_TARGETS += $(JAVADOC_ARCHIVE) 1045 1046 ################################################################################ 1047 1048 # Hook to include the corresponding custom file, if present. 1049 $(eval $(call IncludeCustomExtension, , Javadoc.gmk)) 1050 1051 ################################################################################ 1052 1053 docs-javadoc: $(TARGETS) 1054 1055 docs-copy: $(COPY_TARGETS) 1056 1057 docs-zip: $(ZIP_TARGETS) 1058 1059 all: docs-javadoc docs-copy docs-zip 1060 1061 .PHONY: default all docs-javadoc docs-copy docs-zip |