ptbrunet@1334: # Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
aoqi@0: # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0: #
aoqi@0: # This code is free software; you can redistribute it and/or modify it
aoqi@0: # under the terms of the GNU General Public License version 2 only, as
aoqi@0: # published by the Free Software Foundation. Oracle designates this
aoqi@0: # particular file as subject to the "Classpath" exception as provided
aoqi@0: # by Oracle in the LICENSE file that accompanied this code.
aoqi@0: #
aoqi@0: # This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0: # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0: # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0: # version 2 for more details (a copy is included in the LICENSE file that
aoqi@0: # accompanied this code).
aoqi@0: #
aoqi@0: # You should have received a copy of the GNU General Public License version
aoqi@0: # 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0: # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0: #
aoqi@0: # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0: # or visit www.oracle.com if you need additional information or have any
aoqi@0: # questions.
aoqi@0: #
aoqi@0:
aoqi@0: include $(SPEC)
aoqi@0: include MakeBase.gmk
aoqi@0:
aoqi@0: .SUFFIXES: # Delete the default suffixes
aoqi@0: .SUFFIXES: .java
aoqi@0:
aoqi@0: #
aoqi@0: # Definitions for $(DOCSDIR), $(MKDIR), $(BINDIR), etc.
aoqi@0: #
aoqi@0:
aoqi@0: DOCSDIR=$(OUTPUT_ROOT)/docs
aoqi@0: TEMPDIR=$(OUTPUT_ROOT)/docstemp
aoqi@0:
aoqi@0: JDK_SHARE_SRC=$(JDK_TOPDIR)/src/share
aoqi@0: JDK_SHARE_CLASSES=$(JDK_SHARE_SRC)/classes
aoqi@0:
aoqi@0: JDK_IMPSRC = $(JDK_OUTPUTDIR)/impsrc
aoqi@0:
aoqi@0: JDK_GENSRC = $(JDK_OUTPUTDIR)/gensrc
aoqi@0:
aoqi@0: HOTSPOT_DOCS_IMPORT_PATH=$(HOTSPOT_OUTPUTDIR)/docs
aoqi@0:
aoqi@0: BUILD_NUMBER=$(JDK_BUILD_NUMBER)
aoqi@0:
aoqi@0: JAVADOC_CMD = $(JAVA) \
aoqi@0: -Xmx1024m \
aoqi@0: -Djava.awt.headless=true \
aoqi@0: $(NEW_JAVADOC) \
aoqi@0: -bootclasspath $(JDK_OUTPUTDIR)/classes
aoqi@0:
aoqi@0: # Copyright year for beginning of Java and some of the apis
aoqi@0: # (Needed when creating the javadocs)
aoqi@0: FIRST_COPYRIGHT_YEAR = 1993
aoqi@0: DOMAPI_FIRST_COPYRIGHT_YEAR = 2005
aoqi@0: MIRROR_FIRST_COPYRIGHT_YEAR = 2004
aoqi@0: DOCLETAPI_FIRST_COPYRIGHT_YEAR = 1993
aoqi@0: TAGLETAPI_FIRST_COPYRIGHT_YEAR = 1993
aoqi@0: JDI_FIRST_COPYRIGHT_YEAR = 1999
aoqi@0: JAAS_FIRST_COPYRIGHT_YEAR = 1998
aoqi@0: JGSS_FIRST_COPYRIGHT_YEAR = 2000
aoqi@0: SMARTCARDIO_FIRST_COPYRIGHT_YEAR = 2005
aoqi@0: HTTPSERVER_FIRST_COPYRIGHT_YEAR = 2005
aoqi@0: MGMT_FIRST_COPYRIGHT_YEAR = 2003
aoqi@0: ATTACH_FIRST_COPYRIGHT_YEAR = 2005
aoqi@0: JCONSOLE_FIRST_COPYRIGHT_YEAR = 2006
aoqi@0: SCTPAPI_FIRST_COPYRIGHT_YEAR = 2009
aoqi@0: TRACING_FIRST_COPYRIGHT_YEAR = 2008
aoqi@0: TREEAPI_FIRST_COPYRIGHT_YEAR = 2005
sundar@1207: NASHORNAPI_FIRST_COPYRIGHT_YEAR = 2014
aoqi@0: JNLP_FIRST_COPYRIGHT_YEAR = 1998
aoqi@0: PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007
aoqi@0: JDKNET_FIRST_COPYRIGHT_YEAR = 2014
ptbrunet@1334: JACCESSAPI_FIRST_COPYRIGHT_YEAR = 2002
aoqi@0:
aoqi@0: # Oracle name
aoqi@0: FULL_COMPANY_NAME = Oracle and/or its affiliates
aoqi@0:
aoqi@0: # Copyright address
aoqi@0: COMPANY_ADDRESS = 500 Oracle Parkway
Redwood Shores, CA 94065 USA.
aoqi@0:
aoqi@0: # The trademark symbol
aoqi@0: TRADEMARK = ™
aoqi@0:
aoqi@0: # Common copyright lines used
aoqi@0: # The word "Copyright" might optionally be a link to the file cpyr.html.
aoqi@0: # The first year of copyright may vary or not be available.
aoqi@0: # The address to the company might be optional.
aoqi@0: COMMA:= ,
aoqi@0: EMPTY:=
aoqi@0: SPACE:=$(EMPTY) $(EMPTY)
aoqi@0: COPYRIGHT_SYMBOL = &\#x00a9;
aoqi@0: # Macro to construct the copyright line
aoqi@0: # (The GNU make 3.78.1 "if" conditional is broken, fixed in GNU make 3.81)
aoqi@0: define CopyrightLine # optionalurl optionalfirstyear optionaladdress
aoqi@0: $(if $(strip $1),Copyright,Copyright) \
aoqi@0: $(COPYRIGHT_SYMBOL) $(if $2,$2${COMMA},) $(COPYRIGHT_YEAR),\
aoqi@0: $(FULL_COMPANY_NAME). $3 All rights reserved.
aoqi@0: endef
aoqi@0:
aoqi@0: # Url to root of documents
aoqi@0: DOCSDIR_URL = {@docroot}/$(GET2DOCSDIR)
aoqi@0:
aoqi@0: # Url to copyright html file
aoqi@0: COPYRIGHT_URL = $(DOCSDIR_URL)/legal/cpyr.html
aoqi@0:
aoqi@0: # Url to bug filing site
aoqi@0: BUG_SUBMIT_URL = http://bugreport.sun.com/bugreport/
aoqi@0:
aoqi@0: # Common line for how to submit a bug or rfe
aoqi@0: BUG_SUBMIT_LINE = Submit a bug or feature
aoqi@0:
aoqi@0: # Url to devdocs page
aoqi@0: # Was: http://java.sun.com/javase/6/webnotes/devdocs-vs-specs.html
bpatel@1216: DEV_DOCS_URL-7 = https://docs.oracle.com/javase/7/docs/index.html
bpatel@1216: DEV_DOCS_URL-8 = https://docs.oracle.com/javase/8/docs/index.html
aoqi@0: DEV_DOCS_URL = $(DEV_DOCS_URL-$(JDK_MINOR_VERSION))
bpatel@1216: DOCS_BASE_URL = https://docs.oracle.com/javase/7/docs
aoqi@0:
aoqi@0: # Common Java trademark line
aoqi@0: JAVA_TRADEMARK_LINE = Java is a trademark or registered trademark of \
aoqi@0: $(FULL_COMPANY_NAME) in the US and other countries.
aoqi@0:
aoqi@0: #################################################################
aoqi@0: # Macros:
aoqi@0:
aoqi@0:
aoqi@0: # List of all possible directories for javadoc to look for sources
aoqi@0: # NOTE: Quotes are required around sourcepath argument only on Windows.
aoqi@0: # Otherwise, you get "No packages or classes specified." due
aoqi@0: # to $(PATH_SEP) being interpreted as an end of
aoqi@0: # command (newline or shell ; character)
aoqi@0: ALL_SOURCE_DIRS = $(JDK_SHARE_CLASSES) \
aoqi@0: $(JDK_IMPSRC) \
aoqi@0: $(JDK_GENSRC) \
aoqi@0: $(JDK_OUTPUTDIR)/gendocsrc_rmic \
aoqi@0: $(JDK_TOPDIR)/src/solaris/classes \
aoqi@0: $(JDK_TOPDIR)/src/windows/classes \
sundar@1207: $(NASHORN_TOPDIR)/src/ \
aoqi@0: $(JDK_SHARE_SRC)/doc/stub
aoqi@0:
aoqi@0: # List of directories that actually exist
aoqi@0: ALL_EXISTING_SOURCE_DIRS := $(wildcard $(ALL_SOURCE_DIRS))
aoqi@0:
aoqi@0: # List with classpath separator between them
aoqi@0: EMPTY:=
aoqi@0: SPACE:= $(EMPTY) $(EMPTY)
aoqi@0: RELEASEDOCS_SOURCEPATH = \
aoqi@0: $(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_SOURCE_DIRS)))
aoqi@0:
aoqi@0: define prep-target
aoqi@0: $(MKDIR) -p $(@D)
aoqi@0: $(RM) $@
aoqi@0: endef
aoqi@0:
aoqi@0: # Prep for javadoc creation, assumes $@ is an index.html file
aoqi@0: define prep-javadoc
aoqi@0: @if [ -f "$@" -a "$?" != "" ] ; then \
aoqi@0: $(ECHO) "# Dependencies have changed: $?"; \
aoqi@0: fi
aoqi@0: $(RM) -r $(@D)
aoqi@0: $(MKDIR) -p $(@D)
aoqi@0: endef
aoqi@0:
aoqi@0: # A cache of the directories in ALL_SOURCE_DIRS
aoqi@0: DIRECTORY_CACHE = $(DOCSTMPDIR)/directory.cache
aoqi@0:
aoqi@0: # Given a list of packages, return a list of files or dirs to be dependent on
aoqi@0: # (Currently only returning a list of directories)
aoqi@0: define PackageDependencies # packages
aoqi@0: $(shell \
aoqi@0: if [ "$1" != "" -a -f $(DIRECTORY_CACHE) ] ; then \
aoqi@0: for p in $1 ; do \
aoqi@0: pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \
aoqi@0: $(CAT) $(DIRECTORY_CACHE) | $(GREP) "/$${pd}/" ; \
aoqi@0: done; \
aoqi@0: fi \
aoqi@0: )
aoqi@0: endef
aoqi@0:
aoqi@0: # Given a list of packages, add packages that exist to $@, print summary
aoqi@0: define PackageFilter # packages
aoqi@0: @if [ "$1" != "" ] ; then \
aoqi@0: for p in $1 ; do \
aoqi@0: pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \
aoqi@0: found="false"; \
aoqi@0: for cp in $(ALL_SOURCE_DIRS) ; do \
aoqi@0: if [ -d $${cp}/$${pd} ] ; then \
aoqi@0: $(ECHO) "$${p}" >> $@; \
aoqi@0: found="true"; \
aoqi@0: break; \
aoqi@0: fi; \
aoqi@0: done; \
aoqi@0: if [ "$${found}" = "false" ] ; then \
aoqi@0: $(ECHO) "WARNING: Package not found: $${p}"; \
aoqi@0: fi; \
aoqi@0: done; \
aoqi@0: fi
aoqi@0: endef
aoqi@0:
aoqi@0: # Print out a summary of the javadoc command about to be run
aoqi@0: define JavadocSummary # optionsfile packagesfile
aoqi@0: @$(ECHO) "# Summary for $@"; \
aoqi@0: $(ECHO) "# Options (`$(BASENAME) $1`):"; $(SED) -e 's@^@# @' $1; \
aoqi@0: $(ECHO) "# Packages (`$(BASENAME) $2`):";$(SED) -e 's@^@# @' $2
aoqi@0: endef
aoqi@0:
aoqi@0: #
aoqi@0: # Temporary directory for javadoc creation
aoqi@0: #
aoqi@0: DOCSTMPDIR = $(TEMPDIR)/doctmp
aoqi@0:
aoqi@0: #
aoqi@0: # Different api directories created from root directory
aoqi@0: #
aoqi@0: COREAPI_DOCSDIR = $(DOCSDIR)/api
aoqi@0: JDK_API_DOCSDIR = $(DOCSDIR)/jdk/api
aoqi@0: JRE_API_DOCSDIR = $(DOCSDIR)/jre/api
aoqi@0: PLATFORM_DOCSDIR = $(DOCSDIR)/platform
aoqi@0:
aoqi@0: # The non-core api javadocs need to be able to access the root of the core
aoqi@0: # api directory, so for jdk/api or jre/api to get to the core api/
aoqi@0: # directory we would use this:
aoqi@0: JDKJRE2COREAPI = ../../api
aoqi@0:
aoqi@0: # Common bottom argument
aoqi@0: define CommonBottom # year
aoqi@0:
$(call CopyrightLine,,$1,)
aoqi@0: endef
aoqi@0:
aoqi@0: # Common trademark bottom argument (Not sure why this is used sometimes)
aoqi@0: define CommonTrademarkBottom # year
aoqi@0: \
aoqi@0: $(BUG_SUBMIT_LINE)
$(JAVA_TRADEMARK_LINE)
\
aoqi@0: $(call CopyrightLine,,$1,$(COMPANY_ADDRESS))\
aoqi@0:
aoqi@0: endef
aoqi@0:
aoqi@0: # Common echo of option
aoqi@0: define OptionOnly # opt
aoqi@0: $(PRINTF) "%s\n" "$1"
aoqi@0: endef
aoqi@0: define OptionPair # opt arg
aoqi@0: $(PRINTF) "%s '%s'\n" "$1" '$2'
aoqi@0: endef
aoqi@0: define OptionTrip # opt arg arg
aoqi@0: $(PRINTF) "%s '%s' '%s'\n" "$1" '$2' '$3'
aoqi@0: endef
aoqi@0:
aoqi@0: # Core api bottom argument (with special sauce)
aoqi@0: COREAPI_BOTTOM = $(BUG_SUBMIT_LINE)\
aoqi@0:
For further API reference and developer documentation, \
aoqi@0: see Java SE Documentation. \
aoqi@0: That documentation contains more detailed, developer-targeted descriptions, \
aoqi@0: with conceptual overviews, definitions of terms, workarounds, \
aoqi@0: and working code examples.
\
aoqi@0: $(call CopyrightLine,$(COPYRIGHT_URL),$(FIRST_COPYRIGHT_YEAR),)\
asaha@1633: Use is subject to license terms. \
asaha@1633: Also see the documentation redistribution policy.\
aoqi@0:
aoqi@0:
aoqi@0: # Common javadoc options used by all
aoqi@0: COMMON_JAVADOCFLAGS = \
aoqi@0: -XDignore.symbol.file=true \
aoqi@0: -quiet \
aoqi@0: -use \
aoqi@0: -keywords \
aoqi@0: -Xdoclint:none \
aoqi@0: -Xprofilespath $(JDK_TOPDIR)/make/profile-rtjar-includes.txt \
aoqi@0: $(ADDITIONAL_JAVADOCFLAGS)
aoqi@0:
aoqi@0: ifdef OPENJDK
aoqi@0: ADDITIONAL_JAVADOCFLAGS = \
aoqi@0: -Xdocrootparent $(DOCS_BASE_URL)
aoqi@0: else
aoqi@0: ADDITIONAL_JAVADOCFLAGS =
aoqi@0: endif
aoqi@0:
aoqi@0: # Draft used for non-fcs documents
aoqi@0: DRAFT_HEADER =
aoqi@0: ifneq ($(MILESTONE), fcs)
aoqi@0: DRAFT_HEADER =
DRAFT $(MILESTONE)-$(BUILD_NUMBER)
aoqi@0: DRAFT_BOTTOM =
DRAFT $(MILESTONE)-$(BUILD_NUMBER)
aoqi@0: DRAFT_WINTITLE = $(BUILD_NUMBER)
aoqi@0: # Early access top text (not used in FCS releases)
aoqi@0: COREAPI_TOP_EARLYACCESS = \
aoqi@0:
\
aoqi@0:
\
aoqi@0: Please note that the specifications and other information \
aoqi@0: contained herein are not final and are subject to change. \
aoqi@0: The information is being made available to you solely for purpose of \
aoqi@0: evaluation. \
aoqi@0:
aoqi@0:
aoqi@0: endif
aoqi@0:
aoqi@0: #################################################################
aoqi@0:
aoqi@0: #
aoqi@0: # CORE_PKGS environment variable has been moved to the following file
aoqi@0: #
aoqi@0: include CORE_PKGS.gmk
aoqi@0:
aoqi@0: #
aoqi@0: # Load environment variables for API package names that are not part of
aoqi@0: # the Java SE platform
aoqi@0: #
aoqi@0: include NON_CORE_PKGS.gmk
aoqi@0:
aoqi@0: #################################################################
aoqi@0:
aoqi@0: #
rriggs@1196: # Load custom Javadoc rules, if present
rriggs@1196: #
rriggs@1196: -include $(CUSTOM_MAKE_DIR)/Javadoc.gmk
rriggs@1196:
rriggs@1196: #################################################################
rriggs@1196:
rriggs@1196: #
aoqi@0: # Default target is same as docs target, create core api and all others it can
aoqi@0: #
aoqi@0:
aoqi@0: all: docs
aoqi@0: docs: coredocs otherdocs
aoqi@0:
aoqi@0: #################################################################
aoqi@0: # Production Targets -- USE THESE TARGETS WHEN:
aoqi@0: # a) You're generating docs outside of release engineering's
aoqi@0: # standard control build.
aoqi@0: # b) The docs will be pushed to the web and/or included in
aoqi@0: # the downloaded doc bundle.
aoqi@0: #
aoqi@0: # See: Notes.html#releaseTargets
aoqi@0: # Note: Spaces precede ifdef/ifndef indents. Tabs precede target commands (!)
aoqi@0: #
aoqi@0:
aoqi@0: sanitycheckcoredocs:
aoqi@0: @$(ECHO) ""
aoqi@0: @$(ECHO) "Building core api docs with these values:"
aoqi@0: @$(ECHO) " BUILD_NUMBER = $(BUILD_NUMBER)"
aoqi@0: @$(ECHO) " MILESTONE = $(MILESTONE)"
aoqi@0: @$(ECHO) ""
aoqi@0: ifeq ($(BUILD_NUMBER), b00)
aoqi@0: @$(ECHO) "ERROR: Build number must be defined"
aoqi@0: @$(ECHO) "MILESTONE is set to $(MILESTONE)"
aoqi@0: @$(ECHO) ""
aoqi@0: exit 1
aoqi@0: endif
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # coredocs
aoqi@0: #
aoqi@0: COREAPI_DOCTITLE = Java$(TRADEMARK) Platform, Standard Edition \
aoqi@0: $(JDK_MINOR_VERSION)
API Specification
aoqi@0: COREAPI_WINDOWTITLE = Java Platform SE $(JDK_MINOR_VERSION)
aoqi@0: COREAPI_HEADER = \
aoqi@0: Java$(TRADEMARK) Platform
Standard Ed. $(JDK_MINOR_VERSION)
aoqi@0:
aoqi@0: # Java language specification cite
aoqi@0: TAG_JLS = jls:a:See \
aoqi@0: The Java™ Language Specification:
aoqi@0:
aoqi@0: # Overview file for core apis
aoqi@0: COREAPI_OVERVIEW = $(JDK_SHARE_CLASSES)/overview-core.html
aoqi@0:
aoqi@0: # The index.html, options, and packages files
aoqi@0: COREAPI_INDEX_FILE = $(COREAPI_DOCSDIR)/index.html
aoqi@0: COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options
aoqi@0: COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages
aoqi@0:
aoqi@0: coredocs: $(COREAPI_INDEX_FILE)
aoqi@0:
aoqi@0: # Set relative location to core api document root
aoqi@0: $(COREAPI_INDEX_FILE): GET2DOCSDIR=..
aoqi@0:
aoqi@0: # Run javadoc if the index file is out of date or missing
aoqi@0: $(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE)
aoqi@0: $(prep-javadoc)
aoqi@0: $(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE))
aoqi@0: $(JAVADOC_CMD) -d $(@D) \
aoqi@0: @$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE)
aoqi@0:
aoqi@0: # Create file with javadoc options in it
aoqi@0: $(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW)
aoqi@0: $(prep-target)
aoqi@0: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
aoqi@0: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
aoqi@0: $(call OptionPair,-encoding,ISO-8859-1) ; \
aoqi@0: $(call OptionPair,-tag,beaninfo:X) ; \
aoqi@0: $(call OptionPair,-tag,revised:X) ; \
aoqi@0: $(call OptionPair,-tag,since.unbundled:X) ; \
aoqi@0: $(call OptionPair,-tag,spec:X) ; \
aoqi@0: $(call OptionPair,-tag,specdefault:X) ; \
aoqi@0: $(call OptionPair,-tag,Note:X) ; \
aoqi@0: $(call OptionPair,-tag,ToDo:X) ; \
aoqi@0: $(call OptionPair,-tag,apiNote:a:API Note:) ; \
aoqi@0: $(call OptionPair,-tag,implSpec:a:Implementation Requirements:) ; \
aoqi@0: $(call OptionPair,-tag,implNote:a:Implementation Note:) ; \
aoqi@0: $(call OptionPair,-tag,param) ; \
aoqi@0: $(call OptionPair,-tag,return) ; \
aoqi@0: $(call OptionPair,-tag,throws) ; \
aoqi@0: $(call OptionPair,-tag,since) ; \
aoqi@0: $(call OptionPair,-tag,version) ; \
aoqi@0: $(call OptionPair,-tag,serialData) ; \
aoqi@0: $(call OptionPair,-tag,factory) ; \
aoqi@0: $(call OptionPair,-tag,see) ; \
aoqi@0: $(call OptionPair,-tag,$(TAG_JLS)) ; \
aoqi@0: $(call OptionOnly,-splitIndex) ; \
aoqi@0: $(call OptionPair,-overview,$(COREAPI_OVERVIEW)) ; \
aoqi@0: $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE)) ; \
aoqi@0: $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ; \
aoqi@0: $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER)) ; \
aoqi@0: $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
aoqi@0: ) >> $@
aoqi@0: ifdef COREAPI_TOP_EARLYACCESS
aoqi@0: @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@
aoqi@0: endif
aoqi@0:
aoqi@0: # Create a file with the package names in it
aoqi@0: $(COREAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(CORE_PKGS))
aoqi@0: $(prep-target)
aoqi@0: $(call PackageFilter,$(CORE_PKGS))
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # docletapidocs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += docletapidocs
aoqi@0:
aoqi@0: DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet
aoqi@0: DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
aoqi@0: DOCLETAPI_DOCTITLE := Doclet API
aoqi@0: DOCLETAPI_WINDOWTITLE := Doclet API
aoqi@0: DOCLETAPI_HEADER := Doclet API
aoqi@0: DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
aoqi@0: DOCLETAPI_GROUPNAME := Packages
aoqi@0: DOCLETAPI_REGEXP := com.sun.javadoc
aoqi@0: # DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
aoqi@0:
aoqi@0: # The index.html, options, and packages files
aoqi@0: DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html
aoqi@0: DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options
aoqi@0: DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages
aoqi@0:
aoqi@0: docletapidocs: $(DOCLETAPI_INDEX_FILE)
aoqi@0:
aoqi@0: # Set relative location to core api document root
aoqi@0: $(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/..
aoqi@0:
aoqi@0: # Run javadoc if the index file is out of date or missing
aoqi@0: $(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) coredocs
aoqi@0: $(prep-javadoc)
aoqi@0: $(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE))
aoqi@0: $(JAVADOC_CMD) -d $(@D) \
aoqi@0: @$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE)
aoqi@0:
aoqi@0: # Create file with javadoc options in it
aoqi@0: $(DOCLETAPI_OPTIONS_FILE):
aoqi@0: $(prep-target)
aoqi@0: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
aoqi@0: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
aoqi@0: $(call OptionPair,-encoding,ascii) ; \
aoqi@0: $(call OptionOnly,-breakiterator) ; \
aoqi@0: $(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \
aoqi@0: $(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
aoqi@0: $(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \
aoqi@0: $(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
aoqi@0: $(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \
aoqi@0: $(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
aoqi@0: ) >> $@
aoqi@0:
aoqi@0: # Create a file with the package names in it
aoqi@0: $(DOCLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOCLETAPI_PKGS))
aoqi@0: $(prep-target)
aoqi@0: $(call PackageFilter,$(DOCLETAPI_PKGS))
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # tagletapidocs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += tagletapidocs
aoqi@0: TAGLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/taglet
aoqi@0: TAGLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
aoqi@0: TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR))
aoqi@0: # TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk
aoqi@0:
aoqi@0: # Temporary directory (special generation rules)
aoqi@0: TAGLETAPI_TEMPDIR = $(DOCSTMPDIR)/taglets_temp
aoqi@0:
aoqi@0: # The index.html, options, and packages files
aoqi@0: TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/index.html
aoqi@0: TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options
aoqi@0: TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages
aoqi@0:
aoqi@0: tagletapidocs: $(TAGLETAPI_INDEX_FILE)
aoqi@0:
aoqi@0: # Set relative location to core api document root
aoqi@0: $(TAGLETAPI_INDEX_FILE): GET2DOCSDIR=$(TAGLETAPI2COREAPI)/..
aoqi@0:
aoqi@0: # Run javadoc if the index file is out of date or missing
aoqi@0: $(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) coredocs
aoqi@0: $(prep-javadoc)
aoqi@0: $(RM) -r $(TAGLETAPI_TEMPDIR)
aoqi@0: $(MKDIR) -p $(TAGLETAPI_TEMPDIR)
aoqi@0: $(call JavadocSummary,$(TAGLETAPI_OPTIONS_FILE),$(TAGLETAPI_PACKAGES_FILE))
aoqi@0: $(JAVADOC_CMD) -d $(TAGLETAPI_TEMPDIR) \
aoqi@0: @$(TAGLETAPI_OPTIONS_FILE) @$(TAGLETAPI_PACKAGES_FILE)
aoqi@0: cp -r $(TAGLETAPI_TEMPDIR)/com $(@D)
aoqi@0: cp $(TAGLETAPI_TEMPDIR)/stylesheet.css $(@D)
aoqi@0: $(RM) -r $(TAGLETAPI_TEMPDIR)
aoqi@0:
aoqi@0: # Create file with javadoc options in it
aoqi@0: $(TAGLETAPI_OPTIONS_FILE):
aoqi@0: $(prep-target)
aoqi@0: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
aoqi@0: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
aoqi@0: $(call OptionPair,-encoding,ascii) ; \
aoqi@0: $(call OptionOnly,-nonavbar) ; \
aoqi@0: $(call OptionOnly,-noindex) ; \
aoqi@0: $(call OptionPair,-bottom,$(TAGLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
aoqi@0: $(call OptionTrip,-linkoffline,$(TAGLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
aoqi@0: ) >> $@
aoqi@0:
aoqi@0: # Create a file with the package names in it
aoqi@0: $(TAGLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TAGLETAPI_PKGS))
aoqi@0: $(prep-target)
aoqi@0: @($(ECHO) "$(JDK_IMPSRC)/$(TAGLETAPI_FILE)" ) > $@
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # domapidocs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += domapidocs
aoqi@0:
aoqi@0: DOMAPI_DOCDIR := $(JRE_API_DOCSDIR)/plugin/dom
aoqi@0: DOMAPI2COREAPI := ../../$(JDKJRE2COREAPI)
aoqi@0: DOMAPI_DOCTITLE := Common DOM API
aoqi@0: DOMAPI_WINDOWTITLE := Common DOM API
aoqi@0: DOMAPI_HEADER := Common DOM API
aoqi@0: DOMAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOMAPI_FIRST_COPYRIGHT_YEAR))
aoqi@0: DOMAPI_GROUPNAME := Packages
aoqi@0: DOMAPI_REGEXP := com.sun.java.browser.dom:org.w3c.dom*
aoqi@0: # DOMAPI_PKGS is located in NON_CORE_PKGS.gmk
aoqi@0:
aoqi@0: # The index.html, options, and packages files
aoqi@0: DOMAPI_INDEX_FILE = $(DOMAPI_DOCDIR)/index.html
aoqi@0: DOMAPI_OPTIONS_FILE = $(DOCSTMPDIR)/domapi.options
aoqi@0: DOMAPI_PACKAGES_FILE = $(DOCSTMPDIR)/domapi.packages
aoqi@0:
aoqi@0: domapidocs: $(DOMAPI_INDEX_FILE)
aoqi@0:
aoqi@0: # Set relative location to core api document root
aoqi@0: $(DOMAPI_INDEX_FILE): GET2DOCSDIR=$(DOMAPI2COREAPI)/..
aoqi@0:
aoqi@0: # Run javadoc if the index file is out of date or missing
aoqi@0: $(DOMAPI_INDEX_FILE): $(DOMAPI_OPTIONS_FILE) $(DOMAPI_PACKAGES_FILE) coredocs
aoqi@0: $(prep-javadoc)
aoqi@0: $(call JavadocSummary,$(DOMAPI_OPTIONS_FILE),$(DOMAPI_PACKAGES_FILE))
aoqi@0: $(JAVADOC_CMD) -d $(@D) \
aoqi@0: @$(DOMAPI_OPTIONS_FILE) @$(DOMAPI_PACKAGES_FILE)
aoqi@0:
aoqi@0: # Create file with javadoc options in it
aoqi@0: $(DOMAPI_OPTIONS_FILE):
aoqi@0: $(prep-target)
aoqi@0: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
aoqi@0: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
aoqi@0: $(call OptionPair,-encoding,ascii) ; \
aoqi@0: $(call OptionOnly,-splitIndex) ; \
aoqi@0: $(call OptionPair,-doctitle,$(DOMAPI_DOCTITLE)) ; \
aoqi@0: $(call OptionPair,-windowtitle,$(DOMAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
aoqi@0: $(call OptionPair,-header,$(DOMAPI_HEADER)$(DRAFT_HEADER)) ; \
aoqi@0: $(call OptionPair,-bottom,$(DOMAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
aoqi@0: $(call OptionTrip,-group,$(DOMAPI_GROUPNAME),$(DOMAPI_REGEXP)); \
aoqi@0: $(call OptionTrip,-linkoffline,$(DOMAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
aoqi@0: ) >> $@
aoqi@0:
aoqi@0: # Create a file with the package names in it
aoqi@0: $(DOMAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOMAPI_PKGS))
aoqi@0: $(prep-target)
aoqi@0: $(call PackageFilter,$(DOMAPI_PKGS))
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # jpdadocs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += jpdadocs
aoqi@0:
aoqi@0: jpdadocs: jdidocs jdwpdocs jvmtidocs
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # jdidocs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += jdidocs
aoqi@0:
aoqi@0: JDI_DOCDIR := $(JDK_API_DOCSDIR)/jpda/jdi
aoqi@0: JDI2COREAPI := ../../$(JDKJRE2COREAPI)
aoqi@0: JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface
aoqi@0: JDI_WINDOWTITLE := Java Debug Interface
aoqi@0: JDI_HEADER := Java Debug Interface
aoqi@0: JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR))
aoqi@0: JDI_OVERVIEW := $(JDK_SHARE_CLASSES)/jdi-overview.html
aoqi@0: # JDI_PKGS is located in NON_CORE_PKGS.gmk
aoqi@0:
aoqi@0: # The index.html, options, and packages files
aoqi@0: JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html
aoqi@0: JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options
aoqi@0: JDI_PACKAGES_FILE = $(DOCSTMPDIR)/jdi.packages
aoqi@0:
aoqi@0: jdidocs: $(JDI_INDEX_FILE)
aoqi@0:
aoqi@0: # Set relative location to core api document root
aoqi@0: $(JDI_INDEX_FILE): GET2DOCSDIR=$(JDI2COREAPI)/..
aoqi@0:
aoqi@0: # Run javadoc if the index file is out of date or missing
aoqi@0: $(JDI_INDEX_FILE): $(JDI_OPTIONS_FILE) $(JDI_PACKAGES_FILE) coredocs
aoqi@0: $(prep-javadoc)
aoqi@0: $(call JavadocSummary,$(JDI_OPTIONS_FILE),$(JDI_PACKAGES_FILE))
aoqi@0: $(JAVADOC_CMD) -d $(@D) \
aoqi@0: @$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE)
aoqi@0:
aoqi@0: # Create file with javadoc options in it
aoqi@0: $(JDI_OPTIONS_FILE): $(JDI_OVERVIEW)
aoqi@0: $(prep-target)
aoqi@0: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
aoqi@0: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
aoqi@0: $(call OptionPair,-encoding,ascii) ; \
aoqi@0: $(call OptionPair,-overview,$(JDI_OVERVIEW)) ; \
aoqi@0: $(call OptionPair,-doctitle,$(JDI_DOCTITLE)) ; \
aoqi@0: $(call OptionPair,-windowtitle,$(JDI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
aoqi@0: $(call OptionPair,-header,$(JDI_HEADER)$(DRAFT_HEADER)) ; \
aoqi@0: $(call OptionPair,-bottom,$(JDI_BOTTOM)$(DRAFT_BOTTOM)) ; \
aoqi@0: $(call OptionTrip,-linkoffline,$(JDI2COREAPI),$(COREAPI_DOCSDIR)/); \
aoqi@0: ) >> $@
aoqi@0:
aoqi@0: # Create a file with the package names in it
aoqi@0: $(JDI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JDI_PKGS))
aoqi@0: $(prep-target)
aoqi@0: $(call PackageFilter,$(JDI_PKGS))
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # jdwpdocs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += jdwpdocs
aoqi@0:
aoqi@0: JDWP_DOCDIR = $(PLATFORM_DOCSDIR)/jpda/jdwp
aoqi@0:
aoqi@0: jdwpdocs: $(JDWP_DOCDIR)/jdwp-protocol.html
aoqi@0: $(JDWP_DOCDIR)/jdwp-protocol.html : $(JDK_OUTPUTDIR)/gensrc_jdwp_doc/jdwp-protocol.html
aoqi@0: $(MKDIR) -p $(@D)
aoqi@0: $(RM) $@
aoqi@0: $(CP) $< $@
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # jvmtidocs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += jvmtidocs
aoqi@0:
aoqi@0: JVMTI_DOCDIR = $(PLATFORM_DOCSDIR)/jvmti
aoqi@0: JVMTI_HTML = $(HOTSPOT_DIST)/docs/platform/jvmti/jvmti.html
aoqi@0:
aoqi@0: jvmtidocs: $(JVMTI_DOCDIR)/jvmti.html
aoqi@0: $(JVMTI_DOCDIR)/jvmti.html:
aoqi@0: @$(prep-javadoc)
aoqi@0: @if [ -f $(JVMTI_HTML) ] ; then \
aoqi@0: $(ECHO) "$(CP) $(JVMTI_HTML) $@"; \
aoqi@0: $(CP) $(JVMTI_HTML) $@; \
aoqi@0: else \
aoqi@0: $(ECHO) "WARNING: Generated file does not exist: $(JVMTI_HTML)"; \
aoqi@0: fi
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # jaasdocs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += jaasdocs
aoqi@0:
aoqi@0: JAAS_DOCDIR := $(JRE_API_DOCSDIR)/security/jaas/spec
aoqi@0: JAAS2COREAPI := ../../../$(JDKJRE2COREAPI)
aoqi@0: JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service
aoqi@0: JAAS_WINDOWTITLE := Java Authentication and Authorization Service
aoqi@0: JAAS_HEADER := Java Authentication and Authorization Service
aoqi@0: JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR))
aoqi@0: # JAAS_PKGS is located in NON_CORE_PKGS.gmk
aoqi@0: JAAS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/auth/jaas-overview.html
aoqi@0:
aoqi@0: # The index.html, options, and packages files
aoqi@0: JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html
aoqi@0: JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options
aoqi@0: JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages
aoqi@0:
aoqi@0: jaasdocs: $(JAAS_INDEX_FILE)
aoqi@0:
aoqi@0: # Set relative location to core api document root
aoqi@0: $(JAAS_INDEX_FILE): GET2DOCSDIR=$(JAAS2COREAPI)/..
aoqi@0:
aoqi@0: # Run javadoc if the index file is out of date or missing
aoqi@0: $(JAAS_INDEX_FILE): $(JAAS_OPTIONS_FILE) $(JAAS_PACKAGES_FILE) coredocs
aoqi@0: $(prep-javadoc)
aoqi@0: $(call JavadocSummary,$(JAAS_OPTIONS_FILE),$(JAAS_PACKAGES_FILE))
aoqi@0: $(JAVADOC_CMD) -d $(@D) \
aoqi@0: @$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE)
aoqi@0:
aoqi@0: # Create file with javadoc options in it
aoqi@0: $(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW)
aoqi@0: $(prep-target)
aoqi@0: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
aoqi@0: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
aoqi@0: $(call OptionPair,-encoding,ascii) ; \
aoqi@0: $(call OptionPair,-overview,$(JAAS_OVERVIEW)) ; \
aoqi@0: $(call OptionPair,-doctitle,$(JAAS_DOCTITLE)) ; \
aoqi@0: $(call OptionPair,-windowtitle,$(JAAS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
aoqi@0: $(call OptionPair,-header,$(JAAS_HEADER)$(DRAFT_HEADER)) ; \
aoqi@0: $(call OptionPair,-bottom,$(JAAS_BOTTOM)$(DRAFT_BOTTOM)) ; \
aoqi@0: $(call OptionTrip,-linkoffline,$(JAAS2COREAPI),$(COREAPI_DOCSDIR)/); \
aoqi@0: ) >> $@
aoqi@0:
aoqi@0: # Create a file with the package names in it
aoqi@0: $(JAAS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JAAS_PKGS))
aoqi@0: $(prep-target)
aoqi@0: $(call PackageFilter,$(JAAS_PKGS))
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # jgssdocs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += jgssdocs
aoqi@0:
aoqi@0: JGSS_DOCDIR := $(JRE_API_DOCSDIR)/security/jgss/spec
aoqi@0: JGSS2COREAPI := ../../../$(JDKJRE2COREAPI)
aoqi@0: JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities
aoqi@0: JGSS_WINDOWTITLE := Java GSS-API Utilities
aoqi@0: JGSS_HEADER := Java GSS-API Utilities
aoqi@0: JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR))
aoqi@0: JGSS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/jgss/jgss-overview.html
aoqi@0: # JGSS_PKGS is located in NON_CORE_PKGS.gmk
aoqi@0:
aoqi@0: # The index.html, options, and packages files
aoqi@0: JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html
aoqi@0: JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options
aoqi@0: JGSS_PACKAGES_FILE = $(DOCSTMPDIR)/jgss.packages
aoqi@0:
aoqi@0: jgssdocs: $(JGSS_INDEX_FILE)
aoqi@0:
aoqi@0: # Set relative location to core api document root
aoqi@0: $(JGSS_INDEX_FILE): GET2DOCSDIR=$(JGSS2COREAPI)/..
aoqi@0:
aoqi@0: # Run javadoc if the index file is out of date or missing
aoqi@0: $(JGSS_INDEX_FILE): $(JGSS_OPTIONS_FILE) $(JGSS_PACKAGES_FILE) coredocs
aoqi@0: $(prep-javadoc)
aoqi@0: $(call JavadocSummary,$(JGSS_OPTIONS_FILE),$(JGSS_PACKAGES_FILE))
aoqi@0: $(JAVADOC_CMD) -d $(@D) \
aoqi@0: @$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE)
aoqi@0:
aoqi@0: # Create file with javadoc options in it
aoqi@0: $(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW)
aoqi@0: $(prep-target)
aoqi@0: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
aoqi@0: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
aoqi@0: $(call OptionPair,-encoding,ascii) ; \
aoqi@0: $(call OptionOnly,-nodeprecatedlist) ; \
aoqi@0: $(call OptionPair,-overview,$(JGSS_OVERVIEW)) ; \
aoqi@0: $(call OptionPair,-doctitle,$(JGSS_DOCTITLE)) ; \
aoqi@0: $(call OptionPair,-windowtitle,$(JGSS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
aoqi@0: $(call OptionPair,-header,$(JGSS_HEADER)$(DRAFT_HEADER)) ; \
aoqi@0: $(call OptionPair,-bottom,$(JGSS_BOTTOM)$(DRAFT_BOTTOM)) ; \
aoqi@0: $(call OptionTrip,-linkoffline,$(JGSS2COREAPI),$(COREAPI_DOCSDIR)/); \
aoqi@0: ) >> $@
aoqi@0:
aoqi@0: # Create a file with the package names in it
aoqi@0: $(JGSS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JGSS_PKGS))
aoqi@0: $(prep-target)
aoqi@0: $(call PackageFilter,$(JGSS_PKGS))
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # smartcardiodocs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += smartcardiodocs
aoqi@0:
aoqi@0: SMARTCARDIO_DOCDIR := $(JRE_API_DOCSDIR)/security/smartcardio/spec
aoqi@0: SMARTCARDIO2COREAPI := ../../../$(JDKJRE2COREAPI)
aoqi@0: SMARTCARDIO_DOCTITLE := Java$(TRADEMARK) Smart Card I/O
aoqi@0: SMARTCARDIO_WINDOWTITLE := Java Smart Card I/O
aoqi@0: SMARTCARDIO_HEADER := Java Smart Card I/O
aoqi@0: SMARTCARDIO_BOTTOM := $(call CommonBottom,$(SMARTCARDIO_FIRST_COPYRIGHT_YEAR))
aoqi@0: # SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk
aoqi@0:
aoqi@0: # The index.html, options, and packages files
aoqi@0: SMARTCARDIO_INDEX_FILE = $(SMARTCARDIO_DOCDIR)/index.html
aoqi@0: SMARTCARDIO_OPTIONS_FILE = $(DOCSTMPDIR)/smartcardio.options
aoqi@0: SMARTCARDIO_PACKAGES_FILE = $(DOCSTMPDIR)/smartcardio.packages
aoqi@0:
aoqi@0: smartcardiodocs: $(SMARTCARDIO_INDEX_FILE)
aoqi@0:
aoqi@0: # Set relative location to core api document root
aoqi@0: $(SMARTCARDIO_INDEX_FILE): GET2DOCSDIR=$(SMARTCARDIO2COREAPI)/..
aoqi@0:
aoqi@0: # Run javadoc if the index file is out of date or missing
aoqi@0: $(SMARTCARDIO_INDEX_FILE): $(SMARTCARDIO_OPTIONS_FILE) $(SMARTCARDIO_PACKAGES_FILE) coredocs
aoqi@0: $(prep-javadoc)
aoqi@0: $(call JavadocSummary,$(SMARTCARDIO_OPTIONS_FILE),$(SMARTCARDIO_PACKAGES_FILE))
aoqi@0: $(JAVADOC_CMD) -d $(@D) \
aoqi@0: @$(SMARTCARDIO_OPTIONS_FILE) @$(SMARTCARDIO_PACKAGES_FILE)
aoqi@0:
aoqi@0: # Create file with javadoc options in it
aoqi@0: $(SMARTCARDIO_OPTIONS_FILE):
aoqi@0: $(prep-target)
aoqi@0: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
aoqi@0: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
aoqi@0: $(call OptionPair,-encoding,ascii) ; \
aoqi@0: $(call OptionOnly,-nodeprecatedlist) ; \
aoqi@0: $(call OptionPair,-doctitle,$(SMARTCARDIO_DOCTITLE)) ; \
aoqi@0: $(call OptionPair,-windowtitle,$(SMARTCARDIO_WINDOWTITLE) $(DRAFT_WINTITLE)); \
aoqi@0: $(call OptionPair,-header,$(SMARTCARDIO_HEADER)$(DRAFT_HEADER)); \
aoqi@0: $(call OptionPair,-bottom,$(SMARTCARDIO_BOTTOM)$(DRAFT_BOTTOM)); \
aoqi@0: $(call OptionTrip,-linkoffline,$(SMARTCARDIO2COREAPI),$(COREAPI_DOCSDIR)/); \
aoqi@0: ) >> $@
aoqi@0:
aoqi@0: # Create a file with the package names in it
aoqi@0: $(SMARTCARDIO_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SMARTCARDIO_PKGS))
aoqi@0: $(prep-target)
aoqi@0: $(call PackageFilter,$(SMARTCARDIO_PKGS))
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # httpserverdocs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += httpserverdocs
aoqi@0:
aoqi@0: HTTPSERVER_DOCDIR := $(JRE_API_DOCSDIR)/net/httpserver/spec
aoqi@0: HTTPSERVER2COREAPI := ../../../$(JDKJRE2COREAPI)
aoqi@0: HTTPSERVER_DOCTITLE := Java$(TRADEMARK) HTTP Server
aoqi@0: HTTPSERVER_WINDOWTITLE := Java HTTP Server
aoqi@0: HTTPSERVER_HEADER := Java HTTP Server
aoqi@0: HTTPSERVER_BOTTOM := $(call CommonBottom,$(HTTPSERVER_FIRST_COPYRIGHT_YEAR))
aoqi@0: # HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk
aoqi@0:
aoqi@0: HTTPSERVER_INDEX_HTML = $(HTTPSERVER_DOCDIR)/index.html
aoqi@0: HTTPSERVER_OPTIONS_FILE = $(DOCSTMPDIR)/httpserver.options
aoqi@0: HTTPSERVER_PACKAGES_FILE = $(DOCSTMPDIR)/httpserver.packages
aoqi@0:
aoqi@0: httpserverdocs: $(HTTPSERVER_INDEX_HTML)
aoqi@0:
aoqi@0: # Set relative location to core api document root
aoqi@0: $(HTTPSERVER_INDEX_HTML): GET2DOCSDIR=$(HTTPSERVER2COREAPI)/..
aoqi@0:
aoqi@0: # Run javadoc if the index file is out of date or missing
aoqi@0: $(HTTPSERVER_INDEX_HTML): $(HTTPSERVER_OPTIONS_FILE) $(HTTPSERVER_PACKAGES_FILE) coredocs
aoqi@0: $(prep-javadoc)
aoqi@0: $(call JavadocSummary,$(HTTPSERVER_OPTIONS_FILE),$(HTTPSERVER_PACKAGES_FILE))
aoqi@0: $(JAVADOC_CMD) -d $(@D) \
aoqi@0: @$(HTTPSERVER_OPTIONS_FILE) @$(HTTPSERVER_PACKAGES_FILE)
aoqi@0:
aoqi@0: # Create file with javadoc options in it
aoqi@0: $(HTTPSERVER_OPTIONS_FILE):
aoqi@0: $(prep-target)
aoqi@0: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
aoqi@0: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
aoqi@0: $(call OptionPair,-encoding,ascii) ; \
aoqi@0: $(call OptionOnly,-nodeprecatedlist) ; \
aoqi@0: $(call OptionPair,-doctitle,$(HTTPSERVER_DOCTITLE)) ; \
aoqi@0: $(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE)); \
aoqi@0: $(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \
aoqi@0: $(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \
aoqi@0: $(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \
aoqi@0: ) >> $@
aoqi@0:
aoqi@0: # Create a file with the package names in it
aoqi@0: $(HTTPSERVER_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(HTTPSERVER_PKGS))
aoqi@0: $(prep-target)
aoqi@0: $(call PackageFilter,$(HTTPSERVER_PKGS))
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # mgmtdocs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += mgmtdocs
aoqi@0:
aoqi@0: MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension
aoqi@0: MGMT2COREAPI := ../../$(JDKJRE2COREAPI)
aoqi@0: JVM_MIB_NAME := JVM-MANAGEMENT-MIB.mib
aoqi@0: JVM_MIB_SRC := $(JDK_TOPDIR)/src/closed/share/classes/sun/management/snmp/$(JVM_MIB_NAME)
aoqi@0: MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform
aoqi@0: MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform
aoqi@0: MGMT_HEADER := Monitoring and Management Interface for the Java Platform
aoqi@0: MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR))
aoqi@0: MGMT_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/management/mgmt-overview.html
aoqi@0: # MGMT_PKGS is located in NON_CORE_PKGS.gmk
aoqi@0:
aoqi@0: # The index.html, options, and packages files
aoqi@0: MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html
aoqi@0: MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options
aoqi@0: MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages
aoqi@0:
aoqi@0: mgmtdocs: $(MGMT_INDEX_FILE)
aoqi@0:
aoqi@0: # Set relative location to core api document root
aoqi@0: $(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/..
aoqi@0:
aoqi@0: # Run javadoc if the index file is out of date or missing
aoqi@0: $(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) coredocs
aoqi@0: $(prep-javadoc)
aoqi@0: @if [ -f $(JVM_MIB_SRC) ] ; then \
aoqi@0: $(ECHO) "$(CP) $(JVM_MIB_SRC) $(@D)/.."; \
aoqi@0: $(CP) $(JVM_MIB_SRC) $(@D)/.. ; \
aoqi@0: else \
aoqi@0: $(ECHO) "WARNING: File $(JVM_MIB_NAME) not available."; \
aoqi@0: fi
aoqi@0: $(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE))
aoqi@0: $(JAVADOC_CMD) -d $(@D) \
aoqi@0: @$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE)
aoqi@0:
aoqi@0: # Create file with javadoc options in it
aoqi@0: $(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW)
aoqi@0: $(prep-target)
aoqi@0: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
aoqi@0: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
aoqi@0: $(call OptionPair,-encoding,ascii) ; \
aoqi@0: $(call OptionOnly,-nodeprecatedlist) ; \
aoqi@0: $(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \
aoqi@0: $(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \
aoqi@0: $(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \
aoqi@0: $(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \
aoqi@0: $(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \
aoqi@0: $(call OptionTrip,-linkoffline,$(MGMT2COREAPI),$(COREAPI_DOCSDIR)/); \
aoqi@0: ) >> $@
aoqi@0:
aoqi@0: # Create a file with the package names in it
aoqi@0: $(MGMT_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(MGMT_PKGS))
aoqi@0: $(prep-target)
aoqi@0: $(call PackageFilter,$(MGMT_PKGS))
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # attachdocs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += attachdocs
aoqi@0:
aoqi@0: ATTACH_DOCDIR := $(JDK_API_DOCSDIR)/attach/spec
aoqi@0: ATTACH2COREAPI := ../../$(JDKJRE2COREAPI)
aoqi@0: ATTACH_DOCTITLE := Attach API
aoqi@0: ATTACH_WINDOWTITLE := Attach API
aoqi@0: ATTACH_HEADER := Attach API
aoqi@0: ATTACH_BOTTOM := $(call CommonBottom,$(ATTACH_FIRST_COPYRIGHT_YEAR))
aoqi@0: # ATTACH_PKGS is located in NON_CORE_PKGS.gmk
aoqi@0:
aoqi@0: ATTACH_INDEX_HTML = $(ATTACH_DOCDIR)/index.html
aoqi@0: ATTACH_OPTIONS_FILE = $(DOCSTMPDIR)/attach.options
aoqi@0: ATTACH_PACKAGES_FILE = $(DOCSTMPDIR)/attach.packages
aoqi@0:
aoqi@0: attachdocs: $(ATTACH_INDEX_HTML)
aoqi@0:
aoqi@0: # Set relative location to core api document root
aoqi@0: $(ATTACH_INDEX_HTML): GET2DOCSDIR=$(ATTACH2COREAPI)/..
aoqi@0:
aoqi@0: # Run javadoc if the index file is out of date or missing
aoqi@0: $(ATTACH_INDEX_HTML): $(ATTACH_OPTIONS_FILE) $(ATTACH_PACKAGES_FILE) coredocs
aoqi@0: $(prep-javadoc)
aoqi@0: $(call JavadocSummary,$(ATTACH_OPTIONS_FILE),$(ATTACH_PACKAGES_FILE))
aoqi@0: $(JAVADOC_CMD) -d $(@D) \
aoqi@0: @$(ATTACH_OPTIONS_FILE) @$(ATTACH_PACKAGES_FILE)
aoqi@0:
aoqi@0: # Create file with javadoc options in it
aoqi@0: $(ATTACH_OPTIONS_FILE):
aoqi@0: $(prep-target)
aoqi@0: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
aoqi@0: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
aoqi@0: $(call OptionPair,-encoding,ascii) ; \
aoqi@0: $(call OptionOnly,-nodeprecatedlist) ; \
aoqi@0: $(call OptionPair,-doctitle,$(ATTACH_DOCTITLE)) ; \
aoqi@0: $(call OptionPair,-windowtitle,$(ATTACH_WINDOWTITLE) $(DRAFT_WINTITLE)); \
aoqi@0: $(call OptionPair,-header,$(ATTACH_HEADER)$(DRAFT_HEADER)) ; \
aoqi@0: $(call OptionPair,-bottom,$(ATTACH_BOTTOM)$(DRAFT_BOTTOM)) ; \
aoqi@0: $(call OptionTrip,-linkoffline,$(ATTACH2COREAPI),$(COREAPI_DOCSDIR)/); \
aoqi@0: ) >> $@
aoqi@0:
aoqi@0: # Create a file with the package names in it
aoqi@0: $(ATTACH_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(ATTACH_PKGS))
aoqi@0: $(prep-target)
aoqi@0: $(call PackageFilter,$(ATTACH_PKGS))
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # jconsoledocs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += jconsoledocs
aoqi@0:
aoqi@0: JCONSOLE_DOCDIR := $(JDK_API_DOCSDIR)/jconsole/spec
aoqi@0: JCONSOLE2COREAPI := ../../$(JDKJRE2COREAPI)
aoqi@0: JCONSOLE_DOCTITLE := JConsole API
aoqi@0: JCONSOLE_WINDOWTITLE := JConsole API
aoqi@0: JCONSOLE_HEADER := JConsole API
aoqi@0: JCONSOLE_BOTTOM := $(call CommonBottom,$(JCONSOLE_FIRST_COPYRIGHT_YEAR))
aoqi@0: # JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk
aoqi@0:
aoqi@0: JCONSOLE_INDEX_HTML = $(JCONSOLE_DOCDIR)/index.html
aoqi@0: JCONSOLE_OPTIONS_FILE = $(DOCSTMPDIR)/jconsole.options
aoqi@0: JCONSOLE_PACKAGES_FILE = $(DOCSTMPDIR)/jconsole.packages
aoqi@0:
aoqi@0: jconsoledocs: $(JCONSOLE_INDEX_HTML)
aoqi@0:
aoqi@0: # Set relative location to core api document root
aoqi@0: $(JCONSOLE_INDEX_HTML): GET2DOCSDIR=$(JCONSOLE2COREAPI)/..
aoqi@0:
aoqi@0: # Run javadoc if the index file is out of date or missing
aoqi@0: $(JCONSOLE_INDEX_HTML): $(JCONSOLE_OPTIONS_FILE) $(JCONSOLE_PACKAGES_FILE) coredocs
aoqi@0: $(prep-javadoc)
aoqi@0: $(call JavadocSummary,$(JCONSOLE_OPTIONS_FILE),$(JCONSOLE_PACKAGES_FILE))
aoqi@0: $(JAVADOC_CMD) -d $(@D) \
aoqi@0: @$(JCONSOLE_OPTIONS_FILE) @$(JCONSOLE_PACKAGES_FILE)
aoqi@0:
aoqi@0: # Create file with javadoc options in it
aoqi@0: $(JCONSOLE_OPTIONS_FILE):
aoqi@0: $(prep-target)
aoqi@0: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
aoqi@0: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
aoqi@0: $(call OptionPair,-encoding,ascii) ; \
aoqi@0: $(call OptionOnly,-nodeprecatedlist) ; \
aoqi@0: $(call OptionPair,-doctitle,$(JCONSOLE_DOCTITLE)) ; \
aoqi@0: $(call OptionPair,-windowtitle,$(JCONSOLE_WINDOWTITLE) $(DRAFT_WINTITLE)); \
aoqi@0: $(call OptionPair,-header,$(JCONSOLE_HEADER)$(DRAFT_HEADER)) ; \
aoqi@0: $(call OptionPair,-bottom,$(JCONSOLE_BOTTOM)$(DRAFT_BOTTOM)) ; \
aoqi@0: $(call OptionTrip,-linkoffline,$(JCONSOLE2COREAPI),$(COREAPI_DOCSDIR)/); \
aoqi@0: ) >> $@
aoqi@0:
aoqi@0: # Create a file with the package names in it
aoqi@0: $(JCONSOLE_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JCONSOLE_PKGS))
aoqi@0: $(prep-target)
aoqi@0: $(call PackageFilter,$(JCONSOLE_PKGS))
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # treeapidocs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += treeapidocs
aoqi@0:
aoqi@0: TREEAPI_DOCDIR := $(JDK_API_DOCSDIR)/javac/tree
aoqi@0: TREEAPI2COREAPI := ../../$(JDKJRE2COREAPI)
aoqi@0: TREEAPI_DOCTITLE := Compiler Tree API
aoqi@0: TREEAPI_WINDOWTITLE := Compiler Tree API
aoqi@0: TREEAPI_HEADER := Compiler Tree API
aoqi@0: TREEAPI_BOTTOM := $(call CommonBottom,$(TREEAPI_FIRST_COPYRIGHT_YEAR))
aoqi@0: TREEAPI_GROUPNAME := Packages
aoqi@0: TREEAPI_REGEXP := com.sun.source.*
aoqi@0: # TREEAPI_PKGS is located in NON_CORE_PKGS.gmk
aoqi@0:
aoqi@0: TREEAPI_INDEX_HTML = $(TREEAPI_DOCDIR)/index.html
aoqi@0: TREEAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options
aoqi@0: TREEAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages
aoqi@0:
aoqi@0: treeapidocs: $(TREEAPI_INDEX_HTML)
aoqi@0:
aoqi@0: # Set relative location to core api document root
aoqi@0: $(TREEAPI_INDEX_HTML): GET2DOCSDIR=$(TREEAPI2COREAPI)/..
aoqi@0:
aoqi@0: # Run javadoc if the index file is out of date or missing
aoqi@0: $(TREEAPI_INDEX_HTML): $(TREEAPI_OPTIONS_FILE) $(TREEAPI_PACKAGES_FILE) coredocs
aoqi@0: $(prep-javadoc)
aoqi@0: $(call JavadocSummary,$(TREEAPI_OPTIONS_FILE),$(TREEAPI_PACKAGES_FILE))
aoqi@0: $(JAVADOC_CMD) -d $(@D) \
aoqi@0: @$(TREEAPI_OPTIONS_FILE) @$(TREEAPI_PACKAGES_FILE)
aoqi@0:
aoqi@0: # Create file with javadoc options in it
aoqi@0: $(TREEAPI_OPTIONS_FILE):
aoqi@0: $(prep-target)
aoqi@0: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
aoqi@0: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
aoqi@0: $(call OptionPair,-encoding,ascii) ; \
aoqi@0: $(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \
aoqi@0: $(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
aoqi@0: $(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \
aoqi@0: $(call OptionPair,-tag,$(TAG_JLS)) ; \
aoqi@0: $(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
aoqi@0: $(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \
aoqi@0: $(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
aoqi@0: ) >> $@
aoqi@0:
aoqi@0: # Create a file with the package names in it
aoqi@0: $(TREEAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TREEAPI_PKGS))
aoqi@0: $(prep-target)
aoqi@0: $(call PackageFilter,$(TREEAPI_PKGS))
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
sundar@1207: # nashornapidocs
sundar@1207: #
sundar@1207:
sundar@1207: ALL_OTHER_TARGETS += nashornapidocs
sundar@1207:
sundar@1207: NASHORNAPI_DOCDIR := $(JDK_API_DOCSDIR)/nashorn
sundar@1207: NASHORNAPI2COREAPI := ../$(JDKJRE2COREAPI)
sundar@1207: NASHORNAPI_DOCTITLE := Nashorn API
sundar@1207: NASHORNAPI_WINDOWTITLE := Nashorn API
sundar@1207: NASHORNAPI_HEADER := Nashorn API
sundar@1207: NASHORNAPI_BOTTOM := $(call CommonBottom,$(NASHORNAPI_FIRST_COPYRIGHT_YEAR))
sundar@1207: NASHORNAPI_GROUPNAME := Packages
sundar@1214: NASHORNAPI_REGEXP := jdk.nashorn.api.scripting.*
sundar@1214:
sundar@1207: # NASHORNAPI_PKGS is located in NON_CORE_PKGS.gmk
sundar@1207:
sundar@1207: NASHORNAPI_INDEX_HTML = $(NASHORNAPI_DOCDIR)/index.html
sundar@1214: NASHORNAPI_OPTIONS_FILE = $(DOCSTMPDIR)/nashornapi.options
sundar@1214: NASHORNAPI_PACKAGES_FILE = $(DOCSTMPDIR)/nashornapi.packages
sundar@1207:
sundar@1214: nashornapidocs: $(NASHORNAPI_INDEX_HTML)
sundar@1207:
sundar@1207: # Set relative location to core api document root
sundar@1207: $(NASHORNAPI_INDEX_HTML): GET2DOCSDIR=$(NASHORNAPI2COREAPI)/..
sundar@1207:
sundar@1207: # Run javadoc if the index file is out of date or missing
sundar@1207: $(NASHORNAPI_INDEX_HTML): $(NASHORNAPI_OPTIONS_FILE) $(NASHORNAPI_PACKAGES_FILE) coredocs
sundar@1207: $(prep-javadoc)
sundar@1207: $(call JavadocSummary,$(NASHORNAPI_OPTIONS_FILE),$(NASHORNAPI_PACKAGES_FILE))
sundar@1207: $(JAVADOC_CMD) -d $(@D) \
sundar@1207: @$(NASHORNAPI_OPTIONS_FILE) @$(NASHORNAPI_PACKAGES_FILE)
sundar@1207:
sundar@1207: # Create file with javadoc options in it
sundar@1207: $(NASHORNAPI_OPTIONS_FILE):
sundar@1207: $(prep-target)
sundar@1207: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
sundar@1207: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
sundar@1207: $(call OptionPair,-encoding,ascii) ; \
sundar@1207: $(call OptionPair,-doctitle,$(NASHORNAPI_DOCTITLE)) ; \
sundar@1207: $(call OptionPair,-windowtitle,$(NASHORNAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
sundar@1207: $(call OptionPair,-header,$(NASHORNAPI_HEADER)$(DRAFT_HEADER)) ; \
sundar@1207: $(call OptionPair,-tag,$(TAG_JLS)) ; \
sundar@1207: $(call OptionPair,-bottom,$(NASHORNAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
sundar@1207: $(call OptionTrip,-group,$(NASHORNAPI_GROUPNAME),$(NASHORNAPI_REGEXP)); \
sundar@1207: $(call OptionTrip,-linkoffline,$(NASHORNAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
sundar@1207: ) >> $@
sundar@1207:
sundar@1207: # Create a file with the package names in it
sundar@1207: $(NASHORNAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(NASHORNAPI_PKGS))
sundar@1207: $(prep-target)
sundar@1207: $(call PackageFilter,$(NASHORNAPI_PKGS))
sundar@1207:
sundar@1207: #############################################################
sundar@1207: #
aoqi@0: # sctpdocs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += sctpdocs
aoqi@0:
aoqi@0: SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec
aoqi@0: SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
aoqi@0: SCTPAPI_DOCTITLE := SCTP API
aoqi@0: SCTPAPI_WINDOWTITLE := SCTP API
aoqi@0: SCTPAPI_HEADER := SCTP API
aoqi@0: SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR))
aoqi@0: # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk
aoqi@0:
aoqi@0: SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html
aoqi@0: SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options
aoqi@0: SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages
aoqi@0:
aoqi@0: sctpdocs: $(SCTPAPI_INDEX_HTML)
aoqi@0:
aoqi@0: # Set relative location to core api document root
aoqi@0: $(SCTPAPI_INDEX_HTML): GET2DOCSDIR=$(SCTPAPI2COREAPI)/..
aoqi@0:
aoqi@0: # Run javadoc if the index file is out of date or missing
aoqi@0: $(SCTPAPI_INDEX_HTML): $(SCTPAPI_OPTIONS_FILE) $(SCTPAPI_PACKAGES_FILE) coredocs
aoqi@0: $(prep-javadoc)
aoqi@0: $(call JavadocSummary,$(SCTPAPI_OPTIONS_FILE),$(SCTPAPI_PACKAGES_FILE))
aoqi@0: $(JAVADOC_CMD) -d $(@D) \
aoqi@0: @$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE)
aoqi@0:
aoqi@0: # Create file with javadoc options in it
aoqi@0: $(SCTPAPI_OPTIONS_FILE):
aoqi@0: $(prep-target)
aoqi@0: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
aoqi@0: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
aoqi@0: $(call OptionPair,-encoding,ascii) ; \
aoqi@0: $(call OptionOnly,-nodeprecatedlist) ; \
aoqi@0: $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \
aoqi@0: $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
aoqi@0: $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \
aoqi@0: $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
aoqi@0: $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
aoqi@0: ) >> $@
aoqi@0:
aoqi@0: # Create a file with the package names in it
aoqi@0: $(SCTPAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SCTPAPI_PKGS))
aoqi@0: $(prep-target)
aoqi@0: $(call PackageFilter,$(SCTPAPI_PKGS))
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
ptbrunet@1334: # jaccessdocs - Java Accessibility Utilities
ptbrunet@1334: #
ptbrunet@1334:
ptbrunet@1400: ALL_OTHER_TARGETS += jaccessdocs
ptbrunet@1334:
ptbrunet@1334: JACCESSAPI_DOCDIR := $(JRE_API_DOCSDIR)/accessibility/jaccess/spec
ptbrunet@1334: JACCESSAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
ptbrunet@1334: JACCESSAPI_DOCTITLE := JACCESS API
ptbrunet@1334: JACCESSAPI_WINDOWTITLE := JACCESS API
ptbrunet@1334: JACCESSAPI_HEADER := JACCESS API
ptbrunet@1334: JACCESSAPI_BOTTOM := $(call CommonBottom,$(JACCESSAPI_FIRST_COPYRIGHT_YEAR))
ptbrunet@1334: # JACCESSAPI_PKGS is located in NON_CORE_PKGS.gmk
ptbrunet@1334:
ptbrunet@1334: JACCESSAPI_INDEX_HTML = $(JACCESSAPI_DOCDIR)/index.html
ptbrunet@1334: JACCESSAPI_OPTIONS_FILE = $(DOCSTMPDIR)/jaccess.options
ptbrunet@1334: JACCESSAPI_PACKAGES_FILE = $(DOCSTMPDIR)/jaccess.packages
ptbrunet@1334:
ptbrunet@1334: jaccessdocs: $(JACCESSAPI_INDEX_HTML)
ptbrunet@1334:
ptbrunet@1334: # Set relative location to core api document root
ptbrunet@1334: $(JACCESSAPI_INDEX_HTML): GET2DOCSDIR=$(JACCESSAPI2COREAPI)/..
ptbrunet@1334:
ptbrunet@1334: # Run javadoc if the index file is out of date or missing
ptbrunet@1334: $(JACCESSAPI_INDEX_HTML): $(JACCESSAPI_OPTIONS_FILE) $(JACCESSAPI_PACKAGES_FILE) coredocs
ptbrunet@1334: $(prep-javadoc)
ptbrunet@1334: $(call JavadocSummary,$(JACCESSAPI_OPTIONS_FILE),$(JACCESSAPI_PACKAGES_FILE))
ptbrunet@1334: $(JAVADOC_CMD) -d $(@D) \
ptbrunet@1334: @$(JACCESSAPI_OPTIONS_FILE) @$(JACCESSAPI_PACKAGES_FILE)
ptbrunet@1334:
ptbrunet@1334: # Create file with javadoc options in it
ptbrunet@1334: $(JACCESSAPI_OPTIONS_FILE):
ptbrunet@1334: $(prep-target)
ptbrunet@1334: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
ptbrunet@1334: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
ptbrunet@1334: $(call OptionPair,-encoding,ascii) ; \
ptbrunet@1334: $(call OptionOnly,-nodeprecatedlist) ; \
ptbrunet@1334: $(call OptionPair,-doctitle,$(JACCESSAPI_DOCTITLE)) ; \
ptbrunet@1334: $(call OptionPair,-windowtitle,$(JACCESSAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
ptbrunet@1334: $(call OptionPair,-header,$(JACCESSAPI_HEADER)$(DRAFT_HEADER)) ; \
ptbrunet@1334: $(call OptionPair,-bottom,$(JACCESSAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
ptbrunet@1334: $(call OptionTrip,-linkoffline,$(JACCESSAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
ptbrunet@1334: ) >> $@
ptbrunet@1334:
ptbrunet@1334: # Create a file with the package names in it
ptbrunet@1334: $(JACCESSAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JACCESSAPI_PKGS))
ptbrunet@1334: $(prep-target)
ptbrunet@1334: $(call PackageFilter,$(JACCESSAPI_PKGS))
ptbrunet@1334:
ptbrunet@1334: #############################################################
ptbrunet@1334: #
aoqi@0: # jdk.net docs
aoqi@0: #
aoqi@0:
aoqi@0: ALL_OTHER_TARGETS += jdknetdocs
aoqi@0:
aoqi@0: JDKNET_DOCDIR := $(JRE_API_DOCSDIR)/net/socketoptions/spec
aoqi@0: JDKNET2COREAPI := ../../../$(JDKJRE2COREAPI)
aoqi@0: JDKNET_DOCTITLE := jdk.net API
aoqi@0: JDKNET_WINDOWTITLE := jdk.net API
aoqi@0: JDKNET_HEADER := jdk.net API
aoqi@0: JDKNET_BOTTOM := $(call CommonBottom,$(JDKNET_FIRST_COPYRIGHT_YEAR))
aoqi@0: JDKNET_PKGS := jdk.net
aoqi@0:
aoqi@0: JDKNET_INDEX_HTML = $(JDKNET_DOCDIR)/index.html
aoqi@0: JDKNET_OPTIONS_FILE = $(DOCSTMPDIR)/jdknet.options
aoqi@0: JDKNET_PACKAGES_FILE = $(DOCSTMPDIR)/jdknet.packages
aoqi@0:
aoqi@0: jdknetdocs: $(JDKNET_INDEX_HTML)
aoqi@0:
aoqi@0: # Set relative location to core api document root
aoqi@0: $(JDKNET_INDEX_HTML): GET2DOCSDIR=$(JDKNET2COREAPI)/..
aoqi@0:
aoqi@0: # Run javadoc if the index file is out of date or missing
aoqi@0: $(JDKNET_INDEX_HTML): $(JDKNET_OPTIONS_FILE) $(JDKNET_PACKAGES_FILE) coredocs
aoqi@0: $(prep-javadoc)
aoqi@0: $(call JavadocSummary,$(JDKNET_OPTIONS_FILE),$(JDKNET_PACKAGES_FILE))
aoqi@0: $(JAVADOC_CMD) -d $(@D) \
aoqi@0: @$(JDKNET_OPTIONS_FILE) @$(JDKNET_PACKAGES_FILE)
aoqi@0:
aoqi@0: # Create file with javadoc options in it
aoqi@0: $(JDKNET_OPTIONS_FILE):
aoqi@0: $(prep-target)
aoqi@0: @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
aoqi@0: $(call OptionOnly,-Xdoclint:none) ; \
aoqi@0: $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
aoqi@0: $(call OptionPair,-encoding,ascii) ; \
aoqi@0: $(call OptionOnly,-nodeprecatedlist) ; \
aoqi@0: $(call OptionPair,-doctitle,$(JDKNET_DOCTITLE)) ; \
aoqi@0: $(call OptionPair,-windowtitle,$(JDKNET_WINDOWTITLE) $(DRAFT_WINTITLE)); \
aoqi@0: $(call OptionPair,-header,$(JDKNET_HEADER)$(DRAFT_HEADER)); \
aoqi@0: $(call OptionPair,-bottom,$(JDKNET_BOTTOM)$(DRAFT_BOTTOM)); \
aoqi@0: $(call OptionTrip,-linkoffline,$(JDKNET2COREAPI),$(COREAPI_DOCSDIR)/); \
aoqi@0: ) >> $@
aoqi@0:
aoqi@0: # Create a file with the package names in it
aoqi@0: $(JDKNET_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JDKNET_PKGS))
aoqi@0: $(prep-target)
aoqi@0: $(call PackageFilter,$(JDKNET_PKGS))
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #
aoqi@0: # Get a cache of all the directories
aoqi@0:
aoqi@0: $(DIRECTORY_CACHE): $(ALL_EXISTING_SOURCE_DIRS)
aoqi@0: $(prep-target)
aoqi@0: @for cp in $(ALL_EXISTING_SOURCE_DIRS) ; do \
aoqi@0: $(ECHO) "$(FIND) $${cp} -type f >> $@"; \
aoqi@0: $(FIND) $${cp} -type f >> $@; \
aoqi@0: done
aoqi@0:
aoqi@0: #############################################################
aoqi@0: #release version of core packages ########
aoqi@0:
aoqi@0: # The rel-coredocs and rel-docs targets were added by Eric Armstrong. rel-coredocs
aoqi@0: # assumes the kind of large, 32-bit machine used in the javapubs group's docs-release
aoqi@0: # process. It specifies memory settings accordingly to maximize performance.
aoqi@0: #
aoqi@0: # The performance settings, like the sanity check, are most important for the core
aoqi@0: # docs--the platform APIs. Running javadoc on those APIs takes a significant amount
aoqi@0: # of time and memory. Setting the initial heap size as large as possible is important
aoqi@0: # to prevent thrashing as the heap grows. Setting the maximum as large as necessary
aoqi@0: # is also important to keep the job from failing.
aoqi@0: #
aoqi@0: # -J-Xmx512 sets a maximum of 512, which became necessary in 6.0
aoqi@0: # -J-Xms256 sets starting size to 256 (default is 8)
aoqi@0: #
aoqi@0: # rel-coredocs also includes a sanity check to help ensure that BUILD_NUMBER and
aoqi@0: # MILESTONE are specified properly when docs are built outside of the normal release
aoqi@0: # engineering process, with the intention of releasing them on the web or in a downloaded
aoqi@0: # docs bundle. (When invoked in release engineering's control build, the values are always
aoqi@0: # set properly. But when the targets are run by themselves, they default to b00 and
aoqi@0: # "internal"--which silently sabotage the result of a build that can take many hours
aoqi@0: # to complete.
aoqi@0:
aoqi@0: # Maximize performance and ensure that build number & milestone are set.
aoqi@0:
aoqi@0: rel-coredocs: sanitycheckcoredocs
aoqi@0: $(MAKE) coredocs
aoqi@0:
aoqi@0: rel-docs: rel-coredocs $(ALL_OTHER_TARGETS)
aoqi@0: #
aoqi@0: # end of production targets
aoqi@0:
aoqi@0: otherdocs: $(ALL_OTHER_TARGETS)
aoqi@0:
aoqi@0: clean:
aoqi@0: $(RM) -r $(DOCSDIR) $(DOCSTMPDIR)
aoqi@0:
aoqi@0: #############################################################
aoqi@0: # DEBUG TARGET
aoqi@0: # List the values defined in the makefile hierarchy, to make sure everything
aoqi@0: # is set properly, and to help identify values we can use instead of making new ones.
aoqi@0: # (Most of them come from common/shared/Defs.gmk)
aoqi@0: #
aoqi@0: # Notes:
aoqi@0: # * BUILD_NUMBER defaults to b00 if not set on command line with BUILD_NUMBER=
aoqi@0: # * MILESTONE defaults to internal unless set to beta, rc, or fcs on command line
aoqi@0: #
aoqi@0:
aoqi@0: #############################################################
aoqi@0: .PHONY: all docs coredocs rel-docs otherdocs rel-coredocs \
aoqi@0: sanitycheckcoredocs $(ALL_OTHER_TARGETS)