common/makefiles/javadoc/Javadoc.gmk

Thu, 10 Jan 2013 19:36:13 -0800

author
jjg
date
Thu, 10 Jan 2013 19:36:13 -0800
changeset 592
1129fb75f611
parent 518
6ff2e1280dc3
child 594
2e12a508d7ae
permissions
-rw-r--r--

8004834: Add doclint support into javadoc
Reviewed-by: erikj, tbell

jjg@592 1 # Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
ohair@478 2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@478 3 #
ohair@478 4 # This code is free software; you can redistribute it and/or modify it
ohair@478 5 # under the terms of the GNU General Public License version 2 only, as
ohair@478 6 # published by the Free Software Foundation. Oracle designates this
ohair@478 7 # particular file as subject to the "Classpath" exception as provided
ohair@478 8 # by Oracle in the LICENSE file that accompanied this code.
ohair@478 9 #
ohair@478 10 # This code is distributed in the hope that it will be useful, but WITHOUT
ohair@478 11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@478 12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@478 13 # version 2 for more details (a copy is included in the LICENSE file that
ohair@478 14 # accompanied this code).
ohair@478 15 #
ohair@478 16 # You should have received a copy of the GNU General Public License version
ohair@478 17 # 2 along with this work; if not, write to the Free Software Foundation,
ohair@478 18 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@478 19 #
ohair@478 20 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@478 21 # or visit www.oracle.com if you need additional information or have any
ohair@478 22 # questions.
ohair@478 23 #
ohair@478 24
ohair@478 25 include $(SPEC)
ohair@478 26 include MakeBase.gmk
ohair@478 27
ohair@478 28 .SUFFIXES: # Delete the default suffixes
ohair@478 29 .SUFFIXES: .java
ohair@478 30
ohair@478 31 #
ohair@478 32 # Definitions for $(DOCSDIR), $(MKDIR), $(BINDIR), etc.
ohair@478 33 #
ohair@478 34
ohair@478 35 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 \
jjg@592 274 -Xdoclint:none \
ohair@478 275 $(ADDITIONAL_JAVADOCFLAGS)
ohair@478 276
ohair@478 277 ifdef OPENJDK
ohair@478 278 ADDITIONAL_JAVADOCFLAGS = \
ohair@478 279 -Xdocrootparent $(DOCS_BASE_URL)
ohair@478 280 else
ohair@478 281 ADDITIONAL_JAVADOCFLAGS =
ohair@478 282 endif
ohair@478 283
ohair@478 284 # Draft used for non-fcs documents
ohair@478 285 DRAFT_HEADER =
ohair@478 286 ifneq ($(MILESTONE), fcs)
ohair@478 287 DRAFT_HEADER = <br><strong>DRAFT&nbsp;$(MILESTONE)-$(BUILD_NUMBER)</strong>
ohair@478 288 DRAFT_BOTTOM = <br><strong>DRAFT&nbsp;$(MILESTONE)-$(BUILD_NUMBER)</strong>
ohair@478 289 DRAFT_WINTITLE = $(BUILD_NUMBER)
ohair@478 290 # Early access top text (not used in FCS releases)
ohair@478 291 COREAPI_TOP_EARLYACCESS = \
ohair@478 292 <div style="background-color: \#EEEEEE"> \
ohair@478 293 <div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; \
ohair@478 294 margin-left: 6px; margin-right: 6px; text-align: justify; \
ohair@478 295 font-size: 80%; font-family: Helvetica, Arial, sans-serif; \
ohair@478 296 font-weight: normal;"> \
ohair@478 297 Please note that the specifications and other information \
ohair@478 298 contained herein are not final and are subject to change. \
ohair@478 299 The information is being made available to you solely for purpose of \
ohair@478 300 evaluation. \
ohair@478 301 </div> </div>
ohair@478 302 endif
ohair@478 303
ohair@478 304 #################################################################
ohair@478 305
ohair@478 306 #
ohair@478 307 # CORE_PKGS environment variable has been moved to the following file
ohair@478 308 #
ohair@478 309 include CORE_PKGS.gmk
ohair@478 310
ohair@478 311 #
ohair@478 312 # Load environment variables for API package names that are not part of
ohair@478 313 # the Java SE platform
ohair@478 314 #
ohair@478 315 include NON_CORE_PKGS.gmk
ohair@478 316
ohair@478 317 #################################################################
ohair@478 318
ohair@478 319 #
ohair@478 320 # Default target is same as docs target, create core api and all others it can
ohair@478 321 #
ohair@478 322
ohair@478 323 all: docs
ohair@478 324 docs: coredocs otherdocs
ohair@478 325
ohair@478 326 #################################################################
ohair@478 327 # Production Targets -- USE THESE TARGETS WHEN:
ohair@478 328 # a) You're generating docs outside of release engineering's
ohair@478 329 # standard control build.
ohair@478 330 # b) The docs will be pushed to the web and/or included in
ohair@478 331 # the downloaded doc bundle.
ohair@478 332 #
ohair@478 333 # See: Notes.html#releaseTargets
ohair@478 334 # Note: Spaces precede ifdef/ifndef indents. Tabs precede target commands (!)
ohair@478 335 #
ohair@478 336
ohair@478 337 sanitycheckcoredocs:
ohair@478 338 @$(ECHO) ""
ohair@478 339 @$(ECHO) "Building core api docs with these values:"
ohair@478 340 @$(ECHO) " BUILD_NUMBER = $(BUILD_NUMBER)"
ohair@478 341 @$(ECHO) " MILESTONE = $(MILESTONE)"
ohair@478 342 @$(ECHO) ""
ohair@478 343 ifeq ($(BUILD_NUMBER), b00)
ohair@478 344 @$(ECHO) "ERROR: Build number must be defined"
ohair@478 345 @$(ECHO) "MILESTONE is set to $(MILESTONE)"
ohair@478 346 @$(ECHO) ""
ohair@478 347 exit 1
ohair@478 348 endif
ohair@478 349
ohair@478 350 #############################################################
ohair@478 351 #
ohair@478 352 # coredocs
ohair@478 353 #
ohair@478 354 COREAPI_DOCTITLE = Java$(TRADEMARK) Platform, Standard Edition \
ohair@478 355 $(JDK_MINOR_VERSION)<br>API Specification
ohair@478 356 COREAPI_WINDOWTITLE = Java Platform SE $(JDK_MINOR_VERSION)
ohair@478 357 COREAPI_HEADER = \
ohair@478 358 <strong>Java$(TRADEMARK)&nbsp;Platform<br>Standard&nbsp;Ed.&nbsp;$(JDK_MINOR_VERSION)</strong>
ohair@478 359
ohair@478 360 # Java language specification cite
ohair@478 361 TAG_JLS = jls:a:See <cite> \
ohair@478 362 The Java&trade; Language Specification</cite>:
ohair@478 363
ohair@478 364 # Overview file for core apis
ohair@478 365 COREAPI_OVERVIEW = $(JDK_SHARE_CLASSES)/overview-core.html
ohair@478 366
ohair@478 367 # The index.html, options, and packages files
ohair@478 368 COREAPI_INDEX_FILE = $(COREAPI_DOCSDIR)/index.html
ohair@478 369 COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options
ohair@478 370 COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages
ohair@478 371
ohair@478 372 coredocs: $(COREAPI_INDEX_FILE)
ohair@478 373
ohair@478 374 # Set relative location to core api document root
ohair@478 375 $(COREAPI_INDEX_FILE): GET2DOCSDIR=..
ohair@478 376
ohair@478 377 # Run javadoc if the index file is out of date or missing
ohair@478 378 $(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE)
ohair@478 379 $(prep-javadoc)
ohair@478 380 $(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE))
ohair@478 381 $(JAVADOC_CMD) -d $(@D) \
ohair@478 382 @$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE)
ohair@478 383
ohair@478 384 # Create file with javadoc options in it
ohair@478 385 $(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW)
ohair@478 386 $(prep-target)
ohair@478 387 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ohair@478 388 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ohair@478 389 $(call OptionPair,-encoding,ISO-8859-1) ; \
ohair@478 390 $(call OptionPair,-tag,beaninfo:X) ; \
ohair@478 391 $(call OptionPair,-tag,revised:X) ; \
ohair@478 392 $(call OptionPair,-tag,since.unbundled:X) ; \
ohair@478 393 $(call OptionPair,-tag,spec:X) ; \
ohair@478 394 $(call OptionPair,-tag,specdefault:X) ; \
ohair@478 395 $(call OptionPair,-tag,Note:X) ; \
ohair@478 396 $(call OptionPair,-tag,ToDo:X) ; \
ohair@478 397 $(call OptionPair,-tag,$(TAG_JLS)) ; \
ohair@478 398 $(call OptionOnly,-splitIndex) ; \
ohair@478 399 $(call OptionPair,-overview,$(COREAPI_OVERVIEW)) ; \
ohair@478 400 $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE)) ; \
ohair@478 401 $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ;\
ohair@478 402 $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER)) ; \
ohair@478 403 $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 404 ) >> $@
ohair@478 405 ifdef COREAPI_TOP_EARLYACCESS
ohair@478 406 @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@
ohair@478 407 endif
ohair@478 408
ohair@478 409 # Create a file with the package names in it
ohair@478 410 $(COREAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(CORE_PKGS))
ohair@478 411 $(prep-target)
ohair@478 412 $(call PackageFilter,$(CORE_PKGS))
ohair@478 413
ohair@478 414 #############################################################
ohair@478 415 #
ohair@478 416 # docletapidocs
ohair@478 417 #
ohair@478 418
ohair@478 419 ALL_OTHER_TARGETS += docletapidocs
ohair@478 420
ohair@478 421 DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet
ohair@478 422 DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
ohair@478 423 DOCLETAPI_DOCTITLE := Doclet API
ohair@478 424 DOCLETAPI_WINDOWTITLE := Doclet API
ohair@478 425 DOCLETAPI_HEADER := <strong>Doclet API</strong>
ohair@478 426 DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
ohair@478 427 DOCLETAPI_GROUPNAME := Packages
ohair@478 428 DOCLETAPI_REGEXP := com.sun.javadoc
ohair@478 429 # DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 430
ohair@478 431 # The index.html, options, and packages files
ohair@478 432 DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html
ohair@478 433 DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options
ohair@478 434 DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages
ohair@478 435
ohair@478 436 docletapidocs: $(DOCLETAPI_INDEX_FILE)
ohair@478 437
ohair@478 438 # Set relative location to core api document root
ohair@478 439 $(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/..
ohair@478 440
ohair@478 441 # Run javadoc if the index file is out of date or missing
erikj@518 442 $(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) coredocs
ohair@478 443 $(prep-javadoc)
ohair@478 444 $(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE))
ohair@478 445 $(JAVADOC_CMD) -d $(@D) \
ohair@478 446 @$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE)
ohair@478 447
ohair@478 448 # Create file with javadoc options in it
ohair@478 449 $(DOCLETAPI_OPTIONS_FILE):
ohair@478 450 $(prep-target)
ohair@478 451 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ohair@478 452 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ohair@478 453 $(call OptionPair,-encoding,ascii) ; \
ohair@478 454 $(call OptionOnly,-breakiterator) ; \
ohair@478 455 $(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \
ohair@478 456 $(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\
ohair@478 457 $(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \
ohair@478 458 $(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 459 $(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \
ohair@478 460 $(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
ohair@478 461 ) >> $@
ohair@478 462
ohair@478 463 # Create a file with the package names in it
ohair@478 464 $(DOCLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOCLETAPI_PKGS))
ohair@478 465 $(prep-target)
ohair@478 466 $(call PackageFilter,$(DOCLETAPI_PKGS))
ohair@478 467
ohair@478 468 #############################################################
ohair@478 469 #
ohair@478 470 # tagletapidocs
ohair@478 471 #
ohair@478 472
ohair@478 473 ALL_OTHER_TARGETS += tagletapidocs
ohair@478 474 TAGLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/taglet
ohair@478 475 TAGLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
ohair@478 476 TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR))
ohair@478 477 # TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk
ohair@478 478
ohair@478 479 # Temporary directory (special generation rules)
ohair@478 480 TAGLETAPI_TEMPDIR = $(DOCSTMPDIR)/taglets_temp
ohair@478 481
ohair@478 482 # The index.html, options, and packages files
erikj@518 483 TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/index.html
ohair@478 484 TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options
ohair@478 485 TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages
ohair@478 486
ohair@478 487 tagletapidocs: $(TAGLETAPI_INDEX_FILE)
ohair@478 488
ohair@478 489 # Set relative location to core api document root
ohair@478 490 $(TAGLETAPI_INDEX_FILE): GET2DOCSDIR=$(TAGLETAPI2COREAPI)/..
ohair@478 491
ohair@478 492 # Run javadoc if the index file is out of date or missing
erikj@518 493 $(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) coredocs
ohair@478 494 $(prep-javadoc)
ohair@478 495 $(RM) -r $(TAGLETAPI_TEMPDIR)
ohair@478 496 $(MKDIR) -p $(TAGLETAPI_TEMPDIR)
ohair@478 497 $(call JavadocSummary,$(TAGLETAPI_OPTIONS_FILE),$(TAGLETAPI_PACKAGES_FILE))
ohair@478 498 $(JAVADOC_CMD) -d $(TAGLETAPI_TEMPDIR) \
ohair@478 499 @$(TAGLETAPI_OPTIONS_FILE) @$(TAGLETAPI_PACKAGES_FILE)
ohair@478 500 cp -r $(TAGLETAPI_TEMPDIR)/com $(@D)
ohair@478 501 cp $(TAGLETAPI_TEMPDIR)/stylesheet.css $(@D)
ohair@478 502 $(RM) -r $(TAGLETAPI_TEMPDIR)
ohair@478 503
ohair@478 504 # Create file with javadoc options in it
ohair@478 505 $(TAGLETAPI_OPTIONS_FILE):
ohair@478 506 $(prep-target)
ohair@478 507 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ohair@478 508 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ohair@478 509 $(call OptionPair,-encoding,ascii) ; \
ohair@478 510 $(call OptionOnly,-nonavbar) ; \
ohair@478 511 $(call OptionOnly,-noindex) ; \
ohair@478 512 $(call OptionPair,-bottom,$(TAGLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 513 $(call OptionTrip,-linkoffline,$(TAGLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
ohair@478 514 ) >> $@
ohair@478 515
ohair@478 516 # Create a file with the package names in it
ohair@478 517 $(TAGLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TAGLETAPI_PKGS))
ohair@478 518 $(prep-target)
erikj@518 519 @($(ECHO) "$(JDK_IMPSRC)/$(TAGLETAPI_FILE)" ) > $@
ohair@478 520
ohair@478 521 #############################################################
ohair@478 522 #
ohair@478 523 # domapidocs
ohair@478 524 #
ohair@478 525
ohair@478 526 ALL_OTHER_TARGETS += domapidocs
ohair@478 527
ohair@478 528 DOMAPI_DOCDIR := $(JRE_API_DOCSDIR)/plugin/dom
ohair@478 529 DOMAPI2COREAPI := ../../$(JDKJRE2COREAPI)
ohair@478 530 DOMAPI_DOCTITLE := Common DOM API
ohair@478 531 DOMAPI_WINDOWTITLE := Common DOM API
ohair@478 532 DOMAPI_HEADER := <strong>Common DOM API</strong>
ohair@478 533 DOMAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOMAPI_FIRST_COPYRIGHT_YEAR))
ohair@478 534 DOMAPI_GROUPNAME := Packages
ohair@478 535 DOMAPI_REGEXP := com.sun.java.browser.dom:org.w3c.dom*
ohair@478 536 # DOMAPI_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 537
ohair@478 538 # The index.html, options, and packages files
ohair@478 539 DOMAPI_INDEX_FILE = $(DOMAPI_DOCDIR)/index.html
ohair@478 540 DOMAPI_OPTIONS_FILE = $(DOCSTMPDIR)/domapi.options
ohair@478 541 DOMAPI_PACKAGES_FILE = $(DOCSTMPDIR)/domapi.packages
ohair@478 542
ohair@478 543 domapidocs: $(DOMAPI_INDEX_FILE)
ohair@478 544
ohair@478 545 # Set relative location to core api document root
ohair@478 546 $(DOMAPI_INDEX_FILE): GET2DOCSDIR=$(DOMAPI2COREAPI)/..
ohair@478 547
ohair@478 548 # Run javadoc if the index file is out of date or missing
erikj@518 549 $(DOMAPI_INDEX_FILE): $(DOMAPI_OPTIONS_FILE) $(DOMAPI_PACKAGES_FILE) coredocs
ohair@478 550 $(prep-javadoc)
ohair@478 551 $(call JavadocSummary,$(DOMAPI_OPTIONS_FILE),$(DOMAPI_PACKAGES_FILE))
ohair@478 552 $(JAVADOC_CMD) -d $(@D) \
ohair@478 553 @$(DOMAPI_OPTIONS_FILE) @$(DOMAPI_PACKAGES_FILE)
ohair@478 554
ohair@478 555 # Create file with javadoc options in it
ohair@478 556 $(DOMAPI_OPTIONS_FILE):
ohair@478 557 $(prep-target)
ohair@478 558 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ohair@478 559 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ohair@478 560 $(call OptionPair,-encoding,ascii) ; \
ohair@478 561 $(call OptionOnly,-splitIndex) ; \
ohair@478 562 $(call OptionPair,-doctitle,$(DOMAPI_DOCTITLE)) ; \
ohair@478 563 $(call OptionPair,-windowtitle,$(DOMAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\
ohair@478 564 $(call OptionPair,-header,$(DOMAPI_HEADER)$(DRAFT_HEADER)) ; \
ohair@478 565 $(call OptionPair,-bottom,$(DOMAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 566 $(call OptionTrip,-group,$(DOMAPI_GROUPNAME),$(DOMAPI_REGEXP)); \
ohair@478 567 $(call OptionTrip,-linkoffline,$(DOMAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
ohair@478 568 ) >> $@
ohair@478 569
ohair@478 570 # Create a file with the package names in it
ohair@478 571 $(DOMAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOMAPI_PKGS))
ohair@478 572 $(prep-target)
ohair@478 573 $(call PackageFilter,$(DOMAPI_PKGS))
ohair@478 574
ohair@478 575 #############################################################
ohair@478 576 #
ohair@478 577 # jpdadocs
ohair@478 578 #
ohair@478 579
ohair@478 580 ALL_OTHER_TARGETS += jpdadocs
ohair@478 581
ohair@478 582 jpdadocs: jdidocs jdwpdocs jvmtidocs
ohair@478 583
ohair@478 584 #############################################################
ohair@478 585 #
ohair@478 586 # jdidocs
ohair@478 587 #
ohair@478 588
ohair@478 589 ALL_OTHER_TARGETS += jdidocs
ohair@478 590
ohair@478 591 JDI_DOCDIR := $(JDK_API_DOCSDIR)/jpda/jdi
ohair@478 592 JDI2COREAPI := ../../$(JDKJRE2COREAPI)
ohair@478 593 JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface
ohair@478 594 JDI_WINDOWTITLE := Java Debug Interface
ohair@478 595 JDI_HEADER := <strong>Java Debug Interface</strong>
ohair@478 596 JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR))
ohair@478 597 JDI_OVERVIEW := $(JDK_SHARE_CLASSES)/jdi-overview.html
ohair@478 598 # JDI_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 599
ohair@478 600 # The index.html, options, and packages files
ohair@478 601 JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html
ohair@478 602 JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options
ohair@478 603 JDI_PACKAGES_FILE = $(DOCSTMPDIR)/jdi.packages
ohair@478 604
ohair@478 605 jdidocs: $(JDI_INDEX_FILE)
ohair@478 606
ohair@478 607 # Set relative location to core api document root
ohair@478 608 $(JDI_INDEX_FILE): GET2DOCSDIR=$(JDI2COREAPI)/..
ohair@478 609
ohair@478 610 # Run javadoc if the index file is out of date or missing
erikj@518 611 $(JDI_INDEX_FILE): $(JDI_OPTIONS_FILE) $(JDI_PACKAGES_FILE) coredocs
ohair@478 612 $(prep-javadoc)
ohair@478 613 $(call JavadocSummary,$(JDI_OPTIONS_FILE),$(JDI_PACKAGES_FILE))
ohair@478 614 $(JAVADOC_CMD) -d $(@D) \
ohair@478 615 @$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE)
ohair@478 616
ohair@478 617 # Create file with javadoc options in it
ohair@478 618 $(JDI_OPTIONS_FILE): $(JDI_OVERVIEW)
ohair@478 619 $(prep-target)
ohair@478 620 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ohair@478 621 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ohair@478 622 $(call OptionPair,-encoding,ascii) ; \
ohair@478 623 $(call OptionPair,-overview,$(JDI_OVERVIEW)) ; \
ohair@478 624 $(call OptionPair,-doctitle,$(JDI_DOCTITLE)) ; \
ohair@478 625 $(call OptionPair,-windowtitle,$(JDI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ohair@478 626 $(call OptionPair,-header,$(JDI_HEADER)$(DRAFT_HEADER)) ; \
ohair@478 627 $(call OptionPair,-bottom,$(JDI_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 628 $(call OptionTrip,-linkoffline,$(JDI2COREAPI),$(COREAPI_DOCSDIR)/); \
ohair@478 629 ) >> $@
ohair@478 630
ohair@478 631 # Create a file with the package names in it
ohair@478 632 $(JDI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JDI_PKGS))
ohair@478 633 $(prep-target)
ohair@478 634 $(call PackageFilter,$(JDI_PKGS))
ohair@478 635
ohair@478 636 #############################################################
ohair@478 637 #
ohair@478 638 # jdwpdocs
ohair@478 639 #
ohair@478 640
ohair@478 641 ALL_OTHER_TARGETS += jdwpdocs
ohair@478 642
ohair@478 643 JDWP_DOCDIR = $(PLATFORM_DOCSDIR)/jpda/jdwp
ohair@478 644
ohair@478 645 jdwpdocs: $(JDWP_DOCDIR)/jdwp-protocol.html
ohair@478 646 $(JDWP_DOCDIR)/jdwp-protocol.html : $(JDK_OUTPUTDIR)/gensrc_jdwp_doc/jdwp-protocol.html
ohair@478 647 $(MKDIR) -p $(@D)
ohair@478 648 $(RM) $@
ohair@478 649 $(CP) $< $@
ohair@478 650
ohair@478 651 #############################################################
ohair@478 652 #
ohair@478 653 # jvmtidocs
ohair@478 654 #
ohair@478 655
ohair@478 656 ALL_OTHER_TARGETS += jvmtidocs
ohair@478 657
ohair@478 658 JVMTI_DOCDIR = $(PLATFORM_DOCSDIR)/jvmti
ohair@478 659 JVMTI_HTML = $(HOTSPOT_DIST)/docs/platform/jvmti/jvmti.html
ohair@478 660
ohair@478 661 jvmtidocs: $(JVMTI_DOCDIR)/jvmti.html
ohair@478 662 $(JVMTI_DOCDIR)/jvmti.html:
ohair@478 663 @$(prep-javadoc)
ohair@478 664 @if [ -f $(JVMTI_HTML) ] ; then \
ohair@478 665 $(ECHO) "$(CP) $(JVMTI_HTML) $@"; \
ohair@478 666 $(CP) $(JVMTI_HTML) $@; \
ohair@478 667 else \
ohair@478 668 $(ECHO) "WARNING: Generated file does not exist: $(JVMTI_HTML)"; \
ohair@478 669 fi
ohair@478 670
ohair@478 671 #############################################################
ohair@478 672 #
ohair@478 673 # jaasdocs
ohair@478 674 #
ohair@478 675
ohair@478 676 ALL_OTHER_TARGETS += jaasdocs
ohair@478 677
ohair@478 678 JAAS_DOCDIR := $(JRE_API_DOCSDIR)/security/jaas/spec
ohair@478 679 JAAS2COREAPI := ../../../$(JDKJRE2COREAPI)
ohair@478 680 JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service
ohair@478 681 JAAS_WINDOWTITLE := Java Authentication and Authorization Service
ohair@478 682 JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong>
ohair@478 683 JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR))
ohair@478 684 # JAAS_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 685 JAAS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/auth/jaas-overview.html
ohair@478 686
ohair@478 687 # The index.html, options, and packages files
ohair@478 688 JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html
ohair@478 689 JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options
ohair@478 690 JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages
ohair@478 691
ohair@478 692 jaasdocs: $(JAAS_INDEX_FILE)
ohair@478 693
ohair@478 694 # Set relative location to core api document root
ohair@478 695 $(JAAS_INDEX_FILE): GET2DOCSDIR=$(JAAS2COREAPI)/..
ohair@478 696
ohair@478 697 # Run javadoc if the index file is out of date or missing
erikj@518 698 $(JAAS_INDEX_FILE): $(JAAS_OPTIONS_FILE) $(JAAS_PACKAGES_FILE) coredocs
ohair@478 699 $(prep-javadoc)
ohair@478 700 $(call JavadocSummary,$(JAAS_OPTIONS_FILE),$(JAAS_PACKAGES_FILE))
ohair@478 701 $(JAVADOC_CMD) -d $(@D) \
ohair@478 702 @$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE)
ohair@478 703
ohair@478 704 # Create file with javadoc options in it
ohair@478 705 $(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW)
ohair@478 706 $(prep-target)
ohair@478 707 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ohair@478 708 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ohair@478 709 $(call OptionPair,-encoding,ascii) ; \
ohair@478 710 $(call OptionPair,-overview,$(JAAS_OVERVIEW)) ; \
ohair@478 711 $(call OptionPair,-doctitle,$(JAAS_DOCTITLE)) ; \
ohair@478 712 $(call OptionPair,-windowtitle,$(JAAS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ohair@478 713 $(call OptionPair,-header,$(JAAS_HEADER)$(DRAFT_HEADER)) ; \
ohair@478 714 $(call OptionPair,-bottom,$(JAAS_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 715 $(call OptionTrip,-linkoffline,$(JAAS2COREAPI),$(COREAPI_DOCSDIR)/); \
ohair@478 716 ) >> $@
ohair@478 717
ohair@478 718 # Create a file with the package names in it
ohair@478 719 $(JAAS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JAAS_PKGS))
ohair@478 720 $(prep-target)
ohair@478 721 $(call PackageFilter,$(JAAS_PKGS))
ohair@478 722
ohair@478 723 #############################################################
ohair@478 724 #
ohair@478 725 # jgssdocs
ohair@478 726 #
ohair@478 727
ohair@478 728 ALL_OTHER_TARGETS += jgssdocs
ohair@478 729
ohair@478 730 JGSS_DOCDIR := $(JRE_API_DOCSDIR)/security/jgss/spec
ohair@478 731 JGSS2COREAPI := ../../../$(JDKJRE2COREAPI)
ohair@478 732 JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities
ohair@478 733 JGSS_WINDOWTITLE := Java GSS-API Utilities
ohair@478 734 JGSS_HEADER := <strong>Java GSS-API Utilities</strong>
ohair@478 735 JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR))
ohair@478 736 JGSS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/jgss/jgss-overview.html
ohair@478 737 # JGSS_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 738
ohair@478 739 # The index.html, options, and packages files
ohair@478 740 JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html
ohair@478 741 JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options
ohair@478 742 JGSS_PACKAGES_FILE = $(DOCSTMPDIR)/jgss.packages
ohair@478 743
ohair@478 744 jgssdocs: $(JGSS_INDEX_FILE)
ohair@478 745
ohair@478 746 # Set relative location to core api document root
ohair@478 747 $(JGSS_INDEX_FILE): GET2DOCSDIR=$(JGSS2COREAPI)/..
ohair@478 748
ohair@478 749 # Run javadoc if the index file is out of date or missing
erikj@518 750 $(JGSS_INDEX_FILE): $(JGSS_OPTIONS_FILE) $(JGSS_PACKAGES_FILE) coredocs
ohair@478 751 $(prep-javadoc)
ohair@478 752 $(call JavadocSummary,$(JGSS_OPTIONS_FILE),$(JGSS_PACKAGES_FILE))
ohair@478 753 $(JAVADOC_CMD) -d $(@D) \
ohair@478 754 @$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE)
ohair@478 755
ohair@478 756 # Create file with javadoc options in it
ohair@478 757 $(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW)
ohair@478 758 $(prep-target)
ohair@478 759 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ohair@478 760 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ohair@478 761 $(call OptionPair,-encoding,ascii) ; \
ohair@478 762 $(call OptionOnly,-nodeprecatedlist) ; \
ohair@478 763 $(call OptionPair,-overview,$(JGSS_OVERVIEW)) ; \
ohair@478 764 $(call OptionPair,-doctitle,$(JGSS_DOCTITLE)) ; \
ohair@478 765 $(call OptionPair,-windowtitle,$(JGSS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ohair@478 766 $(call OptionPair,-header,$(JGSS_HEADER)$(DRAFT_HEADER)) ; \
ohair@478 767 $(call OptionPair,-bottom,$(JGSS_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 768 $(call OptionTrip,-linkoffline,$(JGSS2COREAPI),$(COREAPI_DOCSDIR)/); \
ohair@478 769 ) >> $@
ohair@478 770
ohair@478 771 # Create a file with the package names in it
ohair@478 772 $(JGSS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JGSS_PKGS))
ohair@478 773 $(prep-target)
ohair@478 774 $(call PackageFilter,$(JGSS_PKGS))
ohair@478 775
ohair@478 776 #############################################################
ohair@478 777 #
ohair@478 778 # smartcardiodocs
ohair@478 779 #
ohair@478 780
ohair@478 781 ALL_OTHER_TARGETS += smartcardiodocs
ohair@478 782
ohair@478 783 SMARTCARDIO_DOCDIR := $(JRE_API_DOCSDIR)/security/smartcardio/spec
ohair@478 784 SMARTCARDIO2COREAPI := ../../../$(JDKJRE2COREAPI)
ohair@478 785 SMARTCARDIO_DOCTITLE := Java$(TRADEMARK) Smart Card I/O
ohair@478 786 SMARTCARDIO_WINDOWTITLE := Java Smart Card I/O
ohair@478 787 SMARTCARDIO_HEADER := <strong>Java Smart Card I/O</strong>
ohair@478 788 SMARTCARDIO_BOTTOM := $(call CommonBottom,$(SMARTCARDIO_FIRST_COPYRIGHT_YEAR))
ohair@478 789 # SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 790
ohair@478 791 # The index.html, options, and packages files
ohair@478 792 SMARTCARDIO_INDEX_FILE = $(SMARTCARDIO_DOCDIR)/index.html
ohair@478 793 SMARTCARDIO_OPTIONS_FILE = $(DOCSTMPDIR)/smartcardio.options
ohair@478 794 SMARTCARDIO_PACKAGES_FILE = $(DOCSTMPDIR)/smartcardio.packages
ohair@478 795
ohair@478 796 smartcardiodocs: $(SMARTCARDIO_INDEX_FILE)
ohair@478 797
ohair@478 798 # Set relative location to core api document root
ohair@478 799 $(SMARTCARDIO_INDEX_FILE): GET2DOCSDIR=$(SMARTCARDIO2COREAPI)/..
ohair@478 800
ohair@478 801 # Run javadoc if the index file is out of date or missing
erikj@518 802 $(SMARTCARDIO_INDEX_FILE): $(SMARTCARDIO_OPTIONS_FILE) $(SMARTCARDIO_PACKAGES_FILE) coredocs
ohair@478 803 $(prep-javadoc)
ohair@478 804 $(call JavadocSummary,$(SMARTCARDIO_OPTIONS_FILE),$(SMARTCARDIO_PACKAGES_FILE))
ohair@478 805 $(JAVADOC_CMD) -d $(@D) \
ohair@478 806 @$(SMARTCARDIO_OPTIONS_FILE) @$(SMARTCARDIO_PACKAGES_FILE)
ohair@478 807
ohair@478 808 # Create file with javadoc options in it
ohair@478 809 $(SMARTCARDIO_OPTIONS_FILE):
ohair@478 810 $(prep-target)
ohair@478 811 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ohair@478 812 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ohair@478 813 $(call OptionPair,-encoding,ascii) ; \
ohair@478 814 $(call OptionOnly,-nodeprecatedlist) ; \
ohair@478 815 $(call OptionPair,-doctitle,$(SMARTCARDIO_DOCTITLE)) ; \
ohair@478 816 $(call OptionPair,-windowtitle,$(SMARTCARDIO_WINDOWTITLE) $(DRAFT_WINTITLE));\
ohair@478 817 $(call OptionPair,-header,$(SMARTCARDIO_HEADER)$(DRAFT_HEADER)); \
ohair@478 818 $(call OptionPair,-bottom,$(SMARTCARDIO_BOTTOM)$(DRAFT_BOTTOM)); \
ohair@478 819 $(call OptionTrip,-linkoffline,$(SMARTCARDIO2COREAPI),$(COREAPI_DOCSDIR)/); \
ohair@478 820 ) >> $@
ohair@478 821
ohair@478 822 # Create a file with the package names in it
ohair@478 823 $(SMARTCARDIO_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SMARTCARDIO_PKGS))
ohair@478 824 $(prep-target)
ohair@478 825 $(call PackageFilter,$(SMARTCARDIO_PKGS))
ohair@478 826
ohair@478 827 #############################################################
ohair@478 828 #
ohair@478 829 # httpserverdocs
ohair@478 830 #
ohair@478 831
ohair@478 832 ALL_OTHER_TARGETS += httpserverdocs
ohair@478 833
ohair@478 834 HTTPSERVER_DOCDIR := $(JRE_API_DOCSDIR)/net/httpserver/spec
ohair@478 835 HTTPSERVER2COREAPI := ../../../$(JDKJRE2COREAPI)
ohair@478 836 HTTPSERVER_DOCTITLE := Java$(TRADEMARK) HTTP Server
ohair@478 837 HTTPSERVER_WINDOWTITLE := Java HTTP Server
ohair@478 838 HTTPSERVER_HEADER := <strong>Java HTTP Server</strong>
ohair@478 839 HTTPSERVER_BOTTOM := $(call CommonBottom,$(HTTPSERVER_FIRST_COPYRIGHT_YEAR))
ohair@478 840 # HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 841
ohair@478 842 HTTPSERVER_INDEX_HTML = $(HTTPSERVER_DOCDIR)/index.html
ohair@478 843 HTTPSERVER_OPTIONS_FILE = $(DOCSTMPDIR)/httpserver.options
ohair@478 844 HTTPSERVER_PACKAGES_FILE = $(DOCSTMPDIR)/httpserver.packages
ohair@478 845
ohair@478 846 httpserverdocs: $(HTTPSERVER_INDEX_HTML)
ohair@478 847
ohair@478 848 # Set relative location to core api document root
ohair@478 849 $(HTTPSERVER_INDEX_HTML): GET2DOCSDIR=$(HTTPSERVER2COREAPI)/..
ohair@478 850
ohair@478 851 # Run javadoc if the index file is out of date or missing
erikj@518 852 $(HTTPSERVER_INDEX_HTML): $(HTTPSERVER_OPTIONS_FILE) $(HTTPSERVER_PACKAGES_FILE) coredocs
ohair@478 853 $(prep-javadoc)
ohair@478 854 $(call JavadocSummary,$(HTTPSERVER_OPTIONS_FILE),$(HTTPSERVER_PACKAGES_FILE))
ohair@478 855 $(JAVADOC_CMD) -d $(@D) \
ohair@478 856 @$(HTTPSERVER_OPTIONS_FILE) @$(HTTPSERVER_PACKAGES_FILE)
ohair@478 857
ohair@478 858 # Create file with javadoc options in it
ohair@478 859 $(HTTPSERVER_OPTIONS_FILE):
ohair@478 860 $(prep-target)
ohair@478 861 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ohair@478 862 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ohair@478 863 $(call OptionPair,-encoding,ascii) ; \
ohair@478 864 $(call OptionOnly,-nodeprecatedlist) ; \
ohair@478 865 $(call OptionPair,-doctitle,$(HTTPSERVER_DOCTITLE)) ; \
ohair@478 866 $(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE));\
ohair@478 867 $(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \
ohair@478 868 $(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \
ohair@478 869 $(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \
ohair@478 870 ) >> $@
ohair@478 871
ohair@478 872 # Create a file with the package names in it
ohair@478 873 $(HTTPSERVER_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(HTTPSERVER_PKGS))
ohair@478 874 $(prep-target)
ohair@478 875 $(call PackageFilter,$(HTTPSERVER_PKGS))
ohair@478 876
ohair@478 877 #############################################################
ohair@478 878 #
ohair@478 879 # mgmtdocs
ohair@478 880 #
ohair@478 881
ohair@478 882 ALL_OTHER_TARGETS += mgmtdocs
ohair@478 883
ohair@478 884 MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension
ohair@478 885 MGMT2COREAPI := ../../$(JDKJRE2COREAPI)
ohair@478 886 JVM_MIB_NAME := JVM-MANAGEMENT-MIB.mib
erikj@518 887 JVM_MIB_SRC := $(JDK_TOPDIR)/src/closed/share/classes/sun/management/snmp/$(JVM_MIB_NAME)
ohair@478 888 MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform
ohair@478 889 MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform
ohair@478 890 MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong>
ohair@478 891 MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR))
ohair@478 892 MGMT_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/management/mgmt-overview.html
ohair@478 893 # MGMT_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 894
ohair@478 895 # The index.html, options, and packages files
ohair@478 896 MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html
ohair@478 897 MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options
ohair@478 898 MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages
ohair@478 899
ohair@478 900 mgmtdocs: $(MGMT_INDEX_FILE)
ohair@478 901
ohair@478 902 # Set relative location to core api document root
ohair@478 903 $(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/..
ohair@478 904
ohair@478 905 # Run javadoc if the index file is out of date or missing
erikj@518 906 $(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) coredocs
ohair@478 907 $(prep-javadoc)
ohair@478 908 @if [ -f $(JVM_MIB_SRC) ] ; then \
ohair@478 909 $(ECHO) "$(CP) $(JVM_MIB_SRC) $(@D)/.."; \
ohair@478 910 $(CP) $(JVM_MIB_SRC) $(@D)/.. ; \
ohair@478 911 else \
ohair@478 912 $(ECHO) "WARNING: File $(JVM_MIB_NAME) not available."; \
ohair@478 913 fi
ohair@478 914 $(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE))
ohair@478 915 $(JAVADOC_CMD) -d $(@D) \
ohair@478 916 @$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE)
ohair@478 917
ohair@478 918 # Create file with javadoc options in it
ohair@478 919 $(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW)
ohair@478 920 $(prep-target)
ohair@478 921 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ohair@478 922 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ohair@478 923 $(call OptionPair,-encoding,ascii) ; \
ohair@478 924 $(call OptionOnly,-nodeprecatedlist) ; \
ohair@478 925 $(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \
ohair@478 926 $(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \
ohair@478 927 $(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ohair@478 928 $(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \
ohair@478 929 $(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 930 $(call OptionTrip,-linkoffline,$(MGMT2COREAPI),$(COREAPI_DOCSDIR)/); \
ohair@478 931 ) >> $@
ohair@478 932
ohair@478 933 # Create a file with the package names in it
ohair@478 934 $(MGMT_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(MGMT_PKGS))
ohair@478 935 $(prep-target)
ohair@478 936 $(call PackageFilter,$(MGMT_PKGS))
ohair@478 937
ohair@478 938 #############################################################
ohair@478 939 #
ohair@478 940 # attachdocs
ohair@478 941 #
ohair@478 942
ohair@478 943 ALL_OTHER_TARGETS += attachdocs
ohair@478 944
ohair@478 945 ATTACH_DOCDIR := $(JDK_API_DOCSDIR)/attach/spec
ohair@478 946 ATTACH2COREAPI := ../../$(JDKJRE2COREAPI)
ohair@478 947 ATTACH_DOCTITLE := Attach API
ohair@478 948 ATTACH_WINDOWTITLE := Attach API
ohair@478 949 ATTACH_HEADER := <strong>Attach API</strong>
ohair@478 950 ATTACH_BOTTOM := $(call CommonBottom,$(ATTACH_FIRST_COPYRIGHT_YEAR))
ohair@478 951 # ATTACH_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 952
ohair@478 953 ATTACH_INDEX_HTML = $(ATTACH_DOCDIR)/index.html
ohair@478 954 ATTACH_OPTIONS_FILE = $(DOCSTMPDIR)/attach.options
ohair@478 955 ATTACH_PACKAGES_FILE = $(DOCSTMPDIR)/attach.packages
ohair@478 956
ohair@478 957 attachdocs: $(ATTACH_INDEX_HTML)
ohair@478 958
ohair@478 959 # Set relative location to core api document root
ohair@478 960 $(ATTACH_INDEX_HTML): GET2DOCSDIR=$(ATTACH2COREAPI)/..
ohair@478 961
ohair@478 962 # Run javadoc if the index file is out of date or missing
erikj@518 963 $(ATTACH_INDEX_HTML): $(ATTACH_OPTIONS_FILE) $(ATTACH_PACKAGES_FILE) coredocs
ohair@478 964 $(prep-javadoc)
ohair@478 965 $(call JavadocSummary,$(ATTACH_OPTIONS_FILE),$(ATTACH_PACKAGES_FILE))
ohair@478 966 $(JAVADOC_CMD) -d $(@D) \
ohair@478 967 @$(ATTACH_OPTIONS_FILE) @$(ATTACH_PACKAGES_FILE)
ohair@478 968
ohair@478 969 # Create file with javadoc options in it
ohair@478 970 $(ATTACH_OPTIONS_FILE):
ohair@478 971 $(prep-target)
ohair@478 972 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ohair@478 973 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ohair@478 974 $(call OptionPair,-encoding,ascii) ; \
ohair@478 975 $(call OptionOnly,-nodeprecatedlist) ; \
ohair@478 976 $(call OptionPair,-doctitle,$(ATTACH_DOCTITLE)) ; \
ohair@478 977 $(call OptionPair,-windowtitle,$(ATTACH_WINDOWTITLE) $(DRAFT_WINTITLE));\
ohair@478 978 $(call OptionPair,-header,$(ATTACH_HEADER)$(DRAFT_HEADER)) ; \
ohair@478 979 $(call OptionPair,-bottom,$(ATTACH_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 980 $(call OptionTrip,-linkoffline,$(ATTACH2COREAPI),$(COREAPI_DOCSDIR)/); \
ohair@478 981 ) >> $@
ohair@478 982
ohair@478 983 # Create a file with the package names in it
ohair@478 984 $(ATTACH_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(ATTACH_PKGS))
ohair@478 985 $(prep-target)
ohair@478 986 $(call PackageFilter,$(ATTACH_PKGS))
ohair@478 987
ohair@478 988 #############################################################
ohair@478 989 #
ohair@478 990 # jconsoledocs
ohair@478 991 #
ohair@478 992
ohair@478 993 ALL_OTHER_TARGETS += jconsoledocs
ohair@478 994
ohair@478 995 JCONSOLE_DOCDIR := $(JDK_API_DOCSDIR)/jconsole/spec
ohair@478 996 JCONSOLE2COREAPI := ../../$(JDKJRE2COREAPI)
ohair@478 997 JCONSOLE_DOCTITLE := JConsole API
ohair@478 998 JCONSOLE_WINDOWTITLE := JConsole API
ohair@478 999 JCONSOLE_HEADER := <strong>JConsole API</strong>
ohair@478 1000 JCONSOLE_BOTTOM := $(call CommonBottom,$(JCONSOLE_FIRST_COPYRIGHT_YEAR))
ohair@478 1001 # JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 1002
ohair@478 1003 JCONSOLE_INDEX_HTML = $(JCONSOLE_DOCDIR)/index.html
ohair@478 1004 JCONSOLE_OPTIONS_FILE = $(DOCSTMPDIR)/jconsole.options
ohair@478 1005 JCONSOLE_PACKAGES_FILE = $(DOCSTMPDIR)/jconsole.packages
ohair@478 1006
ohair@478 1007 jconsoledocs: $(JCONSOLE_INDEX_HTML)
ohair@478 1008
ohair@478 1009 # Set relative location to core api document root
ohair@478 1010 $(JCONSOLE_INDEX_HTML): GET2DOCSDIR=$(JCONSOLE2COREAPI)/..
ohair@478 1011
ohair@478 1012 # Run javadoc if the index file is out of date or missing
erikj@518 1013 $(JCONSOLE_INDEX_HTML): $(JCONSOLE_OPTIONS_FILE) $(JCONSOLE_PACKAGES_FILE) coredocs
ohair@478 1014 $(prep-javadoc)
ohair@478 1015 $(call JavadocSummary,$(JCONSOLE_OPTIONS_FILE),$(JCONSOLE_PACKAGES_FILE))
ohair@478 1016 $(JAVADOC_CMD) -d $(@D) \
ohair@478 1017 @$(JCONSOLE_OPTIONS_FILE) @$(JCONSOLE_PACKAGES_FILE)
ohair@478 1018
ohair@478 1019 # Create file with javadoc options in it
ohair@478 1020 $(JCONSOLE_OPTIONS_FILE):
ohair@478 1021 $(prep-target)
ohair@478 1022 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ohair@478 1023 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ohair@478 1024 $(call OptionPair,-encoding,ascii) ; \
ohair@478 1025 $(call OptionOnly,-nodeprecatedlist) ; \
ohair@478 1026 $(call OptionPair,-doctitle,$(JCONSOLE_DOCTITLE)) ; \
ohair@478 1027 $(call OptionPair,-windowtitle,$(JCONSOLE_WINDOWTITLE) $(DRAFT_WINTITLE));\
ohair@478 1028 $(call OptionPair,-header,$(JCONSOLE_HEADER)$(DRAFT_HEADER)) ; \
ohair@478 1029 $(call OptionPair,-bottom,$(JCONSOLE_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 1030 $(call OptionTrip,-linkoffline,$(JCONSOLE2COREAPI),$(COREAPI_DOCSDIR)/); \
ohair@478 1031 ) >> $@
ohair@478 1032
ohair@478 1033 # Create a file with the package names in it
ohair@478 1034 $(JCONSOLE_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JCONSOLE_PKGS))
ohair@478 1035 $(prep-target)
ohair@478 1036 $(call PackageFilter,$(JCONSOLE_PKGS))
ohair@478 1037
ohair@478 1038 #############################################################
ohair@478 1039 #
ohair@478 1040 # treeapidocs
ohair@478 1041 #
ohair@478 1042
ohair@478 1043 ALL_OTHER_TARGETS += treeapidocs
ohair@478 1044
ohair@478 1045 TREEAPI_DOCDIR := $(JDK_API_DOCSDIR)/javac/tree
ohair@478 1046 TREEAPI2COREAPI := ../../$(JDKJRE2COREAPI)
ohair@478 1047 TREEAPI_DOCTITLE := Compiler Tree API
ohair@478 1048 TREEAPI_WINDOWTITLE := Compiler Tree API
ohair@478 1049 TREEAPI_HEADER := <strong>Compiler Tree API</strong>
ohair@478 1050 TREEAPI_BOTTOM := $(call CommonBottom,$(TREEAPI_FIRST_COPYRIGHT_YEAR))
ohair@478 1051 TREEAPI_GROUPNAME := Packages
ohair@478 1052 TREEAPI_REGEXP := com.sun.source.*
ohair@478 1053 # TREEAPI_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 1054
ohair@478 1055 TREEAPI_INDEX_HTML = $(TREEAPI_DOCDIR)/index.html
ohair@478 1056 TREEAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options
ohair@478 1057 TREEAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages
ohair@478 1058
ohair@478 1059 treeapidocs: $(TREEAPI_INDEX_HTML)
ohair@478 1060
ohair@478 1061 # Set relative location to core api document root
ohair@478 1062 $(TREEAPI_INDEX_HTML): GET2DOCSDIR=$(TREEAPI2COREAPI)/..
ohair@478 1063
ohair@478 1064 # Run javadoc if the index file is out of date or missing
erikj@518 1065 $(TREEAPI_INDEX_HTML): $(TREEAPI_OPTIONS_FILE) $(TREEAPI_PACKAGES_FILE) coredocs
ohair@478 1066 $(prep-javadoc)
ohair@478 1067 $(call JavadocSummary,$(TREEAPI_OPTIONS_FILE),$(TREEAPI_PACKAGES_FILE))
ohair@478 1068 $(JAVADOC_CMD) -d $(@D) \
ohair@478 1069 @$(TREEAPI_OPTIONS_FILE) @$(TREEAPI_PACKAGES_FILE)
ohair@478 1070
ohair@478 1071 # Create file with javadoc options in it
ohair@478 1072 $(TREEAPI_OPTIONS_FILE):
ohair@478 1073 $(prep-target)
ohair@478 1074 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ohair@478 1075 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ohair@478 1076 $(call OptionPair,-encoding,ascii) ; \
ohair@478 1077 $(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \
ohair@478 1078 $(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\
ohair@478 1079 $(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \
ohair@478 1080 $(call OptionPair,-tag,$(TAG_JLS)) ; \
ohair@478 1081 $(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 1082 $(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \
ohair@478 1083 $(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
ohair@478 1084 ) >> $@
ohair@478 1085
ohair@478 1086 # Create a file with the package names in it
ohair@478 1087 $(TREEAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TREEAPI_PKGS))
ohair@478 1088 $(prep-target)
ohair@478 1089 $(call PackageFilter,$(TREEAPI_PKGS))
ohair@478 1090
ohair@478 1091 #############################################################
ohair@478 1092 #
ohair@478 1093 # sctpdocs
ohair@478 1094 #
ohair@478 1095
ohair@478 1096 ALL_OTHER_TARGETS += sctpdocs
ohair@478 1097
ohair@478 1098 SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec
ohair@478 1099 SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
ohair@478 1100 SCTPAPI_DOCTITLE := SCTP API
ohair@478 1101 SCTPAPI_WINDOWTITLE := SCTP API
ohair@478 1102 SCTPAPI_HEADER := <strong>SCTP API</strong>
ohair@478 1103 SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR))
ohair@478 1104 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk
ohair@478 1105
ohair@478 1106 SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html
ohair@478 1107 SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options
ohair@478 1108 SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages
ohair@478 1109
ohair@478 1110 sctpdocs: $(SCTPAPI_INDEX_HTML)
ohair@478 1111
ohair@478 1112 # Set relative location to core api document root
ohair@478 1113 $(SCTPAPI_INDEX_HTML): GET2DOCSDIR=$(SCTPAPI2COREAPI)/..
ohair@478 1114
ohair@478 1115 # Run javadoc if the index file is out of date or missing
erikj@518 1116 $(SCTPAPI_INDEX_HTML): $(SCTPAPI_OPTIONS_FILE) $(SCTPAPI_PACKAGES_FILE) coredocs
ohair@478 1117 $(prep-javadoc)
ohair@478 1118 $(call JavadocSummary,$(SCTPAPI_OPTIONS_FILE),$(SCTPAPI_PACKAGES_FILE))
ohair@478 1119 $(JAVADOC_CMD) -d $(@D) \
ohair@478 1120 @$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE)
ohair@478 1121
ohair@478 1122 # Create file with javadoc options in it
ohair@478 1123 $(SCTPAPI_OPTIONS_FILE):
ohair@478 1124 $(prep-target)
ohair@478 1125 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ohair@478 1126 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ohair@478 1127 $(call OptionPair,-encoding,ascii) ; \
ohair@478 1128 $(call OptionOnly,-nodeprecatedlist) ; \
ohair@478 1129 $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \
ohair@478 1130 $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\
ohair@478 1131 $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \
ohair@478 1132 $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
ohair@478 1133 $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
ohair@478 1134 ) >> $@
ohair@478 1135
ohair@478 1136 # Create a file with the package names in it
ohair@478 1137 $(SCTPAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SCTPAPI_PKGS))
ohair@478 1138 $(prep-target)
ohair@478 1139 $(call PackageFilter,$(SCTPAPI_PKGS))
ohair@478 1140
ohair@478 1141 #############################################################
ohair@478 1142 #
ohair@478 1143 # Get a cache of all the directories
ohair@478 1144
ohair@478 1145 $(DIRECTORY_CACHE): $(ALL_EXISTING_SOURCE_DIRS)
ohair@478 1146 $(prep-target)
ohair@478 1147 @for cp in $(ALL_EXISTING_SOURCE_DIRS) ; do \
ohair@478 1148 $(ECHO) "$(FIND) $${cp} -type f >> $@"; \
ohair@478 1149 $(FIND) $${cp} -type f >> $@; \
ohair@478 1150 done
ohair@478 1151
ohair@478 1152 #############################################################
ohair@478 1153 #release version of core packages ########
ohair@478 1154 # Maximize performance and ensure that build number & milestone are set.
ohair@478 1155
ohair@478 1156 rel-coredocs: sanitycheckcoredocs
ohair@478 1157 $(MAKE) coredocs
ohair@478 1158
ohair@478 1159 rel-docs: rel-coredocs $(ALL_OTHER_TARGETS)
ohair@478 1160 #
ohair@478 1161 # end of production targets
ohair@478 1162
ohair@478 1163 otherdocs: $(ALL_OTHER_TARGETS)
ohair@478 1164
ohair@478 1165 clean:
ohair@478 1166 $(RM) -r $(DOCSDIR) $(DOCSTMPDIR)
ohair@478 1167
ohair@478 1168 #############################################################
ohair@478 1169 # DEBUG TARGET
ohair@478 1170 # List the values defined in the makefile hierarchy, to make sure everything
ohair@478 1171 # is set properly, and to help identify values we can use instead of making new ones.
ohair@478 1172 # (Most of them come from common/shared/Defs.gmk)
ohair@478 1173 #
ohair@478 1174 # Notes:
ohair@478 1175 # * BUILD_NUMBER defaults to b00 if not set on command line with BUILD_NUMBER=<value>
ohair@478 1176 # * MILESTONE defaults to internal unless set to beta, rc, or fcs on command line
ohair@478 1177 #
ohair@478 1178
ohair@478 1179 #############################################################
ohair@478 1180 .PHONY: all docs coredocs rel-docs otherdocs rel-coredocs \
ohair@478 1181 sanitycheckcoredocs $(ALL_OTHER_TARGETS)

mercurial