make/Javadoc.gmk

Thu, 08 Jan 2015 20:39:37 +0530

author
sundar
date
Thu, 08 Jan 2015 20:39:37 +0530
changeset 1214
765a17e75fd6
parent 1207
2eff25723f83
child 1216
d8a715bb7aad
permissions
-rw-r--r--

8068650: $jdk/api/javac/tree contains docs for nashorn
Reviewed-by: jlaskey, hannesw, erikj

jjg@592 1 # Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
ohair@478 2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@478 3 #
ohair@478 4 # This code is free software; you can redistribute it and/or modify it
ohair@478 5 # under the terms of the GNU General Public License version 2 only, as
ohair@478 6 # published by the Free Software Foundation. Oracle designates this
ohair@478 7 # particular file as subject to the "Classpath" exception as provided
ohair@478 8 # by Oracle in the LICENSE file that accompanied this code.
ohair@478 9 #
ohair@478 10 # This code is distributed in the hope that it will be useful, but WITHOUT
ohair@478 11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@478 12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@478 13 # version 2 for more details (a copy is included in the LICENSE file that
ohair@478 14 # accompanied this code).
ohair@478 15 #
ohair@478 16 # You should have received a copy of the GNU General Public License version
ohair@478 17 # 2 along with this work; if not, write to the Free Software Foundation,
ohair@478 18 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@478 19 #
ohair@478 20 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@478 21 # or visit www.oracle.com if you need additional information or have any
ohair@478 22 # questions.
ohair@478 23 #
ohair@478 24
ohair@478 25 include $(SPEC)
ohair@478 26 include MakeBase.gmk
ohair@478 27
ohair@478 28 .SUFFIXES: # Delete the default suffixes
ohair@478 29 .SUFFIXES: .java
ohair@478 30
ohair@478 31 #
ohair@478 32 # Definitions for $(DOCSDIR), $(MKDIR), $(BINDIR), etc.
ohair@478 33 #
ohair@478 34
ohair@478 35 DOCSDIR=$(OUTPUT_ROOT)/docs
ohair@478 36 TEMPDIR=$(OUTPUT_ROOT)/docstemp
ohair@478 37
ohair@478 38 JDK_SHARE_SRC=$(JDK_TOPDIR)/src/share
ohair@478 39 JDK_SHARE_CLASSES=$(JDK_SHARE_SRC)/classes
ohair@478 40
ohair@478 41 JDK_IMPSRC = $(JDK_OUTPUTDIR)/impsrc
ohair@478 42
ohair@478 43 JDK_GENSRC = $(JDK_OUTPUTDIR)/gensrc
ohair@478 44
ohair@478 45 HOTSPOT_DOCS_IMPORT_PATH=$(HOTSPOT_OUTPUTDIR)/docs
ohair@478 46
ohair@478 47 BUILD_NUMBER=$(JDK_BUILD_NUMBER)
ohair@478 48
ohrstrom@607 49 JAVADOC_CMD = $(JAVA) \
ihse@839 50 -Xmx1024m \
ihse@839 51 -Djava.awt.headless=true \
ihse@839 52 $(NEW_JAVADOC) \
ihse@839 53 -bootclasspath $(JDK_OUTPUTDIR)/classes
ohair@478 54
ohair@478 55 # Copyright year for beginning of Java and some of the apis
ihse@839 56 # (Needed when creating the javadocs)
ihse@839 57 FIRST_COPYRIGHT_YEAR = 1993
ihse@839 58 DOMAPI_FIRST_COPYRIGHT_YEAR = 2005
ihse@839 59 MIRROR_FIRST_COPYRIGHT_YEAR = 2004
ihse@839 60 DOCLETAPI_FIRST_COPYRIGHT_YEAR = 1993
ihse@839 61 TAGLETAPI_FIRST_COPYRIGHT_YEAR = 1993
ihse@839 62 JDI_FIRST_COPYRIGHT_YEAR = 1999
ihse@839 63 JAAS_FIRST_COPYRIGHT_YEAR = 1998
ihse@839 64 JGSS_FIRST_COPYRIGHT_YEAR = 2000
ihse@839 65 SMARTCARDIO_FIRST_COPYRIGHT_YEAR = 2005
ihse@839 66 HTTPSERVER_FIRST_COPYRIGHT_YEAR = 2005
ihse@839 67 MGMT_FIRST_COPYRIGHT_YEAR = 2003
ihse@839 68 ATTACH_FIRST_COPYRIGHT_YEAR = 2005
ihse@839 69 JCONSOLE_FIRST_COPYRIGHT_YEAR = 2006
ihse@839 70 SCTPAPI_FIRST_COPYRIGHT_YEAR = 2009
ihse@839 71 TRACING_FIRST_COPYRIGHT_YEAR = 2008
ihse@839 72 TREEAPI_FIRST_COPYRIGHT_YEAR = 2005
sundar@1207 73 NASHORNAPI_FIRST_COPYRIGHT_YEAR = 2014
ihse@839 74 JNLP_FIRST_COPYRIGHT_YEAR = 1998
ihse@839 75 PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007
michaelm@1033 76 JDKNET_FIRST_COPYRIGHT_YEAR = 2014
ohair@478 77
ohair@478 78 # Oracle name
ohair@478 79 FULL_COMPANY_NAME = Oracle and/or its affiliates
ohair@478 80
ohair@478 81 # Copyright address
ohair@478 82 COMPANY_ADDRESS = 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA.
ohair@478 83
ohair@478 84 # The trademark symbol
ohair@478 85 TRADEMARK = &trade;
ohair@478 86
ohair@478 87 # Common copyright lines used
ihse@839 88 # The word "Copyright" might optionally be a link to the file cpyr.html.
ihse@839 89 # The first year of copyright may vary or not be available.
ihse@839 90 # The address to the company might be optional.
ohair@478 91 COMMA:= ,
ohair@478 92 EMPTY:=
ohair@478 93 SPACE:=$(EMPTY) $(EMPTY)
ohair@478 94 COPYRIGHT_SYMBOL = &\#x00a9;
ohair@478 95 # Macro to construct the copyright line
ihse@839 96 # (The GNU make 3.78.1 "if" conditional is broken, fixed in GNU make 3.81)
ohair@478 97 define CopyrightLine # optionalurl optionalfirstyear optionaladdress
ohair@478 98 $(if $(strip $1),<a href="$(strip $1)">Copyright</a>,Copyright) \
ohair@478 99 $(COPYRIGHT_SYMBOL) $(if $2,$2${COMMA},) $(COPYRIGHT_YEAR),\
ohair@478 100 $(FULL_COMPANY_NAME). $3 All rights reserved.
ohair@478 101 endef
ohair@478 102
ohair@478 103 # Url to root of documents
ohair@478 104 DOCSDIR_URL = {@docroot}/$(GET2DOCSDIR)
ohair@478 105
ohair@478 106 # Url to copyright html file
erikj@1039 107 COPYRIGHT_URL = $(DOCSDIR_URL)/legal/cpyr.html
ohair@478 108
ohair@478 109 # Url to bug filing site
ohair@478 110 BUG_SUBMIT_URL = http://bugreport.sun.com/bugreport/
ohair@478 111
ohair@478 112 # Common line for how to submit a bug or rfe
ohair@478 113 BUG_SUBMIT_LINE = <a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a>
ohair@478 114
ohair@478 115 # Url to devdocs page
ihse@839 116 # Was: http://java.sun.com/javase/6/webnotes/devdocs-vs-specs.html
ohair@478 117 DEV_DOCS_URL-7 = http://download.oracle.com/javase/7/docs/index.html
bpatel@817 118 DEV_DOCS_URL-8 = http://download.oracle.com/javase/8/docs/index.html
ohair@478 119 DEV_DOCS_URL = $(DEV_DOCS_URL-$(JDK_MINOR_VERSION))
ohair@478 120 DOCS_BASE_URL = http://download.oracle.com/javase/7/docs
ohair@478 121
ohair@478 122 # Common Java trademark line
ohair@478 123 JAVA_TRADEMARK_LINE = Java is a trademark or registered trademark of \
ohair@478 124 $(FULL_COMPANY_NAME) in the US and other countries.
ohair@478 125
ohair@478 126 #################################################################
ohair@478 127 # Macros:
ohair@478 128
ohair@478 129
ohair@478 130 # List of all possible directories for javadoc to look for sources
ihse@839 131 # NOTE: Quotes are required around sourcepath argument only on Windows.
ihse@839 132 # Otherwise, you get "No packages or classes specified." due
ihse@839 133 # to $(PATH_SEP) being interpreted as an end of
ihse@839 134 # command (newline or shell ; character)
erikj@518 135 ALL_SOURCE_DIRS = $(JDK_SHARE_CLASSES) \
ihse@839 136 $(JDK_IMPSRC) \
ihse@839 137 $(JDK_GENSRC) \
ihse@839 138 $(JDK_OUTPUTDIR)/gendocsrc_rmic \
ihse@839 139 $(JDK_TOPDIR)/src/solaris/classes \
ihse@839 140 $(JDK_TOPDIR)/src/windows/classes \
sundar@1207 141 $(NASHORN_TOPDIR)/src/ \
ihse@839 142 $(JDK_SHARE_SRC)/doc/stub
ohair@478 143
ohair@478 144 # List of directories that actually exist
ohair@478 145 ALL_EXISTING_SOURCE_DIRS := $(wildcard $(ALL_SOURCE_DIRS))
ohair@478 146
ohair@478 147 # List with classpath separator between them
ohair@478 148 EMPTY:=
ohair@478 149 SPACE:= $(EMPTY) $(EMPTY)
ohair@478 150 RELEASEDOCS_SOURCEPATH = \
erikj@558 151 $(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_SOURCE_DIRS)))
ohair@478 152
ohair@478 153 define prep-target
ihse@839 154 $(MKDIR) -p $(@D)
ihse@839 155 $(RM) $@
ohair@478 156 endef
ohair@478 157
ohair@478 158 # Prep for javadoc creation, assumes $@ is an index.html file
ohair@478 159 define prep-javadoc
ihse@839 160 @if [ -f "$@" -a "$?" != "" ] ; then \
ihse@839 161 $(ECHO) "# Dependencies have changed: $?"; \
ihse@839 162 fi
ihse@839 163 $(RM) -r $(@D)
ihse@839 164 $(MKDIR) -p $(@D)
ohair@478 165 endef
ohair@478 166
ohair@478 167 # A cache of the directories in ALL_SOURCE_DIRS
ohair@478 168 DIRECTORY_CACHE = $(DOCSTMPDIR)/directory.cache
ohair@478 169
ohair@478 170 # Given a list of packages, return a list of files or dirs to be dependent on
ihse@839 171 # (Currently only returning a list of directories)
ohair@478 172 define PackageDependencies # packages
ihse@839 173 $(shell \
ihse@839 174 if [ "$1" != "" -a -f $(DIRECTORY_CACHE) ] ; then \
ihse@839 175 for p in $1 ; do \
ihse@839 176 pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \
ihse@839 177 $(CAT) $(DIRECTORY_CACHE) | $(GREP) "/$${pd}/" ; \
ihse@839 178 done; \
ihse@839 179 fi \
ihse@839 180 )
ohair@478 181 endef
ohair@478 182
ohair@478 183 # Given a list of packages, add packages that exist to $@, print summary
ohair@478 184 define PackageFilter # packages
ihse@839 185 @if [ "$1" != "" ] ; then \
ihse@839 186 for p in $1 ; do \
ihse@839 187 pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \
ihse@839 188 found="false"; \
ihse@839 189 for cp in $(ALL_SOURCE_DIRS) ; do \
ihse@839 190 if [ -d $${cp}/$${pd} ] ; then \
ihse@839 191 $(ECHO) "$${p}" >> $@; \
ihse@839 192 found="true"; \
ihse@839 193 break; \
ihse@839 194 fi; \
ihse@839 195 done; \
ihse@839 196 if [ "$${found}" = "false" ] ; then \
ihse@839 197 $(ECHO) "WARNING: Package not found: $${p}"; \
ihse@839 198 fi; \
ihse@839 199 done; \
ihse@839 200 fi
ohair@478 201 endef
ohair@478 202
ohair@478 203 # Print out a summary of the javadoc command about to be run
ohair@478 204 define JavadocSummary # optionsfile packagesfile
ihse@839 205 @$(ECHO) "# Summary for $@"; \
ihse@839 206 $(ECHO) "# Options (`$(BASENAME) $1`):"; $(SED) -e 's@^@# @' $1; \
ihse@839 207 $(ECHO) "# Packages (`$(BASENAME) $2`):";$(SED) -e 's@^@# @' $2
ohair@478 208 endef
ohair@478 209
ohair@478 210 #
ohair@478 211 # Temporary directory for javadoc creation
ohair@478 212 #
ohair@478 213 DOCSTMPDIR = $(TEMPDIR)/doctmp
ohair@478 214
ohair@478 215 #
ohair@478 216 # Different api directories created from root directory
ohair@478 217 #
ihse@839 218 COREAPI_DOCSDIR = $(DOCSDIR)/api
ihse@839 219 JDK_API_DOCSDIR = $(DOCSDIR)/jdk/api
ihse@839 220 JRE_API_DOCSDIR = $(DOCSDIR)/jre/api
ihse@839 221 PLATFORM_DOCSDIR = $(DOCSDIR)/platform
ohair@478 222
ohair@478 223 # The non-core api javadocs need to be able to access the root of the core
ihse@839 224 # api directory, so for jdk/api or jre/api to get to the core api/
ihse@839 225 # directory we would use this:
ihse@839 226 JDKJRE2COREAPI = ../../api
ohair@478 227
ohair@478 228 # Common bottom argument
ohair@478 229 define CommonBottom # year
ohair@478 230 <font size="-1"><br> $(call CopyrightLine,,$1,)</font>
ohair@478 231 endef
ohair@478 232
ohair@478 233 # Common trademark bottom argument (Not sure why this is used sometimes)
ohair@478 234 define CommonTrademarkBottom # year
ohair@478 235 <font size="-1">\
ohair@478 236 $(BUG_SUBMIT_LINE)<br>$(JAVA_TRADEMARK_LINE)<br>\
ohair@478 237 $(call CopyrightLine,,$1,$(COMPANY_ADDRESS))\
ohair@478 238 </font>
ohair@478 239 endef
ohair@478 240
ohair@478 241 # Common echo of option
ohair@478 242 define OptionOnly # opt
ihse@839 243 $(PRINTF) "%s\n" "$1"
ohair@478 244 endef
ohair@478 245 define OptionPair # opt arg
ihse@839 246 $(PRINTF) "%s '%s'\n" "$1" '$2'
ohair@478 247 endef
ohair@478 248 define OptionTrip # opt arg arg
ihse@839 249 $(PRINTF) "%s '%s' '%s'\n" "$1" '$2' '$3'
ohair@478 250 endef
ohair@478 251
ohair@478 252 # Core api bottom argument (with special sauce)
ohair@478 253 COREAPI_BOTTOM = <font size="-1"> $(BUG_SUBMIT_LINE)\
ohair@478 254 <br>For further API reference and developer documentation, \
ohair@478 255 see <a href="$(DEV_DOCS_URL)" target="_blank">Java SE Documentation</a>. \
ohair@478 256 That documentation contains more detailed, developer-targeted descriptions, \
ohair@478 257 with conceptual overviews, definitions of terms, workarounds, \
ohair@478 258 and working code examples.<br>\
ohair@478 259 $(call CopyrightLine,$(COPYRIGHT_URL),$(FIRST_COPYRIGHT_YEAR),)\
ohair@478 260 </font>
ohair@478 261
ohair@478 262 # Common javadoc options used by all
ihse@839 263 COMMON_JAVADOCFLAGS = \
ihse@839 264 -XDignore.symbol.file=true \
ihse@839 265 -quiet \
ihse@839 266 -use \
ihse@839 267 -keywords \
ihse@839 268 -Xdoclint:none \
ihse@912 269 -Xprofilespath $(JDK_TOPDIR)/make/profile-rtjar-includes.txt \
ihse@839 270 $(ADDITIONAL_JAVADOCFLAGS)
ohair@478 271
ohair@478 272 ifdef OPENJDK
ihse@839 273 ADDITIONAL_JAVADOCFLAGS = \
ihse@839 274 -Xdocrootparent $(DOCS_BASE_URL)
ohair@478 275 else
ohair@478 276 ADDITIONAL_JAVADOCFLAGS =
ohair@478 277 endif
ohair@478 278
ohair@478 279 # Draft used for non-fcs documents
ohair@478 280 DRAFT_HEADER =
ohair@478 281 ifneq ($(MILESTONE), fcs)
ihse@839 282 DRAFT_HEADER = <br><strong>DRAFT&nbsp;$(MILESTONE)-$(BUILD_NUMBER)</strong>
ihse@839 283 DRAFT_BOTTOM = <br><strong>DRAFT&nbsp;$(MILESTONE)-$(BUILD_NUMBER)</strong>
ihse@839 284 DRAFT_WINTITLE = $(BUILD_NUMBER)
ihse@839 285 # Early access top text (not used in FCS releases)
ihse@839 286 COREAPI_TOP_EARLYACCESS = \
ohair@478 287 <div style="background-color: \#EEEEEE"> \
ohair@478 288 <div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; \
ohair@478 289 margin-left: 6px; margin-right: 6px; text-align: justify; \
ohair@478 290 font-size: 80%; font-family: Helvetica, Arial, sans-serif; \
ohair@478 291 font-weight: normal;"> \
ohair@478 292 Please note that the specifications and other information \
ohair@478 293 contained herein are not final and are subject to change. \
ohair@478 294 The information is being made available to you solely for purpose of \
ohair@478 295 evaluation. \
ohair@478 296 </div> </div>
ihse@839 297
ohair@478 298 endif
ohair@478 299
ohair@478 300 #################################################################
ohair@478 301
ohair@478 302 #
ohair@478 303 # CORE_PKGS environment variable has been moved to the following file
ohair@478 304 #
ohair@478 305 include CORE_PKGS.gmk
ohair@478 306
ohair@478 307 #
ohair@478 308 # Load environment variables for API package names that are not part of
ohair@478 309 # the Java SE platform
ohair@478 310 #
ohair@478 311 include NON_CORE_PKGS.gmk
ohair@478 312
ohair@478 313 #################################################################
ohair@478 314
ohair@478 315 #
rriggs@1196 316 # Load custom Javadoc rules, if present
rriggs@1196 317 #
rriggs@1196 318 -include $(CUSTOM_MAKE_DIR)/Javadoc.gmk
rriggs@1196 319
rriggs@1196 320 #################################################################
rriggs@1196 321
rriggs@1196 322 #
ohair@478 323 # Default target is same as docs target, create core api and all others it can
ohair@478 324 #
ohair@478 325
ohair@478 326 all: docs
ohair@478 327 docs: coredocs otherdocs
ohair@478 328
ohair@478 329 #################################################################
ohair@478 330 # Production Targets -- USE THESE TARGETS WHEN:
ihse@839 331 # a) You're generating docs outside of release engineering's
ihse@839 332 # standard control build.
ihse@839 333 # b) The docs will be pushed to the web and/or included in
ihse@839 334 # the downloaded doc bundle.
ohair@478 335 #
ihse@839 336 # See: Notes.html#releaseTargets
ohair@478 337 # Note: Spaces precede ifdef/ifndef indents. Tabs precede target commands (!)
ohair@478 338 #
ohair@478 339
ohair@478 340 sanitycheckcoredocs:
ohair@478 341 @$(ECHO) ""
ohair@478 342 @$(ECHO) "Building core api docs with these values:"
ohair@478 343 @$(ECHO) " BUILD_NUMBER = $(BUILD_NUMBER)"
ohair@478 344 @$(ECHO) " MILESTONE = $(MILESTONE)"
ohair@478 345 @$(ECHO) ""
ihse@839 346 ifeq ($(BUILD_NUMBER), b00)
ihse@839 347 @$(ECHO) "ERROR: Build number must be defined"
ihse@839 348 @$(ECHO) "MILESTONE is set to $(MILESTONE)"
ihse@839 349 @$(ECHO) ""
ihse@839 350 exit 1
ihse@839 351 endif
ohair@478 352
ohair@478 353 #############################################################
ohair@478 354 #
ohair@478 355 # coredocs
ohair@478 356 #
ihse@839 357 COREAPI_DOCTITLE = Java$(TRADEMARK) Platform, Standard Edition \
ohair@478 358 $(JDK_MINOR_VERSION)<br>API Specification
ihse@839 359 COREAPI_WINDOWTITLE = Java Platform SE $(JDK_MINOR_VERSION)
ohair@478 360 COREAPI_HEADER = \
ohair@478 361 <strong>Java$(TRADEMARK)&nbsp;Platform<br>Standard&nbsp;Ed.&nbsp;$(JDK_MINOR_VERSION)</strong>
ohair@478 362
ohair@478 363 # Java language specification cite
ohair@478 364 TAG_JLS = jls:a:See <cite> \
ohair@478 365 The Java&trade; Language Specification</cite>:
ohair@478 366
ohair@478 367 # Overview file for core apis
ohair@478 368 COREAPI_OVERVIEW = $(JDK_SHARE_CLASSES)/overview-core.html
ohair@478 369
ohair@478 370 # The index.html, options, and packages files
ihse@839 371 COREAPI_INDEX_FILE = $(COREAPI_DOCSDIR)/index.html
ihse@839 372 COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options
ohair@478 373 COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages
ohair@478 374
ohair@478 375 coredocs: $(COREAPI_INDEX_FILE)
ohair@478 376
ohair@478 377 # Set relative location to core api document root
ohair@478 378 $(COREAPI_INDEX_FILE): GET2DOCSDIR=..
ohair@478 379
ohair@478 380 # Run javadoc if the index file is out of date or missing
ohair@478 381 $(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE)
ohair@478 382 $(prep-javadoc)
ohair@478 383 $(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE))
ohair@478 384 $(JAVADOC_CMD) -d $(@D) \
ihse@839 385 @$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE)
ohair@478 386
ohair@478 387 # Create file with javadoc options in it
ohair@478 388 $(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW)
ohair@478 389 $(prep-target)
ihse@839 390 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ihse@839 391 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ihse@839 392 $(call OptionPair,-encoding,ISO-8859-1) ; \
ihse@839 393 $(call OptionPair,-tag,beaninfo:X) ; \
ihse@839 394 $(call OptionPair,-tag,revised:X) ; \
ihse@839 395 $(call OptionPair,-tag,since.unbundled:X) ; \
ihse@839 396 $(call OptionPair,-tag,spec:X) ; \
ihse@839 397 $(call OptionPair,-tag,specdefault:X) ; \
ihse@839 398 $(call OptionPair,-tag,Note:X) ; \
ihse@839 399 $(call OptionPair,-tag,ToDo:X) ; \
ihse@839 400 $(call OptionPair,-tag,apiNote:a:API Note:) ; \
ihse@839 401 $(call OptionPair,-tag,implSpec:a:Implementation Requirements:) ; \
ihse@839 402 $(call OptionPair,-tag,implNote:a:Implementation Note:) ; \
ihse@839 403 $(call OptionPair,-tag,param) ; \
ihse@839 404 $(call OptionPair,-tag,return) ; \
ihse@839 405 $(call OptionPair,-tag,throws) ; \
ihse@839 406 $(call OptionPair,-tag,since) ; \
ihse@839 407 $(call OptionPair,-tag,version) ; \
ihse@839 408 $(call OptionPair,-tag,serialData) ; \
ihse@839 409 $(call OptionPair,-tag,factory) ; \
ihse@839 410 $(call OptionPair,-tag,see) ; \
ihse@839 411 $(call OptionPair,-tag,$(TAG_JLS)) ; \
ihse@839 412 $(call OptionOnly,-splitIndex) ; \
ihse@839 413 $(call OptionPair,-overview,$(COREAPI_OVERVIEW)) ; \
ihse@839 414 $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE)) ; \
ihse@839 415 $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ; \
ihse@839 416 $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER)) ; \
ihse@839 417 $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
ihse@839 418 ) >> $@
ihse@839 419 ifdef COREAPI_TOP_EARLYACCESS
ihse@839 420 @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@
ihse@839 421 endif
ohair@478 422
ohair@478 423 # Create a file with the package names in it
ohair@478 424 $(COREAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(CORE_PKGS))
ohair@478 425 $(prep-target)
ohair@478 426 $(call PackageFilter,$(CORE_PKGS))
ohair@478 427
ohair@478 428 #############################################################
ohair@478 429 #
ohair@478 430 # docletapidocs
ohair@478 431 #
ohair@478 432
ohair@478 433 ALL_OTHER_TARGETS += docletapidocs
ohair@478 434
ihse@839 435 DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet
ihse@839 436 DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
ihse@839 437 DOCLETAPI_DOCTITLE := Doclet API
ihse@839 438 DOCLETAPI_WINDOWTITLE := Doclet API
ihse@839 439 DOCLETAPI_HEADER := <strong>Doclet API</strong>
ihse@839 440 DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
ihse@839 441 DOCLETAPI_GROUPNAME := Packages
ihse@839 442 DOCLETAPI_REGEXP := com.sun.javadoc
ohair@478 443 # DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 444
ohair@478 445 # The index.html, options, and packages files
ihse@839 446 DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html
ihse@839 447 DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options
ohair@478 448 DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages
ohair@478 449
ohair@478 450 docletapidocs: $(DOCLETAPI_INDEX_FILE)
ohair@478 451
ohair@478 452 # Set relative location to core api document root
ohair@478 453 $(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/..
ohair@478 454
ohair@478 455 # Run javadoc if the index file is out of date or missing
erikj@518 456 $(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) coredocs
ohair@478 457 $(prep-javadoc)
ohair@478 458 $(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE))
ohair@478 459 $(JAVADOC_CMD) -d $(@D) \
ihse@839 460 @$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE)
ohair@478 461
ohair@478 462 # Create file with javadoc options in it
ohair@478 463 $(DOCLETAPI_OPTIONS_FILE):
ohair@478 464 $(prep-target)
ihse@839 465 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ihse@839 466 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ihse@839 467 $(call OptionPair,-encoding,ascii) ; \
ihse@839 468 $(call OptionOnly,-breakiterator) ; \
ihse@839 469 $(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \
ihse@839 470 $(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ihse@839 471 $(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \
ihse@839 472 $(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 473 $(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \
ohair@478 474 $(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
ihse@839 475 ) >> $@
ohair@478 476
ohair@478 477 # Create a file with the package names in it
ohair@478 478 $(DOCLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOCLETAPI_PKGS))
ohair@478 479 $(prep-target)
ohair@478 480 $(call PackageFilter,$(DOCLETAPI_PKGS))
ohair@478 481
ohair@478 482 #############################################################
ohair@478 483 #
ohair@478 484 # tagletapidocs
ohair@478 485 #
ohair@478 486
ohair@478 487 ALL_OTHER_TARGETS += tagletapidocs
ihse@839 488 TAGLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/taglet
ihse@839 489 TAGLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
ihse@839 490 TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR))
ohair@478 491 # TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk
ohair@478 492
ohair@478 493 # Temporary directory (special generation rules)
ihse@839 494 TAGLETAPI_TEMPDIR = $(DOCSTMPDIR)/taglets_temp
ohair@478 495
ohair@478 496 # The index.html, options, and packages files
ihse@839 497 TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/index.html
ihse@839 498 TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options
ohair@478 499 TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages
ohair@478 500
ohair@478 501 tagletapidocs: $(TAGLETAPI_INDEX_FILE)
ohair@478 502
ohair@478 503 # Set relative location to core api document root
ohair@478 504 $(TAGLETAPI_INDEX_FILE): GET2DOCSDIR=$(TAGLETAPI2COREAPI)/..
ohair@478 505
ohair@478 506 # Run javadoc if the index file is out of date or missing
erikj@518 507 $(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) coredocs
ohair@478 508 $(prep-javadoc)
ohair@478 509 $(RM) -r $(TAGLETAPI_TEMPDIR)
ohair@478 510 $(MKDIR) -p $(TAGLETAPI_TEMPDIR)
ohair@478 511 $(call JavadocSummary,$(TAGLETAPI_OPTIONS_FILE),$(TAGLETAPI_PACKAGES_FILE))
ohair@478 512 $(JAVADOC_CMD) -d $(TAGLETAPI_TEMPDIR) \
ihse@839 513 @$(TAGLETAPI_OPTIONS_FILE) @$(TAGLETAPI_PACKAGES_FILE)
ohair@478 514 cp -r $(TAGLETAPI_TEMPDIR)/com $(@D)
ohair@478 515 cp $(TAGLETAPI_TEMPDIR)/stylesheet.css $(@D)
ohair@478 516 $(RM) -r $(TAGLETAPI_TEMPDIR)
ohair@478 517
ohair@478 518 # Create file with javadoc options in it
ohair@478 519 $(TAGLETAPI_OPTIONS_FILE):
ohair@478 520 $(prep-target)
ihse@839 521 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ihse@839 522 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ihse@839 523 $(call OptionPair,-encoding,ascii) ; \
ihse@839 524 $(call OptionOnly,-nonavbar) ; \
ihse@839 525 $(call OptionOnly,-noindex) ; \
ihse@839 526 $(call OptionPair,-bottom,$(TAGLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 527 $(call OptionTrip,-linkoffline,$(TAGLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
ihse@839 528 ) >> $@
ohair@478 529
ohair@478 530 # Create a file with the package names in it
ohair@478 531 $(TAGLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TAGLETAPI_PKGS))
ohair@478 532 $(prep-target)
erikj@518 533 @($(ECHO) "$(JDK_IMPSRC)/$(TAGLETAPI_FILE)" ) > $@
ohair@478 534
ohair@478 535 #############################################################
ohair@478 536 #
ohair@478 537 # domapidocs
ohair@478 538 #
ohair@478 539
ohair@478 540 ALL_OTHER_TARGETS += domapidocs
ohair@478 541
ihse@839 542 DOMAPI_DOCDIR := $(JRE_API_DOCSDIR)/plugin/dom
ihse@839 543 DOMAPI2COREAPI := ../../$(JDKJRE2COREAPI)
ihse@839 544 DOMAPI_DOCTITLE := Common DOM API
ihse@839 545 DOMAPI_WINDOWTITLE := Common DOM API
ihse@839 546 DOMAPI_HEADER := <strong>Common DOM API</strong>
ihse@839 547 DOMAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOMAPI_FIRST_COPYRIGHT_YEAR))
ihse@839 548 DOMAPI_GROUPNAME := Packages
ihse@839 549 DOMAPI_REGEXP := com.sun.java.browser.dom:org.w3c.dom*
ohair@478 550 # DOMAPI_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 551
ohair@478 552 # The index.html, options, and packages files
ihse@839 553 DOMAPI_INDEX_FILE = $(DOMAPI_DOCDIR)/index.html
ihse@839 554 DOMAPI_OPTIONS_FILE = $(DOCSTMPDIR)/domapi.options
ohair@478 555 DOMAPI_PACKAGES_FILE = $(DOCSTMPDIR)/domapi.packages
ohair@478 556
ohair@478 557 domapidocs: $(DOMAPI_INDEX_FILE)
ohair@478 558
ohair@478 559 # Set relative location to core api document root
ohair@478 560 $(DOMAPI_INDEX_FILE): GET2DOCSDIR=$(DOMAPI2COREAPI)/..
ohair@478 561
ohair@478 562 # Run javadoc if the index file is out of date or missing
erikj@518 563 $(DOMAPI_INDEX_FILE): $(DOMAPI_OPTIONS_FILE) $(DOMAPI_PACKAGES_FILE) coredocs
ohair@478 564 $(prep-javadoc)
ohair@478 565 $(call JavadocSummary,$(DOMAPI_OPTIONS_FILE),$(DOMAPI_PACKAGES_FILE))
ohair@478 566 $(JAVADOC_CMD) -d $(@D) \
ihse@839 567 @$(DOMAPI_OPTIONS_FILE) @$(DOMAPI_PACKAGES_FILE)
ohair@478 568
ohair@478 569 # Create file with javadoc options in it
ohair@478 570 $(DOMAPI_OPTIONS_FILE):
ohair@478 571 $(prep-target)
ihse@839 572 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ihse@839 573 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ihse@839 574 $(call OptionPair,-encoding,ascii) ; \
ihse@839 575 $(call OptionOnly,-splitIndex) ; \
ihse@839 576 $(call OptionPair,-doctitle,$(DOMAPI_DOCTITLE)) ; \
ihse@839 577 $(call OptionPair,-windowtitle,$(DOMAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ihse@839 578 $(call OptionPair,-header,$(DOMAPI_HEADER)$(DRAFT_HEADER)) ; \
ihse@839 579 $(call OptionPair,-bottom,$(DOMAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 580 $(call OptionTrip,-group,$(DOMAPI_GROUPNAME),$(DOMAPI_REGEXP)); \
ohair@478 581 $(call OptionTrip,-linkoffline,$(DOMAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
ihse@839 582 ) >> $@
ohair@478 583
ohair@478 584 # Create a file with the package names in it
ohair@478 585 $(DOMAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOMAPI_PKGS))
ohair@478 586 $(prep-target)
ohair@478 587 $(call PackageFilter,$(DOMAPI_PKGS))
ohair@478 588
ohair@478 589 #############################################################
ohair@478 590 #
ohair@478 591 # jpdadocs
ohair@478 592 #
ohair@478 593
ohair@478 594 ALL_OTHER_TARGETS += jpdadocs
ohair@478 595
ohair@478 596 jpdadocs: jdidocs jdwpdocs jvmtidocs
ohair@478 597
ohair@478 598 #############################################################
ohair@478 599 #
ohair@478 600 # jdidocs
ohair@478 601 #
ohair@478 602
ohair@478 603 ALL_OTHER_TARGETS += jdidocs
ohair@478 604
ihse@839 605 JDI_DOCDIR := $(JDK_API_DOCSDIR)/jpda/jdi
ihse@839 606 JDI2COREAPI := ../../$(JDKJRE2COREAPI)
ihse@839 607 JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface
ohair@478 608 JDI_WINDOWTITLE := Java Debug Interface
ihse@839 609 JDI_HEADER := <strong>Java Debug Interface</strong>
ihse@839 610 JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR))
ihse@839 611 JDI_OVERVIEW := $(JDK_SHARE_CLASSES)/jdi-overview.html
ohair@478 612 # JDI_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 613
ohair@478 614 # The index.html, options, and packages files
ihse@839 615 JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html
ihse@839 616 JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options
ohair@478 617 JDI_PACKAGES_FILE = $(DOCSTMPDIR)/jdi.packages
ohair@478 618
ohair@478 619 jdidocs: $(JDI_INDEX_FILE)
ohair@478 620
ohair@478 621 # Set relative location to core api document root
ohair@478 622 $(JDI_INDEX_FILE): GET2DOCSDIR=$(JDI2COREAPI)/..
ohair@478 623
ohair@478 624 # Run javadoc if the index file is out of date or missing
erikj@518 625 $(JDI_INDEX_FILE): $(JDI_OPTIONS_FILE) $(JDI_PACKAGES_FILE) coredocs
ohair@478 626 $(prep-javadoc)
ohair@478 627 $(call JavadocSummary,$(JDI_OPTIONS_FILE),$(JDI_PACKAGES_FILE))
ohair@478 628 $(JAVADOC_CMD) -d $(@D) \
ihse@839 629 @$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE)
ohair@478 630
ohair@478 631 # Create file with javadoc options in it
ohair@478 632 $(JDI_OPTIONS_FILE): $(JDI_OVERVIEW)
ohair@478 633 $(prep-target)
ihse@839 634 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ihse@839 635 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ihse@839 636 $(call OptionPair,-encoding,ascii) ; \
ihse@839 637 $(call OptionPair,-overview,$(JDI_OVERVIEW)) ; \
ihse@839 638 $(call OptionPair,-doctitle,$(JDI_DOCTITLE)) ; \
ohair@478 639 $(call OptionPair,-windowtitle,$(JDI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ihse@839 640 $(call OptionPair,-header,$(JDI_HEADER)$(DRAFT_HEADER)) ; \
ihse@839 641 $(call OptionPair,-bottom,$(JDI_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 642 $(call OptionTrip,-linkoffline,$(JDI2COREAPI),$(COREAPI_DOCSDIR)/); \
ihse@839 643 ) >> $@
ohair@478 644
ohair@478 645 # Create a file with the package names in it
ohair@478 646 $(JDI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JDI_PKGS))
ohair@478 647 $(prep-target)
ohair@478 648 $(call PackageFilter,$(JDI_PKGS))
ohair@478 649
ohair@478 650 #############################################################
ohair@478 651 #
ohair@478 652 # jdwpdocs
ohair@478 653 #
ohair@478 654
ohair@478 655 ALL_OTHER_TARGETS += jdwpdocs
ohair@478 656
ihse@839 657 JDWP_DOCDIR = $(PLATFORM_DOCSDIR)/jpda/jdwp
ohair@478 658
ohair@478 659 jdwpdocs: $(JDWP_DOCDIR)/jdwp-protocol.html
ohair@478 660 $(JDWP_DOCDIR)/jdwp-protocol.html : $(JDK_OUTPUTDIR)/gensrc_jdwp_doc/jdwp-protocol.html
ohair@478 661 $(MKDIR) -p $(@D)
ohair@478 662 $(RM) $@
ohair@478 663 $(CP) $< $@
ohair@478 664
ohair@478 665 #############################################################
ohair@478 666 #
ohair@478 667 # jvmtidocs
ohair@478 668 #
ohair@478 669
ohair@478 670 ALL_OTHER_TARGETS += jvmtidocs
ohair@478 671
ihse@839 672 JVMTI_DOCDIR = $(PLATFORM_DOCSDIR)/jvmti
ihse@839 673 JVMTI_HTML = $(HOTSPOT_DIST)/docs/platform/jvmti/jvmti.html
ohair@478 674
ihse@839 675 jvmtidocs: $(JVMTI_DOCDIR)/jvmti.html
ohair@478 676 $(JVMTI_DOCDIR)/jvmti.html:
ohair@478 677 @$(prep-javadoc)
ihse@839 678 @if [ -f $(JVMTI_HTML) ] ; then \
ihse@839 679 $(ECHO) "$(CP) $(JVMTI_HTML) $@"; \
ihse@839 680 $(CP) $(JVMTI_HTML) $@; \
ihse@839 681 else \
ohair@478 682 $(ECHO) "WARNING: Generated file does not exist: $(JVMTI_HTML)"; \
ohair@478 683 fi
ohair@478 684
ohair@478 685 #############################################################
ohair@478 686 #
ohair@478 687 # jaasdocs
ohair@478 688 #
ohair@478 689
ohair@478 690 ALL_OTHER_TARGETS += jaasdocs
ohair@478 691
ihse@839 692 JAAS_DOCDIR := $(JRE_API_DOCSDIR)/security/jaas/spec
ihse@839 693 JAAS2COREAPI := ../../../$(JDKJRE2COREAPI)
ihse@839 694 JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service
ohair@478 695 JAAS_WINDOWTITLE := Java Authentication and Authorization Service
ihse@839 696 JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong>
ihse@839 697 JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR))
ohair@478 698 # JAAS_PKGS is located in NON_CORE_PKGS.gmk
ihse@839 699 JAAS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/auth/jaas-overview.html
ohair@478 700
ohair@478 701 # The index.html, options, and packages files
ihse@839 702 JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html
ihse@839 703 JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options
ohair@478 704 JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages
ohair@478 705
ohair@478 706 jaasdocs: $(JAAS_INDEX_FILE)
ohair@478 707
ohair@478 708 # Set relative location to core api document root
ohair@478 709 $(JAAS_INDEX_FILE): GET2DOCSDIR=$(JAAS2COREAPI)/..
ohair@478 710
ohair@478 711 # Run javadoc if the index file is out of date or missing
erikj@518 712 $(JAAS_INDEX_FILE): $(JAAS_OPTIONS_FILE) $(JAAS_PACKAGES_FILE) coredocs
ohair@478 713 $(prep-javadoc)
ohair@478 714 $(call JavadocSummary,$(JAAS_OPTIONS_FILE),$(JAAS_PACKAGES_FILE))
ohair@478 715 $(JAVADOC_CMD) -d $(@D) \
ihse@839 716 @$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE)
ohair@478 717
ohair@478 718 # Create file with javadoc options in it
ohair@478 719 $(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW)
ohair@478 720 $(prep-target)
ihse@839 721 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ihse@839 722 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ihse@839 723 $(call OptionPair,-encoding,ascii) ; \
ihse@839 724 $(call OptionPair,-overview,$(JAAS_OVERVIEW)) ; \
ihse@839 725 $(call OptionPair,-doctitle,$(JAAS_DOCTITLE)) ; \
ohair@478 726 $(call OptionPair,-windowtitle,$(JAAS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ihse@839 727 $(call OptionPair,-header,$(JAAS_HEADER)$(DRAFT_HEADER)) ; \
ihse@839 728 $(call OptionPair,-bottom,$(JAAS_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 729 $(call OptionTrip,-linkoffline,$(JAAS2COREAPI),$(COREAPI_DOCSDIR)/); \
ihse@839 730 ) >> $@
ohair@478 731
ohair@478 732 # Create a file with the package names in it
ohair@478 733 $(JAAS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JAAS_PKGS))
ohair@478 734 $(prep-target)
ohair@478 735 $(call PackageFilter,$(JAAS_PKGS))
ohair@478 736
ohair@478 737 #############################################################
ohair@478 738 #
ohair@478 739 # jgssdocs
ohair@478 740 #
ohair@478 741
ohair@478 742 ALL_OTHER_TARGETS += jgssdocs
ohair@478 743
ihse@839 744 JGSS_DOCDIR := $(JRE_API_DOCSDIR)/security/jgss/spec
ihse@839 745 JGSS2COREAPI := ../../../$(JDKJRE2COREAPI)
ihse@839 746 JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities
ohair@478 747 JGSS_WINDOWTITLE := Java GSS-API Utilities
ihse@839 748 JGSS_HEADER := <strong>Java GSS-API Utilities</strong>
ihse@839 749 JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR))
ihse@839 750 JGSS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/jgss/jgss-overview.html
ohair@478 751 # JGSS_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 752
ohair@478 753 # The index.html, options, and packages files
ihse@839 754 JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html
ihse@839 755 JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options
ohair@478 756 JGSS_PACKAGES_FILE = $(DOCSTMPDIR)/jgss.packages
ohair@478 757
ohair@478 758 jgssdocs: $(JGSS_INDEX_FILE)
ohair@478 759
ohair@478 760 # Set relative location to core api document root
ohair@478 761 $(JGSS_INDEX_FILE): GET2DOCSDIR=$(JGSS2COREAPI)/..
ohair@478 762
ohair@478 763 # Run javadoc if the index file is out of date or missing
erikj@518 764 $(JGSS_INDEX_FILE): $(JGSS_OPTIONS_FILE) $(JGSS_PACKAGES_FILE) coredocs
ohair@478 765 $(prep-javadoc)
ohair@478 766 $(call JavadocSummary,$(JGSS_OPTIONS_FILE),$(JGSS_PACKAGES_FILE))
ohair@478 767 $(JAVADOC_CMD) -d $(@D) \
ihse@839 768 @$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE)
ohair@478 769
ohair@478 770 # Create file with javadoc options in it
ohair@478 771 $(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW)
ohair@478 772 $(prep-target)
ihse@839 773 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ihse@839 774 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ihse@839 775 $(call OptionPair,-encoding,ascii) ; \
ihse@839 776 $(call OptionOnly,-nodeprecatedlist) ; \
ihse@839 777 $(call OptionPair,-overview,$(JGSS_OVERVIEW)) ; \
ihse@839 778 $(call OptionPair,-doctitle,$(JGSS_DOCTITLE)) ; \
ohair@478 779 $(call OptionPair,-windowtitle,$(JGSS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ihse@839 780 $(call OptionPair,-header,$(JGSS_HEADER)$(DRAFT_HEADER)) ; \
ihse@839 781 $(call OptionPair,-bottom,$(JGSS_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 782 $(call OptionTrip,-linkoffline,$(JGSS2COREAPI),$(COREAPI_DOCSDIR)/); \
ihse@839 783 ) >> $@
ohair@478 784
ohair@478 785 # Create a file with the package names in it
ohair@478 786 $(JGSS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JGSS_PKGS))
ohair@478 787 $(prep-target)
ohair@478 788 $(call PackageFilter,$(JGSS_PKGS))
ohair@478 789
ohair@478 790 #############################################################
ohair@478 791 #
ohair@478 792 # smartcardiodocs
ohair@478 793 #
ohair@478 794
ohair@478 795 ALL_OTHER_TARGETS += smartcardiodocs
ohair@478 796
ihse@839 797 SMARTCARDIO_DOCDIR := $(JRE_API_DOCSDIR)/security/smartcardio/spec
ihse@839 798 SMARTCARDIO2COREAPI := ../../../$(JDKJRE2COREAPI)
ihse@839 799 SMARTCARDIO_DOCTITLE := Java$(TRADEMARK) Smart Card I/O
ohair@478 800 SMARTCARDIO_WINDOWTITLE := Java Smart Card I/O
ihse@839 801 SMARTCARDIO_HEADER := <strong>Java Smart Card I/O</strong>
ihse@839 802 SMARTCARDIO_BOTTOM := $(call CommonBottom,$(SMARTCARDIO_FIRST_COPYRIGHT_YEAR))
ohair@478 803 # SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 804
ohair@478 805 # The index.html, options, and packages files
ihse@839 806 SMARTCARDIO_INDEX_FILE = $(SMARTCARDIO_DOCDIR)/index.html
ihse@839 807 SMARTCARDIO_OPTIONS_FILE = $(DOCSTMPDIR)/smartcardio.options
ohair@478 808 SMARTCARDIO_PACKAGES_FILE = $(DOCSTMPDIR)/smartcardio.packages
ohair@478 809
ohair@478 810 smartcardiodocs: $(SMARTCARDIO_INDEX_FILE)
ohair@478 811
ohair@478 812 # Set relative location to core api document root
ohair@478 813 $(SMARTCARDIO_INDEX_FILE): GET2DOCSDIR=$(SMARTCARDIO2COREAPI)/..
ohair@478 814
ohair@478 815 # Run javadoc if the index file is out of date or missing
erikj@518 816 $(SMARTCARDIO_INDEX_FILE): $(SMARTCARDIO_OPTIONS_FILE) $(SMARTCARDIO_PACKAGES_FILE) coredocs
ohair@478 817 $(prep-javadoc)
ohair@478 818 $(call JavadocSummary,$(SMARTCARDIO_OPTIONS_FILE),$(SMARTCARDIO_PACKAGES_FILE))
ohair@478 819 $(JAVADOC_CMD) -d $(@D) \
ihse@839 820 @$(SMARTCARDIO_OPTIONS_FILE) @$(SMARTCARDIO_PACKAGES_FILE)
ohair@478 821
ohair@478 822 # Create file with javadoc options in it
ohair@478 823 $(SMARTCARDIO_OPTIONS_FILE):
ohair@478 824 $(prep-target)
ihse@839 825 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ihse@839 826 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ihse@839 827 $(call OptionPair,-encoding,ascii) ; \
ihse@839 828 $(call OptionOnly,-nodeprecatedlist) ; \
ihse@839 829 $(call OptionPair,-doctitle,$(SMARTCARDIO_DOCTITLE)) ; \
ihse@839 830 $(call OptionPair,-windowtitle,$(SMARTCARDIO_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ohair@478 831 $(call OptionPair,-header,$(SMARTCARDIO_HEADER)$(DRAFT_HEADER)); \
ohair@478 832 $(call OptionPair,-bottom,$(SMARTCARDIO_BOTTOM)$(DRAFT_BOTTOM)); \
ohair@478 833 $(call OptionTrip,-linkoffline,$(SMARTCARDIO2COREAPI),$(COREAPI_DOCSDIR)/); \
ihse@839 834 ) >> $@
ohair@478 835
ohair@478 836 # Create a file with the package names in it
ohair@478 837 $(SMARTCARDIO_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SMARTCARDIO_PKGS))
ohair@478 838 $(prep-target)
ohair@478 839 $(call PackageFilter,$(SMARTCARDIO_PKGS))
ohair@478 840
ohair@478 841 #############################################################
ohair@478 842 #
ohair@478 843 # httpserverdocs
ohair@478 844 #
ohair@478 845
ohair@478 846 ALL_OTHER_TARGETS += httpserverdocs
ohair@478 847
ihse@839 848 HTTPSERVER_DOCDIR := $(JRE_API_DOCSDIR)/net/httpserver/spec
ihse@839 849 HTTPSERVER2COREAPI := ../../../$(JDKJRE2COREAPI)
ihse@839 850 HTTPSERVER_DOCTITLE := Java$(TRADEMARK) HTTP Server
ohair@478 851 HTTPSERVER_WINDOWTITLE := Java HTTP Server
ihse@839 852 HTTPSERVER_HEADER := <strong>Java HTTP Server</strong>
ihse@839 853 HTTPSERVER_BOTTOM := $(call CommonBottom,$(HTTPSERVER_FIRST_COPYRIGHT_YEAR))
ohair@478 854 # HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 855
ihse@839 856 HTTPSERVER_INDEX_HTML = $(HTTPSERVER_DOCDIR)/index.html
ihse@839 857 HTTPSERVER_OPTIONS_FILE = $(DOCSTMPDIR)/httpserver.options
ohair@478 858 HTTPSERVER_PACKAGES_FILE = $(DOCSTMPDIR)/httpserver.packages
ohair@478 859
ohair@478 860 httpserverdocs: $(HTTPSERVER_INDEX_HTML)
ohair@478 861
ohair@478 862 # Set relative location to core api document root
ohair@478 863 $(HTTPSERVER_INDEX_HTML): GET2DOCSDIR=$(HTTPSERVER2COREAPI)/..
ohair@478 864
ohair@478 865 # Run javadoc if the index file is out of date or missing
erikj@518 866 $(HTTPSERVER_INDEX_HTML): $(HTTPSERVER_OPTIONS_FILE) $(HTTPSERVER_PACKAGES_FILE) coredocs
ohair@478 867 $(prep-javadoc)
ohair@478 868 $(call JavadocSummary,$(HTTPSERVER_OPTIONS_FILE),$(HTTPSERVER_PACKAGES_FILE))
ohair@478 869 $(JAVADOC_CMD) -d $(@D) \
ihse@839 870 @$(HTTPSERVER_OPTIONS_FILE) @$(HTTPSERVER_PACKAGES_FILE)
ohair@478 871
ohair@478 872 # Create file with javadoc options in it
ohair@478 873 $(HTTPSERVER_OPTIONS_FILE):
ohair@478 874 $(prep-target)
ihse@839 875 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ihse@839 876 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ihse@839 877 $(call OptionPair,-encoding,ascii) ; \
ihse@839 878 $(call OptionOnly,-nodeprecatedlist) ; \
ihse@839 879 $(call OptionPair,-doctitle,$(HTTPSERVER_DOCTITLE)) ; \
ihse@839 880 $(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ohair@478 881 $(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \
ohair@478 882 $(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \
ohair@478 883 $(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \
ihse@839 884 ) >> $@
ohair@478 885
ohair@478 886 # Create a file with the package names in it
ohair@478 887 $(HTTPSERVER_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(HTTPSERVER_PKGS))
ohair@478 888 $(prep-target)
ohair@478 889 $(call PackageFilter,$(HTTPSERVER_PKGS))
ohair@478 890
ohair@478 891 #############################################################
ohair@478 892 #
ohair@478 893 # mgmtdocs
ohair@478 894 #
ohair@478 895
ohair@478 896 ALL_OTHER_TARGETS += mgmtdocs
ohair@478 897
ihse@839 898 MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension
ihse@839 899 MGMT2COREAPI := ../../$(JDKJRE2COREAPI)
ihse@839 900 JVM_MIB_NAME := JVM-MANAGEMENT-MIB.mib
ihse@839 901 JVM_MIB_SRC := $(JDK_TOPDIR)/src/closed/share/classes/sun/management/snmp/$(JVM_MIB_NAME)
ihse@839 902 MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform
ohair@478 903 MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform
ihse@839 904 MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong>
ihse@839 905 MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR))
ihse@839 906 MGMT_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/management/mgmt-overview.html
ohair@478 907 # MGMT_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 908
ohair@478 909 # The index.html, options, and packages files
ihse@839 910 MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html
ihse@839 911 MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options
ohair@478 912 MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages
ohair@478 913
ohair@478 914 mgmtdocs: $(MGMT_INDEX_FILE)
ohair@478 915
ohair@478 916 # Set relative location to core api document root
ohair@478 917 $(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/..
ohair@478 918
ohair@478 919 # Run javadoc if the index file is out of date or missing
erikj@518 920 $(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) coredocs
ohair@478 921 $(prep-javadoc)
ihse@839 922 @if [ -f $(JVM_MIB_SRC) ] ; then \
ihse@839 923 $(ECHO) "$(CP) $(JVM_MIB_SRC) $(@D)/.."; \
ihse@839 924 $(CP) $(JVM_MIB_SRC) $(@D)/.. ; \
ihse@839 925 else \
ihse@839 926 $(ECHO) "WARNING: File $(JVM_MIB_NAME) not available."; \
ohair@478 927 fi
ohair@478 928 $(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE))
ohair@478 929 $(JAVADOC_CMD) -d $(@D) \
ihse@839 930 @$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE)
ohair@478 931
ohair@478 932 # Create file with javadoc options in it
ohair@478 933 $(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW)
ohair@478 934 $(prep-target)
ihse@839 935 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ihse@839 936 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ihse@839 937 $(call OptionPair,-encoding,ascii) ; \
ihse@839 938 $(call OptionOnly,-nodeprecatedlist) ; \
ihse@839 939 $(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \
ihse@839 940 $(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \
ohair@478 941 $(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ihse@839 942 $(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \
ihse@839 943 $(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 944 $(call OptionTrip,-linkoffline,$(MGMT2COREAPI),$(COREAPI_DOCSDIR)/); \
ihse@839 945 ) >> $@
ohair@478 946
ohair@478 947 # Create a file with the package names in it
ohair@478 948 $(MGMT_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(MGMT_PKGS))
ohair@478 949 $(prep-target)
ohair@478 950 $(call PackageFilter,$(MGMT_PKGS))
ohair@478 951
ohair@478 952 #############################################################
ohair@478 953 #
ohair@478 954 # attachdocs
ohair@478 955 #
ohair@478 956
ohair@478 957 ALL_OTHER_TARGETS += attachdocs
ohair@478 958
ihse@839 959 ATTACH_DOCDIR := $(JDK_API_DOCSDIR)/attach/spec
ihse@839 960 ATTACH2COREAPI := ../../$(JDKJRE2COREAPI)
ihse@839 961 ATTACH_DOCTITLE := Attach API
ohair@478 962 ATTACH_WINDOWTITLE := Attach API
ihse@839 963 ATTACH_HEADER := <strong>Attach API</strong>
ihse@839 964 ATTACH_BOTTOM := $(call CommonBottom,$(ATTACH_FIRST_COPYRIGHT_YEAR))
ohair@478 965 # ATTACH_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 966
ihse@839 967 ATTACH_INDEX_HTML = $(ATTACH_DOCDIR)/index.html
ihse@839 968 ATTACH_OPTIONS_FILE = $(DOCSTMPDIR)/attach.options
ohair@478 969 ATTACH_PACKAGES_FILE = $(DOCSTMPDIR)/attach.packages
ohair@478 970
ohair@478 971 attachdocs: $(ATTACH_INDEX_HTML)
ohair@478 972
ohair@478 973 # Set relative location to core api document root
ohair@478 974 $(ATTACH_INDEX_HTML): GET2DOCSDIR=$(ATTACH2COREAPI)/..
ohair@478 975
ohair@478 976 # Run javadoc if the index file is out of date or missing
erikj@518 977 $(ATTACH_INDEX_HTML): $(ATTACH_OPTIONS_FILE) $(ATTACH_PACKAGES_FILE) coredocs
ohair@478 978 $(prep-javadoc)
ohair@478 979 $(call JavadocSummary,$(ATTACH_OPTIONS_FILE),$(ATTACH_PACKAGES_FILE))
ohair@478 980 $(JAVADOC_CMD) -d $(@D) \
ihse@839 981 @$(ATTACH_OPTIONS_FILE) @$(ATTACH_PACKAGES_FILE)
ohair@478 982
ohair@478 983 # Create file with javadoc options in it
ohair@478 984 $(ATTACH_OPTIONS_FILE):
ohair@478 985 $(prep-target)
ihse@839 986 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ihse@839 987 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ihse@839 988 $(call OptionPair,-encoding,ascii) ; \
ihse@839 989 $(call OptionOnly,-nodeprecatedlist) ; \
ihse@839 990 $(call OptionPair,-doctitle,$(ATTACH_DOCTITLE)) ; \
ihse@839 991 $(call OptionPair,-windowtitle,$(ATTACH_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ihse@839 992 $(call OptionPair,-header,$(ATTACH_HEADER)$(DRAFT_HEADER)) ; \
ihse@839 993 $(call OptionPair,-bottom,$(ATTACH_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 994 $(call OptionTrip,-linkoffline,$(ATTACH2COREAPI),$(COREAPI_DOCSDIR)/); \
ihse@839 995 ) >> $@
ohair@478 996
ohair@478 997 # Create a file with the package names in it
ohair@478 998 $(ATTACH_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(ATTACH_PKGS))
ohair@478 999 $(prep-target)
ohair@478 1000 $(call PackageFilter,$(ATTACH_PKGS))
ohair@478 1001
ohair@478 1002 #############################################################
ohair@478 1003 #
ohair@478 1004 # jconsoledocs
ohair@478 1005 #
ohair@478 1006
ohair@478 1007 ALL_OTHER_TARGETS += jconsoledocs
ohair@478 1008
ihse@839 1009 JCONSOLE_DOCDIR := $(JDK_API_DOCSDIR)/jconsole/spec
ihse@839 1010 JCONSOLE2COREAPI := ../../$(JDKJRE2COREAPI)
ihse@839 1011 JCONSOLE_DOCTITLE := JConsole API
ohair@478 1012 JCONSOLE_WINDOWTITLE := JConsole API
ihse@839 1013 JCONSOLE_HEADER := <strong>JConsole API</strong>
ihse@839 1014 JCONSOLE_BOTTOM := $(call CommonBottom,$(JCONSOLE_FIRST_COPYRIGHT_YEAR))
ohair@478 1015 # JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 1016
ihse@839 1017 JCONSOLE_INDEX_HTML = $(JCONSOLE_DOCDIR)/index.html
ihse@839 1018 JCONSOLE_OPTIONS_FILE = $(DOCSTMPDIR)/jconsole.options
ohair@478 1019 JCONSOLE_PACKAGES_FILE = $(DOCSTMPDIR)/jconsole.packages
ohair@478 1020
ohair@478 1021 jconsoledocs: $(JCONSOLE_INDEX_HTML)
ohair@478 1022
ohair@478 1023 # Set relative location to core api document root
ohair@478 1024 $(JCONSOLE_INDEX_HTML): GET2DOCSDIR=$(JCONSOLE2COREAPI)/..
ohair@478 1025
ohair@478 1026 # Run javadoc if the index file is out of date or missing
erikj@518 1027 $(JCONSOLE_INDEX_HTML): $(JCONSOLE_OPTIONS_FILE) $(JCONSOLE_PACKAGES_FILE) coredocs
ohair@478 1028 $(prep-javadoc)
ohair@478 1029 $(call JavadocSummary,$(JCONSOLE_OPTIONS_FILE),$(JCONSOLE_PACKAGES_FILE))
ohair@478 1030 $(JAVADOC_CMD) -d $(@D) \
ihse@839 1031 @$(JCONSOLE_OPTIONS_FILE) @$(JCONSOLE_PACKAGES_FILE)
ohair@478 1032
ohair@478 1033 # Create file with javadoc options in it
ohair@478 1034 $(JCONSOLE_OPTIONS_FILE):
ohair@478 1035 $(prep-target)
ihse@839 1036 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ihse@839 1037 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ihse@839 1038 $(call OptionPair,-encoding,ascii) ; \
ihse@839 1039 $(call OptionOnly,-nodeprecatedlist) ; \
ihse@839 1040 $(call OptionPair,-doctitle,$(JCONSOLE_DOCTITLE)) ; \
ihse@839 1041 $(call OptionPair,-windowtitle,$(JCONSOLE_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ihse@839 1042 $(call OptionPair,-header,$(JCONSOLE_HEADER)$(DRAFT_HEADER)) ; \
ihse@839 1043 $(call OptionPair,-bottom,$(JCONSOLE_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 1044 $(call OptionTrip,-linkoffline,$(JCONSOLE2COREAPI),$(COREAPI_DOCSDIR)/); \
ihse@839 1045 ) >> $@
ohair@478 1046
ohair@478 1047 # Create a file with the package names in it
ohair@478 1048 $(JCONSOLE_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JCONSOLE_PKGS))
ohair@478 1049 $(prep-target)
ohair@478 1050 $(call PackageFilter,$(JCONSOLE_PKGS))
ohair@478 1051
ohair@478 1052 #############################################################
ohair@478 1053 #
ohair@478 1054 # treeapidocs
ohair@478 1055 #
ohair@478 1056
ohair@478 1057 ALL_OTHER_TARGETS += treeapidocs
ohair@478 1058
ihse@839 1059 TREEAPI_DOCDIR := $(JDK_API_DOCSDIR)/javac/tree
ihse@839 1060 TREEAPI2COREAPI := ../../$(JDKJRE2COREAPI)
ihse@839 1061 TREEAPI_DOCTITLE := Compiler Tree API
ihse@839 1062 TREEAPI_WINDOWTITLE := Compiler Tree API
ihse@839 1063 TREEAPI_HEADER := <strong>Compiler Tree API</strong>
ihse@839 1064 TREEAPI_BOTTOM := $(call CommonBottom,$(TREEAPI_FIRST_COPYRIGHT_YEAR))
ihse@839 1065 TREEAPI_GROUPNAME := Packages
ihse@839 1066 TREEAPI_REGEXP := com.sun.source.*
ohair@478 1067 # TREEAPI_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 1068
ihse@839 1069 TREEAPI_INDEX_HTML = $(TREEAPI_DOCDIR)/index.html
ihse@839 1070 TREEAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options
ohair@478 1071 TREEAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages
ohair@478 1072
ohair@478 1073 treeapidocs: $(TREEAPI_INDEX_HTML)
ohair@478 1074
ohair@478 1075 # Set relative location to core api document root
ohair@478 1076 $(TREEAPI_INDEX_HTML): GET2DOCSDIR=$(TREEAPI2COREAPI)/..
ohair@478 1077
ohair@478 1078 # Run javadoc if the index file is out of date or missing
erikj@518 1079 $(TREEAPI_INDEX_HTML): $(TREEAPI_OPTIONS_FILE) $(TREEAPI_PACKAGES_FILE) coredocs
ohair@478 1080 $(prep-javadoc)
ohair@478 1081 $(call JavadocSummary,$(TREEAPI_OPTIONS_FILE),$(TREEAPI_PACKAGES_FILE))
ohair@478 1082 $(JAVADOC_CMD) -d $(@D) \
ihse@839 1083 @$(TREEAPI_OPTIONS_FILE) @$(TREEAPI_PACKAGES_FILE)
ohair@478 1084
ohair@478 1085 # Create file with javadoc options in it
ohair@478 1086 $(TREEAPI_OPTIONS_FILE):
ohair@478 1087 $(prep-target)
ihse@839 1088 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ihse@839 1089 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ihse@839 1090 $(call OptionPair,-encoding,ascii) ; \
ihse@839 1091 $(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \
ihse@839 1092 $(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ihse@839 1093 $(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \
ihse@839 1094 $(call OptionPair,-tag,$(TAG_JLS)) ; \
ihse@839 1095 $(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 1096 $(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \
ohair@478 1097 $(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
ihse@839 1098 ) >> $@
ohair@478 1099
ohair@478 1100 # Create a file with the package names in it
ohair@478 1101 $(TREEAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TREEAPI_PKGS))
ohair@478 1102 $(prep-target)
ohair@478 1103 $(call PackageFilter,$(TREEAPI_PKGS))
ohair@478 1104
ohair@478 1105 #############################################################
ohair@478 1106 #
sundar@1207 1107 # nashornapidocs
sundar@1207 1108 #
sundar@1207 1109
sundar@1207 1110 ALL_OTHER_TARGETS += nashornapidocs
sundar@1207 1111
sundar@1207 1112 NASHORNAPI_DOCDIR := $(JDK_API_DOCSDIR)/nashorn
sundar@1207 1113 NASHORNAPI2COREAPI := ../$(JDKJRE2COREAPI)
sundar@1207 1114 NASHORNAPI_DOCTITLE := Nashorn API
sundar@1207 1115 NASHORNAPI_WINDOWTITLE := Nashorn API
sundar@1207 1116 NASHORNAPI_HEADER := <strong>Nashorn API</strong>
sundar@1207 1117 NASHORNAPI_BOTTOM := $(call CommonBottom,$(NASHORNAPI_FIRST_COPYRIGHT_YEAR))
sundar@1207 1118 NASHORNAPI_GROUPNAME := Packages
sundar@1214 1119 NASHORNAPI_REGEXP := jdk.nashorn.api.scripting.*
sundar@1214 1120
sundar@1207 1121 # NASHORNAPI_PKGS is located in NON_CORE_PKGS.gmk
sundar@1207 1122
sundar@1207 1123 NASHORNAPI_INDEX_HTML = $(NASHORNAPI_DOCDIR)/index.html
sundar@1214 1124 NASHORNAPI_OPTIONS_FILE = $(DOCSTMPDIR)/nashornapi.options
sundar@1214 1125 NASHORNAPI_PACKAGES_FILE = $(DOCSTMPDIR)/nashornapi.packages
sundar@1207 1126
sundar@1214 1127 nashornapidocs: $(NASHORNAPI_INDEX_HTML)
sundar@1207 1128
sundar@1207 1129 # Set relative location to core api document root
sundar@1207 1130 $(NASHORNAPI_INDEX_HTML): GET2DOCSDIR=$(NASHORNAPI2COREAPI)/..
sundar@1207 1131
sundar@1207 1132 # Run javadoc if the index file is out of date or missing
sundar@1207 1133 $(NASHORNAPI_INDEX_HTML): $(NASHORNAPI_OPTIONS_FILE) $(NASHORNAPI_PACKAGES_FILE) coredocs
sundar@1207 1134 $(prep-javadoc)
sundar@1207 1135 $(call JavadocSummary,$(NASHORNAPI_OPTIONS_FILE),$(NASHORNAPI_PACKAGES_FILE))
sundar@1207 1136 $(JAVADOC_CMD) -d $(@D) \
sundar@1207 1137 @$(NASHORNAPI_OPTIONS_FILE) @$(NASHORNAPI_PACKAGES_FILE)
sundar@1207 1138
sundar@1207 1139 # Create file with javadoc options in it
sundar@1207 1140 $(NASHORNAPI_OPTIONS_FILE):
sundar@1207 1141 $(prep-target)
sundar@1207 1142 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
sundar@1207 1143 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
sundar@1207 1144 $(call OptionPair,-encoding,ascii) ; \
sundar@1207 1145 $(call OptionPair,-doctitle,$(NASHORNAPI_DOCTITLE)) ; \
sundar@1207 1146 $(call OptionPair,-windowtitle,$(NASHORNAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
sundar@1207 1147 $(call OptionPair,-header,$(NASHORNAPI_HEADER)$(DRAFT_HEADER)) ; \
sundar@1207 1148 $(call OptionPair,-tag,$(TAG_JLS)) ; \
sundar@1207 1149 $(call OptionPair,-bottom,$(NASHORNAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
sundar@1207 1150 $(call OptionTrip,-group,$(NASHORNAPI_GROUPNAME),$(NASHORNAPI_REGEXP)); \
sundar@1207 1151 $(call OptionTrip,-linkoffline,$(NASHORNAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
sundar@1207 1152 ) >> $@
sundar@1207 1153
sundar@1207 1154 # Create a file with the package names in it
sundar@1207 1155 $(NASHORNAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(NASHORNAPI_PKGS))
sundar@1207 1156 $(prep-target)
sundar@1207 1157 $(call PackageFilter,$(NASHORNAPI_PKGS))
sundar@1207 1158
sundar@1207 1159 #############################################################
sundar@1207 1160 #
ohair@478 1161 # sctpdocs
ohair@478 1162 #
ohair@478 1163
ohair@478 1164 ALL_OTHER_TARGETS += sctpdocs
ohair@478 1165
ihse@839 1166 SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec
ihse@839 1167 SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
ihse@839 1168 SCTPAPI_DOCTITLE := SCTP API
ohair@478 1169 SCTPAPI_WINDOWTITLE := SCTP API
ihse@839 1170 SCTPAPI_HEADER := <strong>SCTP API</strong>
ihse@839 1171 SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR))
ohair@478 1172 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 1173
ihse@839 1174 SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html
ihse@839 1175 SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options
ohair@478 1176 SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages
ohair@478 1177
ohair@478 1178 sctpdocs: $(SCTPAPI_INDEX_HTML)
ohair@478 1179
ohair@478 1180 # Set relative location to core api document root
ohair@478 1181 $(SCTPAPI_INDEX_HTML): GET2DOCSDIR=$(SCTPAPI2COREAPI)/..
ohair@478 1182
ohair@478 1183 # Run javadoc if the index file is out of date or missing
erikj@518 1184 $(SCTPAPI_INDEX_HTML): $(SCTPAPI_OPTIONS_FILE) $(SCTPAPI_PACKAGES_FILE) coredocs
ohair@478 1185 $(prep-javadoc)
ohair@478 1186 $(call JavadocSummary,$(SCTPAPI_OPTIONS_FILE),$(SCTPAPI_PACKAGES_FILE))
ohair@478 1187 $(JAVADOC_CMD) -d $(@D) \
ihse@839 1188 @$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE)
ohair@478 1189
ohair@478 1190 # Create file with javadoc options in it
ohair@478 1191 $(SCTPAPI_OPTIONS_FILE):
ohair@478 1192 $(prep-target)
ihse@839 1193 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ihse@839 1194 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ihse@839 1195 $(call OptionPair,-encoding,ascii) ; \
ihse@839 1196 $(call OptionOnly,-nodeprecatedlist) ; \
ihse@839 1197 $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \
ihse@839 1198 $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ihse@839 1199 $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \
ihse@839 1200 $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 1201 $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
ihse@839 1202 ) >> $@
ohair@478 1203
ohair@478 1204 # Create a file with the package names in it
ohair@478 1205 $(SCTPAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SCTPAPI_PKGS))
ohair@478 1206 $(prep-target)
ohair@478 1207 $(call PackageFilter,$(SCTPAPI_PKGS))
ohair@478 1208
ohair@478 1209 #############################################################
ohair@478 1210 #
michaelm@1033 1211 # jdk.net docs
michaelm@1033 1212 #
michaelm@1033 1213
michaelm@1033 1214 ALL_OTHER_TARGETS += jdknetdocs
michaelm@1033 1215
michaelm@1033 1216 JDKNET_DOCDIR := $(JRE_API_DOCSDIR)/net/socketoptions/spec
michaelm@1033 1217 JDKNET2COREAPI := ../../../$(JDKJRE2COREAPI)
michaelm@1033 1218 JDKNET_DOCTITLE := jdk.net API
michaelm@1033 1219 JDKNET_WINDOWTITLE := jdk.net API
michaelm@1033 1220 JDKNET_HEADER := <strong>jdk.net API</strong>
michaelm@1033 1221 JDKNET_BOTTOM := $(call CommonBottom,$(JDKNET_FIRST_COPYRIGHT_YEAR))
michaelm@1033 1222 JDKNET_PKGS := jdk.net
michaelm@1033 1223
michaelm@1033 1224 JDKNET_INDEX_HTML = $(JDKNET_DOCDIR)/index.html
michaelm@1033 1225 JDKNET_OPTIONS_FILE = $(DOCSTMPDIR)/jdknet.options
michaelm@1033 1226 JDKNET_PACKAGES_FILE = $(DOCSTMPDIR)/jdknet.packages
michaelm@1033 1227
michaelm@1033 1228 jdknetdocs: $(JDKNET_INDEX_HTML)
michaelm@1033 1229
michaelm@1033 1230 # Set relative location to core api document root
michaelm@1033 1231 $(JDKNET_INDEX_HTML): GET2DOCSDIR=$(JDKNET2COREAPI)/..
michaelm@1033 1232
michaelm@1033 1233 # Run javadoc if the index file is out of date or missing
michaelm@1033 1234 $(JDKNET_INDEX_HTML): $(JDKNET_OPTIONS_FILE) $(JDKNET_PACKAGES_FILE) coredocs
michaelm@1033 1235 $(prep-javadoc)
michaelm@1033 1236 $(call JavadocSummary,$(JDKNET_OPTIONS_FILE),$(JDKNET_PACKAGES_FILE))
michaelm@1033 1237 $(JAVADOC_CMD) -d $(@D) \
michaelm@1033 1238 @$(JDKNET_OPTIONS_FILE) @$(JDKNET_PACKAGES_FILE)
michaelm@1033 1239
michaelm@1033 1240 # Create file with javadoc options in it
michaelm@1033 1241 $(JDKNET_OPTIONS_FILE):
michaelm@1033 1242 $(prep-target)
michaelm@1033 1243 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
michaelm@1033 1244 $(call OptionOnly,-Xdoclint:none) ; \
michaelm@1033 1245 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
michaelm@1033 1246 $(call OptionPair,-encoding,ascii) ; \
michaelm@1033 1247 $(call OptionOnly,-nodeprecatedlist) ; \
michaelm@1033 1248 $(call OptionPair,-doctitle,$(JDKNET_DOCTITLE)) ; \
michaelm@1033 1249 $(call OptionPair,-windowtitle,$(JDKNET_WINDOWTITLE) $(DRAFT_WINTITLE)); \
michaelm@1033 1250 $(call OptionPair,-header,$(JDKNET_HEADER)$(DRAFT_HEADER)); \
michaelm@1033 1251 $(call OptionPair,-bottom,$(JDKNET_BOTTOM)$(DRAFT_BOTTOM)); \
michaelm@1033 1252 $(call OptionTrip,-linkoffline,$(JDKNET2COREAPI),$(COREAPI_DOCSDIR)/); \
michaelm@1033 1253 ) >> $@
michaelm@1033 1254
michaelm@1033 1255 # Create a file with the package names in it
michaelm@1033 1256 $(JDKNET_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JDKNET_PKGS))
michaelm@1033 1257 $(prep-target)
michaelm@1033 1258 $(call PackageFilter,$(JDKNET_PKGS))
michaelm@1033 1259
michaelm@1033 1260 #############################################################
michaelm@1033 1261 #
ohair@478 1262 # Get a cache of all the directories
ohair@478 1263
ohair@478 1264 $(DIRECTORY_CACHE): $(ALL_EXISTING_SOURCE_DIRS)
ohair@478 1265 $(prep-target)
ihse@839 1266 @for cp in $(ALL_EXISTING_SOURCE_DIRS) ; do \
ihse@839 1267 $(ECHO) "$(FIND) $${cp} -type f >> $@"; \
ihse@839 1268 $(FIND) $${cp} -type f >> $@; \
ohair@478 1269 done
ohair@478 1270
ohair@478 1271 #############################################################
ohair@478 1272 #release version of core packages ########
ihse@912 1273
ihse@912 1274 # The rel-coredocs and rel-docs targets were added by Eric Armstrong. rel-coredocs
ihse@912 1275 # assumes the kind of large, 32-bit machine used in the javapubs group's docs-release
ihse@912 1276 # process. It specifies memory settings accordingly to maximize performance.
ihse@912 1277 #
ihse@912 1278 # The performance settings, like the sanity check, are most important for the core
ihse@912 1279 # docs--the platform APIs. Running javadoc on those APIs takes a significant amount
ihse@912 1280 # of time and memory. Setting the initial heap size as large as possible is important
ihse@912 1281 # to prevent thrashing as the heap grows. Setting the maximum as large as necessary
ihse@912 1282 # is also important to keep the job from failing.
ihse@912 1283 #
ihse@912 1284 # -J-Xmx512 sets a maximum of 512, which became necessary in 6.0
ihse@912 1285 # -J-Xms256 sets starting size to 256 (default is 8)
ihse@912 1286 #
ihse@912 1287 # rel-coredocs also includes a sanity check to help ensure that BUILD_NUMBER and
ihse@912 1288 # MILESTONE are specified properly when docs are built outside of the normal release
ihse@912 1289 # engineering process, with the intention of releasing them on the web or in a downloaded
ihse@912 1290 # docs bundle. (When invoked in release engineering's control build, the values are always
ihse@912 1291 # set properly. But when the targets are run by themselves, they default to b00 and
ihse@912 1292 # "internal"--which silently sabotage the result of a build that can take many hours
ihse@912 1293 # to complete.
ihse@912 1294
ohair@478 1295 # Maximize performance and ensure that build number & milestone are set.
ohair@478 1296
ohair@478 1297 rel-coredocs: sanitycheckcoredocs
ohair@478 1298 $(MAKE) coredocs
ohair@478 1299
ohair@478 1300 rel-docs: rel-coredocs $(ALL_OTHER_TARGETS)
ohair@478 1301 #
ohair@478 1302 # end of production targets
ohair@478 1303
ohair@478 1304 otherdocs: $(ALL_OTHER_TARGETS)
ohair@478 1305
ohair@478 1306 clean:
ohair@478 1307 $(RM) -r $(DOCSDIR) $(DOCSTMPDIR)
ohair@478 1308
ohair@478 1309 #############################################################
ohair@478 1310 # DEBUG TARGET
ohair@478 1311 # List the values defined in the makefile hierarchy, to make sure everything
ohair@478 1312 # is set properly, and to help identify values we can use instead of making new ones.
ohair@478 1313 # (Most of them come from common/shared/Defs.gmk)
ohair@478 1314 #
ihse@839 1315 # Notes:
ihse@839 1316 # * BUILD_NUMBER defaults to b00 if not set on command line with BUILD_NUMBER=<value>
ihse@839 1317 # * MILESTONE defaults to internal unless set to beta, rc, or fcs on command line
ohair@478 1318 #
ohair@478 1319
ohair@478 1320 #############################################################
ohair@478 1321 .PHONY: all docs coredocs rel-docs otherdocs rel-coredocs \
ihse@839 1322 sanitycheckcoredocs $(ALL_OTHER_TARGETS)

mercurial