1 # Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved. 2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 3 # 4 # This code is free software; you can redistribute it and/or modify it 5 # under the terms of the GNU General Public License version 2 only, as 6 # published by the Free Software Foundation. Oracle designates this 7 # particular file as subject to the "Classpath" exception as provided 8 # by Oracle in the LICENSE file that accompanied this code. 9 # 10 # This code is distributed in the hope that it will be useful, but WITHOUT 11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 13 # version 2 for more details (a copy is included in the LICENSE file that 14 # accompanied this code). 15 # 16 # You should have received a copy of the GNU General Public License version 17 # 2 along with this work; if not, write to the Free Software Foundation, 18 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 19 # 20 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 21 # or visit www.oracle.com if you need additional information or have any 22 # questions. 23 # 24 25 include $(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 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.*) ; \ 428 $(call OptionPair,-system,none) ; \ 429 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 430 $(call OptionPair,-addmods,$(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,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 493 $(call OptionPair,-addmods,$(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,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 555 $(call OptionPair,-addmods,$(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_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR)) 580 # TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk 581 582 # Temporary directory (special generation rules) 583 TAGLETAPI_TEMPDIR = $(DOCSTMPDIR)/taglets_temp 584 585 # The index.html, options, and packages files 586 TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/com/sun/tools/doclets/Taglet.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 # Set relative location to core api document root 596 $(TAGLETAPI_INDEX_FILE): GET2DOCSDIR=$(TAGLETAPI2COREAPI)/.. 597 598 # Run javadoc if the index file is out of date or missing 599 $(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 600 $(prep-javadoc) 601 $(RM) -r $(TAGLETAPI_TEMPDIR) 602 $(MKDIR) -p $(TAGLETAPI_TEMPDIR) 603 $(call JavadocSummary,$(TAGLETAPI_OPTIONS_FILE),$(TAGLETAPI_PACKAGES_FILE)) 604 $(JAVADOC_CMD_SMALL) -d $(TAGLETAPI_TEMPDIR) \ 605 @$(TAGLETAPI_OPTIONS_FILE) @$(TAGLETAPI_PACKAGES_FILE) 606 cp -r $(TAGLETAPI_TEMPDIR)/com $(TAGLETAPI_DOCDIR) 607 cp $(TAGLETAPI_TEMPDIR)/stylesheet.css $(TAGLETAPI_DOCDIR) 608 $(RM) -r $(TAGLETAPI_TEMPDIR) 609 610 # Create file with javadoc options in it 611 $(TAGLETAPI_OPTIONS_FILE): 612 $(prep-target) 613 @($(call COMMON_JAVADOCFLAGS) ; \ 614 $(call COMMON_JAVADOCTAGS) ; \ 615 $(call OptionOnly,-Xdoclint:all) ; \ 616 $(call OptionPair,-system,none) ; \ 617 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 618 $(call OptionPair,-addmods,$(TAGLETAPI_MODULES)) ; \ 619 $(call OptionPair,-encoding,ascii) ; \ 620 $(call OptionOnly,-nonavbar) ; \ 621 $(call OptionOnly,-noindex) ; \ 622 $(call OptionPair,-bottom,$(TAGLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 623 $(call OptionTrip,-linkoffline,$(TAGLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 624 ) >> $@ 625 626 # Create a file with the package names in it 627 $(TAGLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(TAGLETAPI_PKGS)) 628 $(prep-target) 629 @($(ECHO) "$(LANGTOOLS_TOPDIR)/src/jdk.javadoc/share/classes/$(TAGLETAPI_FILE)" ) > $@ 630 631 ############################################################# 632 # 633 # domapidocs 634 # 635 636 ALL_OTHER_TARGETS += domapidocs 637 638 DOMAPI_DOCDIR := $(JRE_API_DOCSDIR)/plugin/dom 639 DOMAPI2COREAPI := ../../$(JDKJRE2COREAPI) 640 DOMAPI_DOCTITLE := Common DOM API 641 DOMAPI_WINDOWTITLE := Common DOM API 642 DOMAPI_HEADER := <strong>Common DOM API</strong> 643 DOMAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOMAPI_FIRST_COPYRIGHT_YEAR)) 644 DOMAPI_GROUPNAME := Packages 645 DOMAPI_REGEXP := org.w3c.dom* 646 # DOMAPI_PKGS is located in NON_CORE_PKGS.gmk 647 648 # The index.html, options, and packages files 649 DOMAPI_INDEX_FILE = $(DOMAPI_DOCDIR)/index.html 650 DOMAPI_OPTIONS_FILE = $(DOCSTMPDIR)/domapi.options 651 DOMAPI_PACKAGES_FILE = $(DOCSTMPDIR)/domapi.packages 652 653 # The modules required to be documented 654 DOMAPI_MODULES = java.xml,jdk.xml.dom 655 656 domapidocs: $(DOMAPI_INDEX_FILE) 657 658 # Set relative location to core api document root 659 $(DOMAPI_INDEX_FILE): GET2DOCSDIR=$(DOMAPI2COREAPI)/.. 660 661 # Run javadoc if the index file is out of date or missing 662 $(DOMAPI_INDEX_FILE): $(DOMAPI_OPTIONS_FILE) $(DOMAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 663 $(prep-javadoc) 664 $(call JavadocSummary,$(DOMAPI_OPTIONS_FILE),$(DOMAPI_PACKAGES_FILE)) 665 $(JAVADOC_CMD_SMALL) -d $(@D) \ 666 @$(DOMAPI_OPTIONS_FILE) @$(DOMAPI_PACKAGES_FILE) 667 668 # Create file with javadoc options in it 669 $(DOMAPI_OPTIONS_FILE): 670 $(prep-target) 671 @($(call COMMON_JAVADOCFLAGS) ; \ 672 $(call COMMON_JAVADOCTAGS) ; \ 673 $(call OptionOnly,-Xdoclint:none) ; \ 674 $(call OptionPair,-system,none) ; \ 675 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 676 $(call OptionPair,-addmods,$(DOMAPI_MODULES)) ; \ 677 $(call OptionPair,-encoding,ascii) ; \ 678 $(call OptionOnly,-splitIndex) ; \ 679 $(call OptionPair,-doctitle,$(DOMAPI_DOCTITLE)) ; \ 680 $(call OptionPair,-windowtitle,$(DOMAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 681 $(call OptionPair,-header,$(DOMAPI_HEADER)$(DRAFT_HEADER)) ; \ 682 $(call OptionPair,-bottom,$(DOMAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 683 $(call OptionTrip,-group,$(DOMAPI_GROUPNAME),$(DOMAPI_REGEXP)); \ 684 $(call OptionTrip,-linkoffline,$(DOMAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 685 ) >> $@ 686 687 # Create a file with the package names in it 688 $(DOMAPI_PACKAGES_FILE): $(call PackageDependencies,$(DOMAPI_PKGS)) 689 $(prep-target) 690 $(call PackageFilter,$(DOMAPI_PKGS)) 691 692 ############################################################# 693 # 694 # jpdadocs 695 # 696 697 ALL_OTHER_TARGETS += jpdadocs 698 699 jpdadocs: jdidocs jdwpdocs jvmtidocs 700 701 ############################################################# 702 # 703 # jdidocs 704 # 705 706 ALL_OTHER_TARGETS += jdidocs 707 708 JDI_DOCDIR := $(JDK_API_DOCSDIR)/jpda/jdi 709 JDI2COREAPI := ../../$(JDKJRE2COREAPI) 710 JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface 711 JDI_WINDOWTITLE := Java Debug Interface 712 JDI_HEADER := <strong>Java Debug Interface</strong> 713 JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR)) 714 JDI_OVERVIEW := $(JDK_TOPDIR)/src/jdk.jdi/share/classes/jdi-overview.html 715 # JDI_PKGS is located in NON_CORE_PKGS.gmk 716 717 # The index.html, options, and packages files 718 JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html 719 JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options 720 JDI_PACKAGES_FILE = $(DOCSTMPDIR)/jdi.packages 721 722 # The modules required to be documented 723 JDI_MODULES = jdk.jdi 724 725 jdidocs: $(JDI_INDEX_FILE) 726 727 # Set relative location to core api document root 728 $(JDI_INDEX_FILE): GET2DOCSDIR=$(JDI2COREAPI)/.. 729 730 # Run javadoc if the index file is out of date or missing 731 $(JDI_INDEX_FILE): $(JDI_OPTIONS_FILE) $(JDI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 732 $(prep-javadoc) 733 $(call JavadocSummary,$(JDI_OPTIONS_FILE),$(JDI_PACKAGES_FILE)) 734 $(JAVADOC_CMD_SMALL) -d $(@D) \ 735 @$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE) 736 737 # Create file with javadoc options in it 738 $(JDI_OPTIONS_FILE): $(JDI_OVERVIEW) 739 $(prep-target) 740 @($(call COMMON_JAVADOCFLAGS) ; \ 741 $(call COMMON_JAVADOCTAGS) ; \ 742 $(call OptionOnly,-Xdoclint:none) ; \ 743 $(call OptionPair,-system,none) ; \ 744 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 745 $(call OptionPair,-addmods,$(JDI_MODULES)) ; \ 746 $(call OptionPair,-encoding,ascii) ; \ 747 $(call OptionPair,-overview,$(JDI_OVERVIEW)) ; \ 748 $(call OptionPair,-doctitle,$(JDI_DOCTITLE)) ; \ 749 $(call OptionPair,-windowtitle,$(JDI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 750 $(call OptionPair,-header,$(JDI_HEADER)$(DRAFT_HEADER)) ; \ 751 $(call OptionPair,-bottom,$(JDI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 752 $(call OptionTrip,-linkoffline,$(JDI2COREAPI),$(COREAPI_DOCSDIR)/); \ 753 ) >> $@ 754 755 # Create a file with the package names in it 756 $(JDI_PACKAGES_FILE): $(call PackageDependencies,$(JDI_PKGS)) 757 $(prep-target) 758 $(call PackageFilter,$(JDI_PKGS)) 759 760 ############################################################# 761 # 762 # jdwpdocs 763 # 764 765 ALL_OTHER_TARGETS += jdwpdocs 766 767 JDWP_DOCDIR = $(PLATFORM_DOCSDIR)/jpda/jdwp 768 769 jdwpdocs: $(JDWP_DOCDIR)/jdwp-protocol.html 770 $(JDWP_DOCDIR)/jdwp-protocol.html : $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html 771 $(MKDIR) -p $(@D) 772 $(RM) $@ 773 $(CP) $< $@ 774 775 ############################################################# 776 # 777 # jvmtidocs 778 # 779 780 ALL_OTHER_TARGETS += jvmtidocs 781 782 JVMTI_DOCDIR = $(PLATFORM_DOCSDIR)/jvmti 783 JVMTI_HTML = $(HOTSPOT_DIST)/docs/platform/jvmti/jvmti.html 784 785 jvmtidocs: $(JVMTI_DOCDIR)/jvmti.html 786 $(JVMTI_DOCDIR)/jvmti.html: 787 @$(prep-javadoc) 788 @if [ -f $(JVMTI_HTML) ] ; then \ 789 $(CP) $(JVMTI_HTML) $@; \ 790 else \ 791 $(ECHO) "WARNING: Generated file does not exist: $(JVMTI_HTML)"; \ 792 fi 793 794 ############################################################# 795 # 796 # jaasdocs 797 # 798 799 ALL_OTHER_TARGETS += jaasdocs 800 801 JAAS_DOCDIR := $(JRE_API_DOCSDIR)/security/jaas/spec 802 JAAS2COREAPI := ../../../$(JDKJRE2COREAPI) 803 JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service 804 JAAS_WINDOWTITLE := Java Authentication and Authorization Service 805 JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong> 806 JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR)) 807 # JAAS_PKGS is located in NON_CORE_PKGS.gmk 808 JAAS_OVERVIEW := $(JDK_TOPDIR)/src/jdk.security.auth/share/classes/jaas-overview.html 809 810 # The index.html, options, and packages files 811 JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html 812 JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options 813 JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages 814 815 # The modules required to be documented 816 JAAS_MODULES = jdk.security.auth 817 818 jaasdocs: $(JAAS_INDEX_FILE) 819 820 # Set relative location to core api document root 821 $(JAAS_INDEX_FILE): GET2DOCSDIR=$(JAAS2COREAPI)/.. 822 823 # Run javadoc if the index file is out of date or missing 824 $(JAAS_INDEX_FILE): $(JAAS_OPTIONS_FILE) $(JAAS_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 825 $(prep-javadoc) 826 $(call JavadocSummary,$(JAAS_OPTIONS_FILE),$(JAAS_PACKAGES_FILE)) 827 $(JAVADOC_CMD_SMALL) -d $(@D) \ 828 @$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE) 829 830 # Create file with javadoc options in it 831 $(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW) 832 $(prep-target) 833 @($(call COMMON_JAVADOCFLAGS) ; \ 834 $(call COMMON_JAVADOCTAGS) ; \ 835 $(call OptionOnly,-Xdoclint:none) ; \ 836 $(call OptionPair,-system,none) ; \ 837 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 838 $(call OptionPair,-addmods,$(JAAS_MODULES)) ; \ 839 $(call OptionPair,-encoding,ascii) ; \ 840 $(call OptionPair,-overview,$(JAAS_OVERVIEW)) ; \ 841 $(call OptionPair,-doctitle,$(JAAS_DOCTITLE)) ; \ 842 $(call OptionPair,-windowtitle,$(JAAS_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 843 $(call OptionPair,-header,$(JAAS_HEADER)$(DRAFT_HEADER)) ; \ 844 $(call OptionPair,-bottom,$(JAAS_BOTTOM)$(DRAFT_BOTTOM)) ; \ 845 $(call OptionTrip,-linkoffline,$(JAAS2COREAPI),$(COREAPI_DOCSDIR)/); \ 846 ) >> $@ 847 848 # Create a file with the package names in it 849 $(JAAS_PACKAGES_FILE): $(call PackageDependencies,$(JAAS_PKGS)) 850 $(prep-target) 851 $(call PackageFilter,$(JAAS_PKGS)) 852 853 ############################################################# 854 # 855 # jgssdocs 856 # 857 858 ALL_OTHER_TARGETS += jgssdocs 859 860 JGSS_DOCDIR := $(JRE_API_DOCSDIR)/security/jgss/spec 861 JGSS2COREAPI := ../../../$(JDKJRE2COREAPI) 862 JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities 863 JGSS_WINDOWTITLE := Java GSS-API Utilities 864 JGSS_HEADER := <strong>Java GSS-API Utilities</strong> 865 JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR)) 866 JGSS_OVERVIEW := $(JDK_TOPDIR)/src/java.security.jgss/share/classes/jgss-overview.html 867 # JGSS_PKGS is located in NON_CORE_PKGS.gmk 868 869 # The index.html, options, and packages files 870 JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html 871 JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options 872 JGSS_PACKAGES_FILE = $(DOCSTMPDIR)/jgss.packages 873 874 # The modules required to be documented 875 JGSS_MODULES = jdk.security.jgss 876 877 jgssdocs: $(JGSS_INDEX_FILE) 878 879 # Set relative location to core api document root 880 $(JGSS_INDEX_FILE): GET2DOCSDIR=$(JGSS2COREAPI)/.. 881 882 # Run javadoc if the index file is out of date or missing 883 $(JGSS_INDEX_FILE): $(JGSS_OPTIONS_FILE) $(JGSS_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 884 $(prep-javadoc) 885 $(call JavadocSummary,$(JGSS_OPTIONS_FILE),$(JGSS_PACKAGES_FILE)) 886 $(JAVADOC_CMD_SMALL) -d $(@D) \ 887 @$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE) 888 889 # Create file with javadoc options in it 890 $(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW) 891 $(prep-target) 892 @($(call COMMON_JAVADOCFLAGS) ; \ 893 $(call COMMON_JAVADOCTAGS) ; \ 894 $(call OptionOnly,-Xdoclint:none) ; \ 895 $(call OptionPair,-system,none) ; \ 896 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 897 $(call OptionPair,-addmods,$(JGSS_MODULES)) ; \ 898 $(call OptionPair,-encoding,ascii) ; \ 899 $(call OptionOnly,-nodeprecatedlist) ; \ 900 $(call OptionPair,-overview,$(JGSS_OVERVIEW)) ; \ 901 $(call OptionPair,-doctitle,$(JGSS_DOCTITLE)) ; \ 902 $(call OptionPair,-windowtitle,$(JGSS_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 903 $(call OptionPair,-header,$(JGSS_HEADER)$(DRAFT_HEADER)) ; \ 904 $(call OptionPair,-bottom,$(JGSS_BOTTOM)$(DRAFT_BOTTOM)) ; \ 905 $(call OptionTrip,-linkoffline,$(JGSS2COREAPI),$(COREAPI_DOCSDIR)/); \ 906 ) >> $@ 907 908 # Create a file with the package names in it 909 $(JGSS_PACKAGES_FILE): $(call PackageDependencies,$(JGSS_PKGS)) 910 $(prep-target) 911 $(call PackageFilter,$(JGSS_PKGS)) 912 913 ############################################################# 914 # 915 # smartcardiodocs 916 # 917 918 ALL_OTHER_TARGETS += smartcardiodocs 919 920 SMARTCARDIO_DOCDIR := $(JRE_API_DOCSDIR)/security/smartcardio/spec 921 SMARTCARDIO2COREAPI := ../../../$(JDKJRE2COREAPI) 922 SMARTCARDIO_DOCTITLE := Java$(TRADEMARK) Smart Card I/O 923 SMARTCARDIO_WINDOWTITLE := Java Smart Card I/O 924 SMARTCARDIO_HEADER := <strong>Java Smart Card I/O</strong> 925 SMARTCARDIO_BOTTOM := $(call CommonBottom,$(SMARTCARDIO_FIRST_COPYRIGHT_YEAR)) 926 # SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk 927 928 # The index.html, options, and packages files 929 SMARTCARDIO_INDEX_FILE = $(SMARTCARDIO_DOCDIR)/index.html 930 SMARTCARDIO_OPTIONS_FILE = $(DOCSTMPDIR)/smartcardio.options 931 SMARTCARDIO_PACKAGES_FILE = $(DOCSTMPDIR)/smartcardio.packages 932 933 # The modules required to be documented 934 SMARTCARDIO_MODULES = java.smartcardio 935 936 smartcardiodocs: $(SMARTCARDIO_INDEX_FILE) 937 938 # Set relative location to core api document root 939 $(SMARTCARDIO_INDEX_FILE): GET2DOCSDIR=$(SMARTCARDIO2COREAPI)/.. 940 941 # Run javadoc if the index file is out of date or missing 942 $(SMARTCARDIO_INDEX_FILE): $(SMARTCARDIO_OPTIONS_FILE) $(SMARTCARDIO_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 943 $(prep-javadoc) 944 $(call JavadocSummary,$(SMARTCARDIO_OPTIONS_FILE),$(SMARTCARDIO_PACKAGES_FILE)) 945 $(JAVADOC_CMD_SMALL) -d $(@D) \ 946 @$(SMARTCARDIO_OPTIONS_FILE) @$(SMARTCARDIO_PACKAGES_FILE) 947 948 # Create file with javadoc options in it 949 $(SMARTCARDIO_OPTIONS_FILE): 950 $(prep-target) 951 @($(call COMMON_JAVADOCFLAGS) ; \ 952 $(call COMMON_JAVADOCTAGS) ; \ 953 $(call OptionOnly,-Xdoclint:none) ; \ 954 $(call OptionPair,-system,none) ; \ 955 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 956 $(call OptionPair,-addmods,$(SMARTCARDIO_MODULES)) ; \ 957 $(call OptionPair,-encoding,ascii) ; \ 958 $(call OptionOnly,-nodeprecatedlist) ; \ 959 $(call OptionPair,-doctitle,$(SMARTCARDIO_DOCTITLE)) ; \ 960 $(call OptionPair,-windowtitle,$(SMARTCARDIO_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 961 $(call OptionPair,-header,$(SMARTCARDIO_HEADER)$(DRAFT_HEADER)); \ 962 $(call OptionPair,-bottom,$(SMARTCARDIO_BOTTOM)$(DRAFT_BOTTOM)); \ 963 $(call OptionTrip,-linkoffline,$(SMARTCARDIO2COREAPI),$(COREAPI_DOCSDIR)/); \ 964 ) >> $@ 965 966 # Create a file with the package names in it 967 $(SMARTCARDIO_PACKAGES_FILE): $(call PackageDependencies,$(SMARTCARDIO_PKGS)) 968 $(prep-target) 969 $(call PackageFilter,$(SMARTCARDIO_PKGS)) 970 971 ############################################################# 972 # 973 # httpserverdocs 974 # 975 976 ALL_OTHER_TARGETS += httpserverdocs 977 978 HTTPSERVER_DOCDIR := $(JRE_API_DOCSDIR)/net/httpserver/spec 979 HTTPSERVER2COREAPI := ../../../$(JDKJRE2COREAPI) 980 HTTPSERVER_DOCTITLE := Java$(TRADEMARK) HTTP Server 981 HTTPSERVER_WINDOWTITLE := Java HTTP Server 982 HTTPSERVER_HEADER := <strong>Java HTTP Server</strong> 983 HTTPSERVER_BOTTOM := $(call CommonBottom,$(HTTPSERVER_FIRST_COPYRIGHT_YEAR)) 984 # HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk 985 986 HTTPSERVER_INDEX_HTML = $(HTTPSERVER_DOCDIR)/index.html 987 HTTPSERVER_OPTIONS_FILE = $(DOCSTMPDIR)/httpserver.options 988 HTTPSERVER_PACKAGES_FILE = $(DOCSTMPDIR)/httpserver.packages 989 990 # The modules required to be documented 991 HTTPSERVER_MODULES = jdk.httpserver 992 993 httpserverdocs: $(HTTPSERVER_INDEX_HTML) 994 995 # Set relative location to core api document root 996 $(HTTPSERVER_INDEX_HTML): GET2DOCSDIR=$(HTTPSERVER2COREAPI)/.. 997 998 # Run javadoc if the index file is out of date or missing 999 $(HTTPSERVER_INDEX_HTML): $(HTTPSERVER_OPTIONS_FILE) $(HTTPSERVER_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1000 $(prep-javadoc) 1001 $(call JavadocSummary,$(HTTPSERVER_OPTIONS_FILE),$(HTTPSERVER_PACKAGES_FILE)) 1002 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1003 @$(HTTPSERVER_OPTIONS_FILE) @$(HTTPSERVER_PACKAGES_FILE) 1004 1005 # Create file with javadoc options in it 1006 $(HTTPSERVER_OPTIONS_FILE): 1007 $(prep-target) 1008 @($(call COMMON_JAVADOCFLAGS) ; \ 1009 $(call COMMON_JAVADOCTAGS) ; \ 1010 $(call OptionOnly,-Xdoclint:none) ; \ 1011 $(call OptionPair,-system,none) ; \ 1012 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1013 $(call OptionPair,-addmods,$(HTTPSERVER_MODULES)) ; \ 1014 $(call OptionPair,-encoding,ascii) ; \ 1015 $(call OptionOnly,-nodeprecatedlist) ; \ 1016 $(call OptionPair,-doctitle,$(HTTPSERVER_DOCTITLE)) ; \ 1017 $(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1018 $(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \ 1019 $(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \ 1020 $(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \ 1021 ) >> $@ 1022 1023 # Create a file with the package names in it 1024 $(HTTPSERVER_PACKAGES_FILE): $(call PackageDependencies,$(HTTPSERVER_PKGS)) 1025 $(prep-target) 1026 $(call PackageFilter,$(HTTPSERVER_PKGS)) 1027 1028 ############################################################# 1029 # 1030 # mgmtdocs 1031 # 1032 1033 ALL_OTHER_TARGETS += mgmtdocs 1034 1035 MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension 1036 MGMT2COREAPI := ../../$(JDKJRE2COREAPI) 1037 MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform 1038 MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform 1039 MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong> 1040 MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR)) 1041 MGMT_OVERVIEW := $(JDK_TOPDIR)/src/java.management/share/classes/mgmt-overview.html 1042 # MGMT_PKGS is located in NON_CORE_PKGS.gmk 1043 1044 # The index.html, options, and packages files 1045 MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html 1046 MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options 1047 MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages 1048 1049 # The modules required to be documented 1050 MGMT_MODULES = jdk.management 1051 1052 mgmtdocs: $(MGMT_INDEX_FILE) 1053 1054 # Set relative location to core api document root 1055 $(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/.. 1056 1057 # Run javadoc if the index file is out of date or missing 1058 $(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1059 $(prep-javadoc) 1060 $(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE)) 1061 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1062 @$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE) 1063 1064 # Create file with javadoc options in it 1065 $(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW) 1066 $(prep-target) 1067 @($(call COMMON_JAVADOCFLAGS) ; \ 1068 $(call COMMON_JAVADOCTAGS) ; \ 1069 $(call OptionOnly,-Xdoclint:none) ; \ 1070 $(call OptionPair,-system,none) ; \ 1071 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1072 $(call OptionPair,-addmods,$(MGMT_MODULES)) ; \ 1073 $(call OptionPair,-encoding,ascii) ; \ 1074 $(call OptionOnly,-nodeprecatedlist) ; \ 1075 $(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \ 1076 $(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \ 1077 $(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1078 $(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \ 1079 $(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1080 $(call OptionTrip,-linkoffline,$(MGMT2COREAPI),$(COREAPI_DOCSDIR)/); \ 1081 ) >> $@ 1082 1083 # Create a file with the package names in it 1084 $(MGMT_PACKAGES_FILE): $(call PackageDependencies,$(MGMT_PKGS)) 1085 $(prep-target) 1086 $(call PackageFilter,$(MGMT_PKGS)) 1087 1088 ############################################################# 1089 # 1090 # attachdocs 1091 # 1092 1093 ALL_OTHER_TARGETS += attachdocs 1094 1095 ATTACH_DOCDIR := $(JDK_API_DOCSDIR)/attach/spec 1096 ATTACH2COREAPI := ../../$(JDKJRE2COREAPI) 1097 ATTACH_DOCTITLE := Attach API 1098 ATTACH_WINDOWTITLE := Attach API 1099 ATTACH_HEADER := <strong>Attach API</strong> 1100 ATTACH_BOTTOM := $(call CommonBottom,$(ATTACH_FIRST_COPYRIGHT_YEAR)) 1101 # ATTACH_PKGS is located in NON_CORE_PKGS.gmk 1102 1103 ATTACH_INDEX_HTML = $(ATTACH_DOCDIR)/index.html 1104 ATTACH_OPTIONS_FILE = $(DOCSTMPDIR)/attach.options 1105 ATTACH_PACKAGES_FILE = $(DOCSTMPDIR)/attach.packages 1106 1107 # The modules required to be documented 1108 ATTACH_MODULES = jdk.attach 1109 1110 attachdocs: $(ATTACH_INDEX_HTML) 1111 1112 # Set relative location to core api document root 1113 $(ATTACH_INDEX_HTML): GET2DOCSDIR=$(ATTACH2COREAPI)/.. 1114 1115 # Run javadoc if the index file is out of date or missing 1116 $(ATTACH_INDEX_HTML): $(ATTACH_OPTIONS_FILE) $(ATTACH_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1117 $(prep-javadoc) 1118 $(call JavadocSummary,$(ATTACH_OPTIONS_FILE),$(ATTACH_PACKAGES_FILE)) 1119 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1120 @$(ATTACH_OPTIONS_FILE) @$(ATTACH_PACKAGES_FILE) 1121 1122 # Create file with javadoc options in it 1123 $(ATTACH_OPTIONS_FILE): 1124 $(prep-target) 1125 @($(call COMMON_JAVADOCFLAGS) ; \ 1126 $(call COMMON_JAVADOCTAGS) ; \ 1127 $(call OptionOnly,-Xdoclint:none) ; \ 1128 $(call OptionPair,-system,none) ; \ 1129 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1130 $(call OptionPair,-addmods,$(ATTACH_MODULES)) ; \ 1131 $(call OptionPair,-encoding,ascii) ; \ 1132 $(call OptionOnly,-nodeprecatedlist) ; \ 1133 $(call OptionPair,-doctitle,$(ATTACH_DOCTITLE)) ; \ 1134 $(call OptionPair,-windowtitle,$(ATTACH_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1135 $(call OptionPair,-header,$(ATTACH_HEADER)$(DRAFT_HEADER)) ; \ 1136 $(call OptionPair,-bottom,$(ATTACH_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1137 $(call OptionTrip,-linkoffline,$(ATTACH2COREAPI),$(COREAPI_DOCSDIR)/); \ 1138 ) >> $@ 1139 1140 # Create a file with the package names in it 1141 $(ATTACH_PACKAGES_FILE): $(call PackageDependencies,$(ATTACH_PKGS)) 1142 $(prep-target) 1143 $(call PackageFilter,$(ATTACH_PKGS)) 1144 1145 ############################################################# 1146 # 1147 # jconsoledocs 1148 # 1149 1150 ALL_OTHER_TARGETS += jconsoledocs 1151 1152 JCONSOLE_DOCDIR := $(JDK_API_DOCSDIR)/jconsole/spec 1153 JCONSOLE2COREAPI := ../../$(JDKJRE2COREAPI) 1154 JCONSOLE_DOCTITLE := JConsole API 1155 JCONSOLE_WINDOWTITLE := JConsole API 1156 JCONSOLE_HEADER := <strong>JConsole API</strong> 1157 JCONSOLE_BOTTOM := $(call CommonBottom,$(JCONSOLE_FIRST_COPYRIGHT_YEAR)) 1158 # JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk 1159 1160 JCONSOLE_INDEX_HTML = $(JCONSOLE_DOCDIR)/index.html 1161 JCONSOLE_OPTIONS_FILE = $(DOCSTMPDIR)/jconsole.options 1162 JCONSOLE_PACKAGES_FILE = $(DOCSTMPDIR)/jconsole.packages 1163 1164 # The modules required to be documented 1165 JCONSOLE_MODULES = jdk.jconsole 1166 1167 jconsoledocs: $(JCONSOLE_INDEX_HTML) 1168 1169 # Set relative location to core api document root 1170 $(JCONSOLE_INDEX_HTML): GET2DOCSDIR=$(JCONSOLE2COREAPI)/.. 1171 1172 # Run javadoc if the index file is out of date or missing 1173 $(JCONSOLE_INDEX_HTML): $(JCONSOLE_OPTIONS_FILE) $(JCONSOLE_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1174 $(prep-javadoc) 1175 $(call JavadocSummary,$(JCONSOLE_OPTIONS_FILE),$(JCONSOLE_PACKAGES_FILE)) 1176 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1177 @$(JCONSOLE_OPTIONS_FILE) @$(JCONSOLE_PACKAGES_FILE) 1178 1179 # Create file with javadoc options in it 1180 $(JCONSOLE_OPTIONS_FILE): 1181 $(prep-target) 1182 @($(call COMMON_JAVADOCFLAGS) ; \ 1183 $(call COMMON_JAVADOCTAGS) ; \ 1184 $(call OptionOnly,-Xdoclint:none) ; \ 1185 $(call OptionPair,-system,none) ; \ 1186 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1187 $(call OptionPair,-addmods,$(JCONSOLE_MODULES)) ; \ 1188 $(call OptionPair,-encoding,ascii) ; \ 1189 $(call OptionOnly,-nodeprecatedlist) ; \ 1190 $(call OptionPair,-doctitle,$(JCONSOLE_DOCTITLE)) ; \ 1191 $(call OptionPair,-windowtitle,$(JCONSOLE_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1192 $(call OptionPair,-header,$(JCONSOLE_HEADER)$(DRAFT_HEADER)) ; \ 1193 $(call OptionPair,-bottom,$(JCONSOLE_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1194 $(call OptionTrip,-linkoffline,$(JCONSOLE2COREAPI),$(COREAPI_DOCSDIR)/); \ 1195 ) >> $@ 1196 1197 # Create a file with the package names in it 1198 $(JCONSOLE_PACKAGES_FILE): $(call PackageDependencies,$(JCONSOLE_PKGS)) 1199 $(prep-target) 1200 $(call PackageFilter,$(JCONSOLE_PKGS)) 1201 1202 ############################################################# 1203 # 1204 # jshellapidocs 1205 # 1206 1207 ALL_OTHER_TARGETS += jshellapidocs 1208 1209 JSHELLAPI_DOCDIR := $(JDK_API_DOCSDIR)/jshell 1210 JSHELLAPI2COREAPI := ../../$(JDKJRE2COREAPI) 1211 JSHELLAPI_DOCTITLE := JShell API 1212 JSHELLAPI_WINDOWTITLE := JShell API 1213 JSHELLAPI_HEADER := <strong>JSHELL API</strong> 1214 JSHELLAPI_BOTTOM := $(call CommonBottom,$(JSHELLAPI_FIRST_COPYRIGHT_YEAR)) 1215 JSHELLAPI_GROUPNAME := Packages 1216 JSHELLAPI_REGEXP := jdk.jshell.* 1217 # JSHELLAPI_PKGS is located in NON_CORE_PKGS.gmk 1218 1219 JSHELLAPI_INDEX_HTML = $(JSHELLAPI_DOCDIR)/index.html 1220 JSHELLAPI_OPTIONS_FILE = $(DOCSTMPDIR)/jshellapi.options 1221 JSHELLAPI_PACKAGES_FILE = $(DOCSTMPDIR)/jshellapi.packages 1222 1223 # The modules required to be documented 1224 JSHELLAPI_MODULES = jdk.jshell 1225 1226 jshellapidocs: $(JSHELLAPI_INDEX_HTML) 1227 1228 # Set relative location to core api document root 1229 $(JSHELLAPI_INDEX_HTML): GET2DOCSDIR=$(JSHELLAPI2COREAPI)/.. 1230 1231 # Run javadoc if the index file is out of date or missing 1232 $(JSHELLAPI_INDEX_HTML): $(JSHELLAPI_OPTIONS_FILE) $(JSHELLAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1233 $(prep-javadoc) 1234 $(call JavadocSummary,$(JSHELLAPI_OPTIONS_FILE),$(JSHELLAPI_PACKAGES_FILE)) 1235 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1236 @$(JSHELLAPI_OPTIONS_FILE) @$(JSHELLAPI_PACKAGES_FILE) 1237 1238 # Create file with javadoc options in it 1239 $(JSHELLAPI_OPTIONS_FILE): 1240 $(prep-target) 1241 @($(call COMMON_JAVADOCFLAGS) ; \ 1242 $(call COMMON_JAVADOCTAGS) ; \ 1243 $(call OptionOnly,-Xdoclint:all) ; \ 1244 $(call OptionPair,-system,none) ; \ 1245 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1246 $(call OptionPair,-addmods,$(JSHELLAPI_MODULES)) ; \ 1247 $(call OptionPair,-encoding,ascii) ; \ 1248 $(call OptionPair,-doctitle,$(JSHELLAPI_DOCTITLE)) ; \ 1249 $(call OptionPair,-windowtitle,$(JSHELLAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1250 $(call OptionPair,-header,$(JSHELLAPI_HEADER)$(DRAFT_HEADER)) ; \ 1251 $(call OptionPair,-bottom,$(JSHELLAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1252 $(call OptionTrip,-group,$(JSHELLAPI_GROUPNAME),$(JSHELLAPI_REGEXP)); \ 1253 $(call OptionTrip,-linkoffline,$(JSHELLAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1254 ) >> $@ 1255 1256 # Create a file with the package names in it 1257 $(JSHELLAPI_PACKAGES_FILE): $(call PackageDependencies,$(JSHELLAPI_PKGS)) 1258 $(prep-target) 1259 $(call PackageFilter,$(JSHELLAPI_PKGS)) 1260 1261 ############################################################# 1262 # 1263 # treeapidocs 1264 # 1265 1266 ALL_OTHER_TARGETS += treeapidocs 1267 1268 TREEAPI_DOCDIR := $(JDK_API_DOCSDIR)/javac/tree 1269 TREEAPI2COREAPI := ../../$(JDKJRE2COREAPI) 1270 TREEAPI_DOCTITLE := Compiler Tree API 1271 TREEAPI_WINDOWTITLE := Compiler Tree API 1272 TREEAPI_HEADER := <strong>Compiler Tree API</strong> 1273 TREEAPI_BOTTOM := $(call CommonBottom,$(TREEAPI_FIRST_COPYRIGHT_YEAR)) 1274 TREEAPI_GROUPNAME := Packages 1275 TREEAPI_REGEXP := com.sun.source.* 1276 # TREEAPI_PKGS is located in NON_CORE_PKGS.gmk 1277 1278 TREEAPI_INDEX_HTML = $(TREEAPI_DOCDIR)/index.html 1279 TREEAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options 1280 TREEAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages 1281 1282 # The modules required to be documented 1283 TREEAPI_MODULES = jdk.compiler 1284 1285 treeapidocs: $(TREEAPI_INDEX_HTML) 1286 1287 # Set relative location to core api document root 1288 $(TREEAPI_INDEX_HTML): GET2DOCSDIR=$(TREEAPI2COREAPI)/.. 1289 1290 # Run javadoc if the index file is out of date or missing 1291 $(TREEAPI_INDEX_HTML): $(TREEAPI_OPTIONS_FILE) $(TREEAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1292 $(prep-javadoc) 1293 $(call JavadocSummary,$(TREEAPI_OPTIONS_FILE),$(TREEAPI_PACKAGES_FILE)) 1294 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1295 @$(TREEAPI_OPTIONS_FILE) @$(TREEAPI_PACKAGES_FILE) 1296 1297 # Create file with javadoc options in it 1298 $(TREEAPI_OPTIONS_FILE): 1299 $(prep-target) 1300 @($(call COMMON_JAVADOCFLAGS) ; \ 1301 $(call COMMON_JAVADOCTAGS) ; \ 1302 $(call OptionOnly,-Xdoclint:all) ; \ 1303 $(call OptionPair,-system,none) ; \ 1304 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1305 $(call OptionPair,-addmods,$(TREEAPI_MODULES)) ; \ 1306 $(call OptionPair,-encoding,ascii) ; \ 1307 $(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \ 1308 $(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1309 $(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \ 1310 $(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1311 $(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \ 1312 $(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1313 ) >> $@ 1314 1315 # Create a file with the package names in it 1316 $(TREEAPI_PACKAGES_FILE): $(call PackageDependencies,$(TREEAPI_PKGS)) 1317 $(prep-target) 1318 $(call PackageFilter,$(TREEAPI_PKGS)) 1319 1320 ############################################################# 1321 # 1322 # nashornapidocs 1323 # 1324 1325 ALL_OTHER_TARGETS += nashornapidocs 1326 1327 NASHORNAPI_DOCDIR := $(JDK_API_DOCSDIR)/nashorn 1328 NASHORNAPI2COREAPI := ../$(JDKJRE2COREAPI) 1329 NASHORNAPI_DOCTITLE := Nashorn API 1330 NASHORNAPI_WINDOWTITLE := Nashorn API 1331 NASHORNAPI_HEADER := <strong>Nashorn API</strong> 1332 NASHORNAPI_BOTTOM := $(call CommonBottom,$(NASHORNAPI_FIRST_COPYRIGHT_YEAR)) 1333 NASHORNAPI_GROUPNAME := Packages 1334 NASHORNAPI_REGEXP := jdk.nashorn.api.* 1335 # NASHORNAPI_PKGS is located in NON_CORE_PKGS.gmk 1336 1337 NASHORNAPI_INDEX_HTML = $(NASHORNAPI_DOCDIR)/index.html 1338 NASHORNAPI_OPTIONS_FILE = $(DOCSTMPDIR)/nashornapi.options 1339 NASHORNAPI_PACKAGES_FILE = $(DOCSTMPDIR)/nashornapi.packages 1340 1341 # The modules required to be documented 1342 NASHORNAPI_MODULES = jdk.scripting.nashorn 1343 1344 nashornapidocs: $(NASHORNAPI_INDEX_HTML) 1345 1346 # Set relative location to core api document root 1347 $(NASHORNAPI_INDEX_HTML): GET2DOCSDIR=$(NASHORNAPI2COREAPI)/.. 1348 1349 # Run javadoc if the index file is out of date or missing 1350 $(NASHORNAPI_INDEX_HTML): $(NASHORNAPI_OPTIONS_FILE) $(NASHORNAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1351 $(prep-javadoc) 1352 $(call JavadocSummary,$(NASHORNAPI_OPTIONS_FILE),$(NASHORNAPI_PACKAGES_FILE)) 1353 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1354 @$(NASHORNAPI_OPTIONS_FILE) @$(NASHORNAPI_PACKAGES_FILE) 1355 1356 # Create file with javadoc options in it 1357 $(NASHORNAPI_OPTIONS_FILE): 1358 $(prep-target) 1359 @($(call COMMON_JAVADOCFLAGS) ; \ 1360 $(call COMMON_JAVADOCTAGS) ; \ 1361 $(call OptionOnly,-Xdoclint:all) ; \ 1362 $(call OptionPair,-system,none) ; \ 1363 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1364 $(call OptionPair,-addmods,$(NASHORNAPI_MODULES)) ; \ 1365 $(call OptionPair,-encoding,ascii) ; \ 1366 $(call OptionPair,-doctitle,$(NASHORNAPI_DOCTITLE)) ; \ 1367 $(call OptionPair,-windowtitle,$(NASHORNAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1368 $(call OptionPair,-header,$(NASHORNAPI_HEADER)$(DRAFT_HEADER)) ; \ 1369 $(call OptionPair,-bottom,$(NASHORNAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1370 $(call OptionTrip,-group,$(NASHORNAPI_GROUPNAME),$(NASHORNAPI_REGEXP)); \ 1371 $(call OptionTrip,-linkoffline,$(NASHORNAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1372 ) >> $@ 1373 1374 # Create a file with the package names in it 1375 $(NASHORNAPI_PACKAGES_FILE): $(call PackageDependencies,$(NASHORNAPI_PKGS)) 1376 $(prep-target) 1377 $(call PackageFilter,$(NASHORNAPI_PKGS)) 1378 1379 ############################################################# 1380 # 1381 # dynalinkapidocs 1382 # 1383 1384 ALL_OTHER_TARGETS += dynalinkapidocs 1385 1386 DYNALINKAPI_DOCDIR := $(JDK_API_DOCSDIR)/dynalink 1387 DYNALINKAPI2COREAPI := ../$(JDKJRE2COREAPI) 1388 DYNALINKAPI_DOCTITLE := Dynalink API 1389 DYNALINKAPI_WINDOWTITLE := Dynalink API 1390 DYNALINKAPI_HEADER := <strong>Dynalink API</strong> 1391 DYNALINKAPI_BOTTOM := $(call CommonBottom,$(DYNALINKAPI_FIRST_COPYRIGHT_YEAR)) 1392 DYNALINKAPI_GROUPNAME := Packages 1393 DYNALINKAPI_REGEXP := jdk.dynalink.* 1394 # DYNALINKAPI_PKGS is located in NON_CORE_PKGS.gmk 1395 1396 DYNALINKAPI_INDEX_HTML = $(DYNALINKAPI_DOCDIR)/index.html 1397 DYNALINKAPI_OPTIONS_FILE = $(DOCSTMPDIR)/dynalinkapi.options 1398 DYNALINKAPI_PACKAGES_FILE = $(DOCSTMPDIR)/dynalinkapi.packages 1399 1400 # The modules required to be documented 1401 DYNALINKAPI_MODULES = jdk.dynalink 1402 1403 dynalinkapidocs: $(DYNALINKAPI_INDEX_HTML) 1404 1405 # Set relative location to core api document root 1406 $(DYNALINKAPI_INDEX_HTML): GET2DOCSDIR=$(DYNALINKAPI2COREAPI)/.. 1407 1408 # Run javadoc if the index file is out of date or missing 1409 $(DYNALINKAPI_INDEX_HTML): $(DYNALINKAPI_OPTIONS_FILE) $(DYNALINKAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1410 $(prep-javadoc) 1411 $(call JavadocSummary,$(DYNALINKAPI_OPTIONS_FILE),$(DYNALINKAPI_PACKAGES_FILE)) 1412 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1413 @$(DYNALINKAPI_OPTIONS_FILE) @$(DYNALINKAPI_PACKAGES_FILE) 1414 1415 # Create file with javadoc options in it 1416 $(DYNALINKAPI_OPTIONS_FILE): 1417 $(prep-target) 1418 @($(call COMMON_JAVADOCFLAGS) ; \ 1419 $(call COMMON_JAVADOCTAGS) ; \ 1420 $(call OptionOnly,-Xdoclint:all) ; \ 1421 $(call OptionPair,-system,none) ; \ 1422 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1423 $(call OptionPair,-addmods,$(DYNALINKAPI_MODULES)) ; \ 1424 $(call OptionPair,-encoding,ascii) ; \ 1425 $(call OptionPair,-doctitle,$(DYNALINKAPI_DOCTITLE)) ; \ 1426 $(call OptionPair,-windowtitle,$(DYNALINKAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1427 $(call OptionPair,-header,$(DYNALINKAPI_HEADER)$(DRAFT_HEADER)) ; \ 1428 $(call OptionPair,-bottom,$(DYNALINKAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1429 $(call OptionTrip,-linkoffline,$(DYNALINKAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1430 ) >> $@ 1431 1432 # Create a file with the package names in it 1433 $(DYNALINKAPI_PACKAGES_FILE): $(call PackageDependencies,$(DYNALINKAPI_PKGS)) 1434 $(prep-target) 1435 $(call PackageFilter,$(DYNALINKAPI_PKGS)) 1436 1437 ############################################################# 1438 # 1439 # sctpdocs 1440 # 1441 1442 ALL_OTHER_TARGETS += sctpdocs 1443 1444 SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec 1445 SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI) 1446 SCTPAPI_DOCTITLE := SCTP API 1447 SCTPAPI_WINDOWTITLE := SCTP API 1448 SCTPAPI_HEADER := <strong>SCTP API</strong> 1449 SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR)) 1450 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk 1451 1452 SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html 1453 SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options 1454 SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages 1455 1456 # The modules required to be documented 1457 SCTPAPI_MODULES = jdk.sctp 1458 1459 sctpdocs: $(SCTPAPI_INDEX_HTML) 1460 1461 # Set relative location to core api document root 1462 $(SCTPAPI_INDEX_HTML): GET2DOCSDIR=$(SCTPAPI2COREAPI)/.. 1463 1464 # Run javadoc if the index file is out of date or missing 1465 $(SCTPAPI_INDEX_HTML): $(SCTPAPI_OPTIONS_FILE) $(SCTPAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1466 $(prep-javadoc) 1467 $(call JavadocSummary,$(SCTPAPI_OPTIONS_FILE),$(SCTPAPI_PACKAGES_FILE)) 1468 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1469 @$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE) 1470 1471 # Create file with javadoc options in it 1472 $(SCTPAPI_OPTIONS_FILE): 1473 $(prep-target) 1474 @($(call COMMON_JAVADOCFLAGS) ; \ 1475 $(call COMMON_JAVADOCTAGS) ; \ 1476 $(call OptionOnly,-Xdoclint:none) ; \ 1477 $(call OptionPair,-system,none) ; \ 1478 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1479 $(call OptionPair,-addmods,$(SCTPAPI_MODULES)) ; \ 1480 $(call OptionPair,-encoding,ascii) ; \ 1481 $(call OptionOnly,-nodeprecatedlist) ; \ 1482 $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \ 1483 $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1484 $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \ 1485 $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1486 $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1487 ) >> $@ 1488 1489 # Create a file with the package names in it 1490 $(SCTPAPI_PACKAGES_FILE): $(call PackageDependencies,$(SCTPAPI_PKGS)) 1491 $(prep-target) 1492 $(call PackageFilter,$(SCTPAPI_PKGS)) 1493 1494 ############################################################# 1495 # 1496 # jaccessdocs - Java Accessibility Utilities 1497 # 1498 1499 ALL_OTHER_TARGETS += jaccessdocs 1500 1501 JACCESSAPI_DOCDIR := $(JRE_API_DOCSDIR)/accessibility/jaccess/spec 1502 JACCESSAPI2COREAPI := ../../../$(JDKJRE2COREAPI) 1503 JACCESSAPI_DOCTITLE := JACCESS API 1504 JACCESSAPI_WINDOWTITLE := JACCESS API 1505 JACCESSAPI_HEADER := <strong>JACCESS API</strong> 1506 JACCESSAPI_BOTTOM := $(call CommonBottom,$(JACCESSAPI_FIRST_COPYRIGHT_YEAR)) 1507 # JACCESSAPI_PKGS is located in NON_CORE_PKGS.gmk 1508 1509 JACCESSAPI_INDEX_HTML = $(JACCESSAPI_DOCDIR)/index.html 1510 JACCESSAPI_OPTIONS_FILE = $(DOCSTMPDIR)/jaccess.options 1511 JACCESSAPI_PACKAGES_FILE = $(DOCSTMPDIR)/jaccess.packages 1512 1513 # The modules required to be documented 1514 JACCESSAPI_MODULES = jdk.accessibility 1515 1516 jaccessdocs: $(JACCESSAPI_INDEX_HTML) 1517 1518 # Set relative location to core api document root 1519 $(JACCESSAPI_INDEX_HTML): GET2DOCSDIR=$(JACCESSAPI2COREAPI)/.. 1520 1521 # Run javadoc if the index file is out of date or missing 1522 $(JACCESSAPI_INDEX_HTML): $(JACCESSAPI_OPTIONS_FILE) $(JACCESSAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1523 $(prep-javadoc) 1524 $(call JavadocSummary,$(JACCESSAPI_OPTIONS_FILE),$(JACCESSAPI_PACKAGES_FILE)) 1525 $(JAVADOC_CMD) -d $(@D) \ 1526 @$(JACCESSAPI_OPTIONS_FILE) @$(JACCESSAPI_PACKAGES_FILE) 1527 1528 # Create file with javadoc options in it 1529 $(JACCESSAPI_OPTIONS_FILE): 1530 $(prep-target) 1531 @($(call COMMON_JAVADOCFLAGS) ; \ 1532 $(call COMMON_JAVADOCTAGS) ; \ 1533 $(call OptionOnly,-Xdoclint:all) ; \ 1534 $(call OptionPair,-system,none) ; \ 1535 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1536 $(call OptionPair,-addmods,$(JACCESSAPI_MODULES)) ; \ 1537 $(call OptionPair,-encoding,ascii) ; \ 1538 $(call OptionOnly,-nodeprecatedlist) ; \ 1539 $(call OptionPair,-doctitle,$(JACCESSAPI_DOCTITLE)) ; \ 1540 $(call OptionPair,-windowtitle,$(JACCESSAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1541 $(call OptionPair,-header,$(JACCESSAPI_HEADER)$(DRAFT_HEADER)) ; \ 1542 $(call OptionPair,-bottom,$(JACCESSAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ 1543 $(call OptionTrip,-linkoffline,$(JACCESSAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ 1544 ) >> $@ 1545 1546 # Create a file with the package names in it 1547 $(JACCESSAPI_PACKAGES_FILE): $(call PackageDependencies,$(JACCESSAPI_PKGS)) 1548 $(prep-target) 1549 $(call PackageFilter,$(JACCESSAPI_PKGS)) 1550 1551 ############################################################# 1552 # 1553 # jdk.net docs 1554 # 1555 1556 ALL_OTHER_TARGETS += jdknetdocs 1557 1558 JDKNET_DOCDIR := $(JRE_API_DOCSDIR)/net/socketoptions/spec 1559 JDKNET2COREAPI := ../../../$(JDKJRE2COREAPI) 1560 JDKNET_DOCTITLE := jdk.net API 1561 JDKNET_WINDOWTITLE := jdk.net API 1562 JDKNET_HEADER := <strong>jdk.net API</strong> 1563 JDKNET_BOTTOM := $(call CommonBottom,$(JDKNET_FIRST_COPYRIGHT_YEAR)) 1564 JDKNET_PKGS := jdk.net 1565 1566 JDKNET_INDEX_HTML = $(JDKNET_DOCDIR)/index.html 1567 JDKNET_OPTIONS_FILE = $(DOCSTMPDIR)/jdknet.options 1568 JDKNET_PACKAGES_FILE = $(DOCSTMPDIR)/jdknet.packages 1569 1570 # The modules required to be documented 1571 JDKNET_MODULES = jdk.net 1572 1573 jdknetdocs: $(JDKNET_INDEX_HTML) 1574 1575 # Set relative location to core api document root 1576 $(JDKNET_INDEX_HTML): GET2DOCSDIR=$(JDKNET2COREAPI)/.. 1577 1578 # Run javadoc if the index file is out of date or missing 1579 $(JDKNET_INDEX_HTML): $(JDKNET_OPTIONS_FILE) $(JDKNET_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1580 $(prep-javadoc) 1581 $(call JavadocSummary,$(JDKNET_OPTIONS_FILE),$(JDKNET_PACKAGES_FILE)) 1582 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1583 @$(JDKNET_OPTIONS_FILE) @$(JDKNET_PACKAGES_FILE) 1584 1585 # Create file with javadoc options in it 1586 $(JDKNET_OPTIONS_FILE): 1587 $(prep-target) 1588 @($(call COMMON_JAVADOCFLAGS) ; \ 1589 $(call COMMON_JAVADOCTAGS) ; \ 1590 $(call OptionOnly,-Xdoclint:none) ; \ 1591 $(call OptionPair,-system,none) ; \ 1592 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1593 $(call OptionPair,-addmods,$(JDKNET_MODULES)) ; \ 1594 $(call OptionPair,-encoding,ascii) ; \ 1595 $(call OptionOnly,-nodeprecatedlist) ; \ 1596 $(call OptionPair,-doctitle,$(JDKNET_DOCTITLE)) ; \ 1597 $(call OptionPair,-windowtitle,$(JDKNET_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1598 $(call OptionPair,-header,$(JDKNET_HEADER)$(DRAFT_HEADER)); \ 1599 $(call OptionPair,-bottom,$(JDKNET_BOTTOM)$(DRAFT_BOTTOM)); \ 1600 $(call OptionTrip,-linkoffline,$(JDKNET2COREAPI),$(COREAPI_DOCSDIR)/); \ 1601 ) >> $@ 1602 1603 # Create a file with the package names in it 1604 $(JDKNET_PACKAGES_FILE): $(call PackageDependencies,$(JDKNET_PKGS)) 1605 $(prep-target) 1606 $(call PackageFilter,$(JDKNET_PKGS)) 1607 1608 ############################################################# 1609 # 1610 # jlink plugin API docs 1611 # 1612 # TODO: Need to decide when the plugin API is ready to publish as experimental API. 1613 # This target is temporarily added for internal use for now. 1614 # 1615 1616 ALL_OTHER_TARGETS += jlinkdocs 1617 1618 JLINK_PLUGIN_FIRST_COPYRIGHT_YEAR = 2015 1619 JLINK_PLUGIN_DOCDIR := $(JDK_API_DOCSDIR)/jlink 1620 JLINK_PLUGIN2COREAPI := ../$(JDKJRE2COREAPI) 1621 JLINK_PLUGIN_DOCTITLE := JLink Plugin API - EXPERIMENTAL 1622 JLINK_PLUGIN_WINDOWTITLE := JLink Plugin API - EXPERIMENTAL 1623 JLINK_PLUGIN_HEADER := <strong>JLink Plugin API - EXPERIMENTAL</strong> 1624 JLINK_PLUGIN_BOTTOM := $(call CommonBottom,$(JLINK_PLUGIN_FIRST_COPYRIGHT_YEAR)) 1625 JLINK_PLUGIN_PKGS = jdk.tools.jlink.plugin 1626 1627 JLINK_PLUGIN_INDEX_HTML = $(JLINK_PLUGIN_DOCDIR)/index.html 1628 JLINK_PLUGIN_OPTIONS_FILE = $(DOCSTMPDIR)/jlinkplugins.options 1629 JLINK_PLUGIN_PACKAGES_FILE = $(DOCSTMPDIR)/jlinkplugins.packages 1630 1631 # The modules required to be documented 1632 JLINK_PLUGIN_MODULES = jdk.jlink 1633 1634 jlinkdocs: $(JLINK_PLUGIN_INDEX_HTML) 1635 1636 # Set relative location to core api document root 1637 $(JLINK_PLUGIN_INDEX_HTML): GET2DOCSDIR=$(JLINK_PLUGIN2COREAPI)/.. 1638 1639 # Run javadoc if the index file is out of date or missing 1640 $(JLINK_PLUGIN_INDEX_HTML): $(JLINK_PLUGIN_OPTIONS_FILE) $(JLINK_PLUGIN_PACKAGES_FILE) $(COREAPI_INDEX_FILE) 1641 $(prep-javadoc) 1642 $(call JavadocSummary,$(JLINK_PLUGIN_OPTIONS_FILE),$(JLINK_PLUGIN_PACKAGES_FILE)) 1643 $(JAVADOC_CMD_SMALL) -d $(@D) \ 1644 @$(JLINK_PLUGIN_OPTIONS_FILE) @$(JLINK_PLUGIN_PACKAGES_FILE) 1645 1646 # Create file with javadoc options in it 1647 $(JLINK_PLUGIN_OPTIONS_FILE): 1648 $(prep-target) 1649 @($(call COMMON_JAVADOCFLAGS) ; \ 1650 $(call COMMON_JAVADOCTAGS) ; \ 1651 $(call OptionOnly,-Xdoclint:none) ; \ 1652 $(call OptionPair,-system,none) ; \ 1653 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ 1654 $(call OptionPair,-addmods,$(JLINK_PLUGIN_MODULES)) ; \ 1655 $(call OptionPair,-encoding,ascii) ; \ 1656 $(call OptionOnly,-nodeprecatedlist) ; \ 1657 $(call OptionPair,-doctitle,$(JLINK_PLUGIN_DOCTITLE)) ; \ 1658 $(call OptionPair,-windowtitle,$(JLINK_PLUGIN_WINDOWTITLE) $(DRAFT_WINTITLE)); \ 1659 $(call OptionPair,-header,$(JLINK_PLUGIN_HEADER)$(DRAFT_HEADER)); \ 1660 $(call OptionPair,-bottom,$(JLINK_PLUGIN_BOTTOM)$(DRAFT_BOTTOM)); \ 1661 $(call OptionTrip,-linkoffline,$(JLINK_PLUGIN2COREAPI),$(COREAPI_DOCSDIR)/); \ 1662 ) >> $@ 1663 1664 # Create a file with the package names in it 1665 $(JLINK_PLUGIN_PACKAGES_FILE): $(call PackageDependencies,$(JLINK_PLUGIN_PKGS)) 1666 $(prep-target) 1667 $(call PackageFilter,$(JLINK_PLUGIN_PKGS)) 1668 1669 1670 otherdocs: $(ALL_OTHER_TARGETS) 1671 1672 # 1673 # Add the core docs as prerequisite to the archive to trigger a rebuild 1674 # if the core docs were rebuilt. Ideally any doc rebuild should trigger 1675 # this, but the way prerequisites are currently setup in this file, that 1676 # is hard to achieve. 1677 # 1678 1679 $(JAVADOC_ARCHIVE): $(COREAPI_INDEX_FILE) 1680 $(call LogInfo, Compressing javadoc to single $(JAVADOC_ARCHIVE_NAME)) 1681 $(MKDIR) -p $(JAVADOC_ARCHIVE_DIR) 1682 $(RM) -r $(JAVADOC_ARCHIVE_ASSEMBLY_DIR) 1683 $(MKDIR) -p $(JAVADOC_ARCHIVE_ASSEMBLY_DIR) 1684 all_roots=`$(FIND) $(DOCSDIR) | $(GREP) index.html | grep -v old/doclet`; \ 1685 pushd $(JAVADOC_ARCHIVE_ASSEMBLY_DIR); \ 1686 for index_file in $${all_roots} ; do \ 1687 target_dir=`dirname $${index_file}`; \ 1688 name=`$(ECHO) $${target_dir} | $(SED) "s;/spec;;" | $(SED) "s;.*/;;"`; \ 1689 $(LN) -s $${target_dir} $${name}; \ 1690 done; \ 1691 $(ZIP) -q -r $(JAVADOC_ARCHIVE) * ; \ 1692 popd ; 1693 1694 ############################################################# 1695 .PHONY: all docs coredocs otherdocs \ 1696 $(ALL_OTHER_TARGETS) zip-docs 1697 1698 ################################################################################ 1699 1700 $(eval $(call IncludeCustomExtension, , Javadoc-post.gmk))