make/Javadoc.gmk

Thu, 31 Aug 2017 15:40:18 +0800

author
aoqi
date
Thu, 31 Aug 2017 15:40:18 +0800
changeset 1133
50aaf272884f
parent 1039
389603b4000d
parent 0
75a576e87639
child 1288
7801df19942d
permissions
-rw-r--r--

merge

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

mercurial