common/makefiles/javadoc/Javadoc.gmk

Mon, 17 Dec 2012 08:34:02 -0800

author
jjg
date
Mon, 17 Dec 2012 08:34:02 -0800
changeset 547
a0779b1e9a4d
parent 518
6ff2e1280dc3
child 558
d5f3a6f60d51
child 592
1129fb75f611
permissions
-rw-r--r--

8005090: Include com.sun.source.doctree in Tree API docs
Reviewed-by: erikj

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

mercurial