annotate make/Javadoc.gmk @ 39384:adde8cb7d01b

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