make/Javadoc.gmk

Thu, 12 Oct 2017 19:39:08 +0800

author
aoqi
date
Thu, 12 Oct 2017 19:39:08 +0800
changeset 1288
7801df19942d
parent 1216
d8a715bb7aad
parent 1133
50aaf272884f
child 1482
8fb429038513
permissions
-rw-r--r--

merge

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

mercurial