make/Javadoc.gmk

Thu, 14 Nov 2013 10:53:23 +0100

author
ihse
date
Thu, 14 Nov 2013 10:53:23 +0100
changeset 912
a667caba1e84
parent 841
common/makefiles/javadoc/Javadoc.gmk@547316ea137d
child 1033
4900092f003c
permissions
-rw-r--r--

8027566: Remove the old build system
Reviewed-by: erikj, tbell

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

mercurial