annotate common/makefiles/javadoc/Javadoc.gmk @ 13697:5262b00bc10c

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