make/Javadoc.gmk

Tue, 06 May 2014 11:43:14 +0200

author
erikj
date
Tue, 06 May 2014 11:43:14 +0200
changeset 1039
389603b4000d
parent 1033
4900092f003c
child 1133
50aaf272884f
child 1196
196ee1e3add0
permissions
-rw-r--r--

8042348: Copyright link in Javadoc page for Java SE 8
Reviewed-by: tbell, iris

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

mercurial