--- a/make/Javadoc.gmk Thu Nov 17 22:18:22 2016 +0000
+++ b/make/Javadoc.gmk Fri Nov 18 15:50:43 2016 +0100
@@ -55,12 +55,6 @@
# depend on it.
CORE_INDEX_FILE := $(JAVADOC_OUTPUTDIR)/api/index.html
-# Symbols
-TRADEMARK := ™
-COPYRIGHT_SYMBOL := &$(HASH)x00a9;
-COPYRIGHT_TEXT := Copyright
-ALL_RIGHTS_RESERVED := All rights reserved.
-
# URLs
JAVADOC_BASE_URL := http://docs.oracle.com/javase/$(VERSION_SPECIFICATION)/docs
BUG_SUBMIT_URL := http://bugreport.java.com/bugreport/
@@ -69,18 +63,16 @@
# Text snippets
FULL_COMPANY_NAME := Oracle and/or its affiliates
-COMPANY_ADDRESS := 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA.
+COMPANY_ADDRESS := 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA
BUG_SUBMIT_LINE := <a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a>
-JAVA_TRADEMARK_LINE := Java is a trademark or registered trademark of \
- $(FULL_COMPANY_NAME) in the US and other countries.
-COMMON_BOTTOM_ADDRESS := $(COMPANY_ADDRESS)
-COMMON_BOTTOM_TEXT := $(BUG_SUBMIT_LINE)<br>$(JAVA_TRADEMARK_LINE)
+COMMON_BOTTOM_TEXT := $(BUG_SUBMIT_LINE)<br> Java is a trademark or registered \
+ trademark of $(FULL_COMPANY_NAME) in the US and other countries.
CORE_BOTTOM_COPYRIGHT_URL := {@docroot}/../legal/cpyr.html
-CORE_BOTTOM_TEXT := $(BUG_SUBMIT_LINE)\
-<br>For further API reference and developer documentation, \
-see <a href="$(JAVADOC_BASE_URL)/index.html" target="_blank">Java SE \
+CORE_BOTTOM_TEXT := $(BUG_SUBMIT_LINE) \
+<br>For further API reference and developer documentation, see \
+<a href="$(JAVADOC_BASE_URL)/index.html" target="_blank">Java SE \
Documentation</a>. That documentation contains more detailed, \
developer-targeted descriptions, with conceptual overviews, definitions of \
terms, workarounds, and working code examples.
@@ -94,18 +86,19 @@
# We need a draft format when not building the GA version.
DRAFT_HEADER := <br><strong>DRAFT $(VERSION_STRING)</strong>
DRAFT_BOTTOM := <br><strong>DRAFT $(VERSION_STRING)</strong>
- DRAFT_WINTITLE := $(VERSION_BUILD)
+ ifeq ($(VERSION_BUILD), 0)
+ DRAFT_WINTITLE := [ad-hoc build]
+ else
+ DRAFT_WINTITLE := [build $(VERSION_BUILD)]
+ endif
CORE_TOP_EARLYACCESS := \
<div style="background-color: $$(HASH)EEEEEE"> \
<div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; \
-margin-left: 6px; margin-right: 6px; text-align: justify; \
-font-size: 80%; font-family: Helvetica, Arial, sans-serif; \
-font-weight: normal;"> \
-Please note that the specifications and other information \
-contained herein are not final and are subject to change. \
-The information is being made available to you solely for purpose of \
-evaluation. \
-</div> </div>
+margin-left: 6px; margin-right: 6px; text-align: justify; font-size: 80%; \
+font-family: Helvetica, Arial, sans-serif; font-weight: normal;"> \
+Please note that the specifications and other information contained herein are \
+not final and are subject to change. The information is being made available \
+to you solely for purpose of evaluation.</div></div>
endif
################################################################################
@@ -127,22 +120,17 @@
# Arguments:
# arg 1: first copyright year
# arg 2: copyright url (optional)
-# arg 3: company address (optional)
-# arg 4: free-form text snippet (optional)
+# arg 3: free-form text snippet (optional)
define GenerateBottom
- <font size="-1">$(if $(strip $4), $(strip $4))<br> $(if \
- $(strip $2),<a href="$(strip $2)">$(COPYRIGHT_TEXT)</a>,$(COPYRIGHT_TEXT)) \
- $(COPYRIGHT_SYMBOL) $(strip $1), $(COPYRIGHT_YEAR), \
- $(FULL_COMPANY_NAME). $(strip $3) \
- $(ALL_RIGHTS_RESERVED)$(if $(strip $4), )</font>
+ <font size="-1">$(if $(strip $3), $(strip $3))<br> $(if \
+ $(strip $2),<a href="$(strip $2)">Copyright</a>,Copyright) \
+ © $(strip $1), $(COPYRIGHT_YEAR), $(FULL_COMPANY_NAME). \
+ $(COMPANY_ADDRESS). All rights reserved.</font>
endef
# Speed up finding by filling cache
$(eval $(call FillCacheFind, $(wildcard $(JAVADOC_SOURCE_DIRS))))
-# Prevent # from expanding
-EscapeHash = $(subst $(HASH),{hash},$(strip $1))
-
################################################################################
# Setup make rules for running javadoc.
#
@@ -154,7 +142,6 @@
# Remaining parameters are named arguments. These include:
# MODULES - Modules to include
# PACKAGES - Packages to include
-# PACKAGE_FILTER - Filter for packages
# IS_CORE - Set to TRUE for the Core API package which needs special treatment
# API_ROOT - Where to base the documentation (jre or jdk)
# DEST_DIR - A directory relative to the API root
@@ -164,15 +151,10 @@
# HEADER_TITLE - Title to use in -header. Computed from TITLE if empty.
# DOC_TITLE - Title to use in -doctitle. Computed from TITLE if empty.
# FIRST_COPYRIGHT_YEAR - First year this bundle was introduced
-# DOCLINT - Doclint level. Defaults to "all".
+# DISABLED_DOCLINT - Doclint warnings to exclude.
# DOCLINT_PACKAGES - Optional -Xdoclint/package value
-# ENCODING - Change character encoding (defaults to 'ascii')
-# SPLIT_INDEX - Enable -splitIndex
-# BREAKITERATOR - Enable -breakiterator
-# NODEPRECATEDLIST - Enable nodeprecatedlist
-# NOINDEX - Enable -noindex and -nonavbar
+# SPLIT_INDEX - Enable -splitIndex (split index-all.html if it is too large)
# BOTTOM_COPYRIGHT_URL - Copyright URL to use in -bottom
-# BOTTOM_ADDRESS - Company address to use in -bottom
# BOTTOM_TEXT - Extra text to use in -bottom
# EXTRA_TOP - Additional -top data
#
@@ -185,16 +167,13 @@
$1_JAVA := $$(JAVA_SMALL)
$1_OUTPUT_DIRNAME := $$($1_API_ROOT)/api/$$($1_DEST_DIR)
- ifeq ($$($1_RELATIVE_CORE_DIR),)
- # Compute a relative path to core root.
- # The non-core api javadocs need to be able to access the root of the core
- # api directory, so for jdk/api or jre/api to get to the core api/
- # directory we would use this
- # NOTE: Need to be able to override for broken old code in JShell
- $1_RELATIVE_CORE_DIR := $$(strip $$(subst $$(call DirToDotDot, \
- $$(JAVADOC_OUTPUTDIR))/,, $$(call DirToDotDot, \
- $$(JAVADOC_OUTPUTDIR)/$$($1_OUTPUT_DIRNAME))))
- endif
+ # Compute a relative path to core root.
+ # The non-core api javadocs need to be able to access the root of the core
+ # api directory, so for jdk/api or jre/api to get to the core api/
+ # directory we would use this
+ $1_RELATIVE_CORE_DIR := $$(strip $$(subst $$(call DirToDotDot, \
+ $$(JAVADOC_OUTPUTDIR))/,, $$(call DirToDotDot, \
+ $$(JAVADOC_OUTPUTDIR)/$$($1_OUTPUT_DIRNAME))))
$1_DEPS += $(CORE_INDEX_FILE)
endif
@@ -203,12 +182,11 @@
$1_DEPS += $$($1_OVERVIEW)
endif
- ifeq ($$($1_ENCODING), )
- $1_ENCODING := ascii
- endif
-
- ifeq ($$($1_DOCLINT), )
+ ifeq ($$($1_DISABLED_DOCLINT), )
$1_DOCLINT := all
+ else
+ # Create a string like "all,-syntax,-html"
+ $1_DOCLINT := all,$$(call CommaList, $$(addprefix -, $$($1_DISABLED_DOCLINT)))
endif
ifeq ($$($1_DOC_TITLE), )
@@ -216,23 +194,27 @@
endif
ifeq ($$($1_WINDOW_TITLE), )
- $1_WINDOW_TITLE := $$(strip $$(subst $$(TRADEMARK),, $$($1_TITLE)))
+ $1_WINDOW_TITLE := $$(strip $$(subst ™,, $$($1_TITLE)))
endif
ifeq ($$($1_HEADER_TITLE), )
- $1_HEADER_TITLE := $$(strip $$(subst $$(TRADEMARK),, $$($1_TITLE)))
+ $1_HEADER_TITLE := $$(strip $$(subst ™,, $$($1_TITLE)))
endif
$1_HEADER := <strong>$$($1_HEADER_TITLE)</strong>
+ ifeq ($$($1_BOTTOM_TEXT), )
+ $1_BOTTOM_TEXT := $(COMMON_BOTTOM_TEXT)
+ endif
+
$1_BOTTOM := $$(call GenerateBottom, $$($1_FIRST_COPYRIGHT_YEAR), \
- $$($1_BOTTOM_COPYRIGHT_URL), $$($1_BOTTOM_ADDRESS), $$($1_BOTTOM_TEXT))
+ $$($1_BOTTOM_COPYRIGHT_URL), $$($1_BOTTOM_TEXT))
# The index.html, options, and packages files
$1_INDEX_FILE := $$(JAVADOC_OUTPUTDIR)/$$($1_OUTPUT_DIRNAME)/index.html
$1_OPTIONS_FILE := $$(SUPPORT_OUTPUTDIR)/docs/$1.options
$1_PACKAGES_FILE := $$(SUPPORT_OUTPUTDIR)/docs/$1.packages
- $1_PACKAGES_VARDEPS := $$($1_PACKAGES) $$($1_PACKAGES_SINGLE_CLASS)
+ $1_PACKAGES_VARDEPS := $$($1_PACKAGES)
$1_PACKAGES_VARDEPS_FILE := $$(call DependOnVariable, $1_PACKAGES_VARDEPS, \
$$($1_PACKAGES_FILE).vardeps)
@@ -240,24 +222,14 @@
$$($1_PACKAGES_FILE): $$($1_PACKAGES_VARDEPS_FILE)
$$(call LogInfo, Creating Javadoc package file for $1)
$$(call MakeDir, $$(@D))
- ifeq ($$($1_PACKAGES_SINGLE_CLASS), )
- $$(ECHO) $$($1_PACKAGES) | $$(TR) ' ' '\n' > $$@
- else
- # NOTE: This is for backwards compatibility for taglet
- $$(ECHO) $$($1_PACKAGES_SINGLE_CLASS) > $$@
- endif
+ $$(ECHO) $$($1_PACKAGES) | $$(TR) ' ' '\n' > $$@
- # NOTE: Not including $$($1_EXTRA_TOP) due to $$(HASH)
- $1_OPTIONS_VARDEPS := $$(call EscapeHash, \
- $$($DOCROOTPARENT_FLAG) $$(JAVADOC_BASE_URL) $$($1_NO_COMMON_TAGS) \
- $$($1_DOCLINT) $$($1_DOCLINT_PACKAGES) $$(JAVADOC_SOURCE_DIRS) \
- $$($1_MODULES) $$($1_ENCODING) $$($1_NODEPRECATEDLIST) \
- $$($1_BREAKITERATOR) $$($1_SPLIT_INDEX) $$($1_OVERVIEW) \
- $$($1_DOC_TITLE) $$($1_WINDOW_TITLE) $$(DRAFT_WINTITLE) \
- $$($1_HEADER) $$(DRAFT_HEADER) $$($1_NOINDEX) $$($1_EXTRA_TOP_2) \
- $$($1_BOTTOM) $$(DRAFT_BOTTOM)) $$($1_PACKAGE_FILTER) $$($1_RELATIVE_CORE_DIR) \
- $$(JAVADOC_OUTPUTDIR) \
- )
+ $1_OPTIONS_VARDEPS := $$($1_EXTRA_TOP) \
+ $$($DOCROOTPARENT_FLAG) $$(JAVADOC_BASE_URL) $$($1_DISABLED_DOCLINT) \
+ $$($1_DOCLINT_PACKAGES) $$(JAVADOC_SOURCE_DIRS) $$($1_MODULES) \
+ $$($1_SPLIT_INDEX) $$($1_OVERVIEW) $$($1_DOC_TITLE) $$($1_WINDOW_TITLE) \
+ $$(DRAFT_WINTITLE) $$($1_HEADER) $$(DRAFT_HEADER) $$($1_BOTTOM) \
+ $$(DRAFT_BOTTOM)) $$($1_RELATIVE_CORE_DIR) $$(JAVADOC_OUTPUTDIR)
$1_OPTIONS_VARDEPS_FILE := $$(call DependOnVariable, $1_OPTIONS_VARDEPS, \
$$($1_OPTIONS_FILE).vardeps)
@@ -273,35 +245,32 @@
$$(call AddOption, -use)
$$(call AddOption, -keywords)
ifneq ($$($DOCROOTPARENT_FLAG), )
- # NOTE: Argument to -Xdocrootparent is not quoted to keep backwards compatibility.
- $$(call AddOption, -Xdocrootparent $(JAVADOC_BASE_URL))
+ $$(call AddOption, -Xdocrootparent, $(JAVADOC_BASE_URL))
endif
- ifneq ($$($1_NO_COMMON_TAGS), TRUE)
- # In order to get a specific ordering it's necessary to specify the total
- # ordering of tags as the tags are otherwise ordered in order of definition.
- $$(call AddOption, -tag, beaninfo:X)
- $$(call AddOption, -tag, revised:X)
- $$(call AddOption, -tag, since.unbundled:X)
- $$(call AddOption, -tag, spec:X)
- $$(call AddOption, -tag, specdefault:X)
- $$(call AddOption, -tag, Note:X)
- $$(call AddOption, -tag, ToDo:X)
- $$(call AddOption, -tag, apiNote:a:API Note:)
- $$(call AddOption, -tag, implSpec:a:Implementation Requirements:)
- $$(call AddOption, -tag, implNote:a:Implementation Note:)
- $$(call AddOption, -tag, param)
- $$(call AddOption, -tag, return)
- $$(call AddOption, -tag, throws)
- $$(call AddOption, -tag, since)
- $$(call AddOption, -tag, version)
- $$(call AddOption, -tag, serialData)
- $$(call AddOption, -tag, factory)
- $$(call AddOption, -tag, see)
- $$(call AddOption, -tag, \
- jvms:a:See <cite> The Java™ Virtual Machine Specification</cite>:)
- $$(call AddOption, -tag, \
- jls:a:See <cite> The Java™ Language Specification</cite>:)
- endif
+ # In order to get a specific ordering it's necessary to specify the total
+ # ordering of tags as the tags are otherwise ordered in order of definition.
+ $$(call AddOption, -tag, beaninfo:X)
+ $$(call AddOption, -tag, revised:X)
+ $$(call AddOption, -tag, since.unbundled:X)
+ $$(call AddOption, -tag, spec:X)
+ $$(call AddOption, -tag, specdefault:X)
+ $$(call AddOption, -tag, Note:X)
+ $$(call AddOption, -tag, ToDo:X)
+ $$(call AddOption, -tag, apiNote:a:API Note:)
+ $$(call AddOption, -tag, implSpec:a:Implementation Requirements:)
+ $$(call AddOption, -tag, implNote:a:Implementation Note:)
+ $$(call AddOption, -tag, param)
+ $$(call AddOption, -tag, return)
+ $$(call AddOption, -tag, throws)
+ $$(call AddOption, -tag, since)
+ $$(call AddOption, -tag, version)
+ $$(call AddOption, -tag, serialData)
+ $$(call AddOption, -tag, factory)
+ $$(call AddOption, -tag, see)
+ $$(call AddOption, -tag, \
+ jvms:a:See <cite> The Java™ Virtual Machine Specification</cite>:)
+ $$(call AddOption, -tag, \
+ jls:a:See <cite> The Java™ Language Specification</cite>:)
$$(call AddOption, -Xdoclint:$$($1_DOCLINT))
ifneq ($$($1_DOCLINT_PACKAGES), )
$$(call AddOption, -Xdoclint/package:$$(call CommaList, $$($1_DOCLINT_PACKAGES)))
@@ -309,13 +278,10 @@
$$(call AddOption, --system, none)
$$(call AddOption, --module-source-path, $$(subst ",, $$(call PathList, $$(JAVADOC_SOURCE_DIRS))))
$$(call AddOption, --add-modules, $$(call CommaList, $$($1_MODULES)))
- $$(call AddOption, -encoding, $$($1_ENCODING))
- ifneq ($$($1_NODEPRECATEDLIST), )
- $$(call AddOption, -nodeprecatedlist)
- endif
- ifneq ($$($1_BREAKITERATOR), )
- $$(call AddOption, -breakiterator)
- endif
+ $$(call AddOption, -encoding, ISO-8859-1)
+ $$(call AddOption, -breakiterator)
+ $$(call AddOption, -serialwarn)
+ $$(call AddOption, -notimestamp)
ifneq ($$($1_SPLIT_INDEX), )
$$(call AddOption, -splitIndex)
endif
@@ -325,17 +291,7 @@
$$(call AddOption, -doctitle, $$($1_DOC_TITLE))
$$(call AddOption, -windowtitle, $$($1_WINDOW_TITLE) $$(DRAFT_WINTITLE))
$$(call AddOption, -header, $$($1_HEADER)$$(DRAFT_HEADER))
- ifneq ($$($1_NOINDEX), )
- $$(call AddOption, -nonavbar)
- $$(call AddOption, -noindex)
- endif
- ifneq ($$($1_EXTRA_TOP_2), )
- $$(call AddOption, -top,$$($1_EXTRA_TOP_2))
- endif
$$(call AddOption, -bottom, $$($1_BOTTOM)$$(DRAFT_BOTTOM))
- ifneq ($$($1_PACKAGE_FILTER), )
- $$(call AddOption, -group, Packages, $$($1_PACKAGE_FILTER))
- endif
ifneq ($$($1_RELATIVE_CORE_DIR), )
$$(call AddOption, -linkoffline, $$($1_RELATIVE_CORE_DIR)/api, $$(JAVADOC_OUTPUTDIR)/api/)
endif
@@ -367,232 +323,34 @@
################################################################################
-CORE_PACKAGES := \
- java.applet \
- java.awt \
- java.awt.color \
- java.awt.datatransfer \
- java.awt.desktop \
- java.awt.dnd \
- java.awt.event \
- java.awt.font \
- java.awt.geom \
- java.awt.im \
- java.awt.im.spi \
- java.awt.image \
- java.awt.image.renderable \
- java.awt.print \
- java.beans \
- java.beans.beancontext \
- java.io \
- java.lang \
- java.lang.annotation \
- java.lang.instrument \
- java.lang.invoke \
- java.lang.management \
- java.lang.module \
- java.lang.ref \
- java.lang.reflect \
- java.math \
- java.net \
- java.net.http \
- java.net.spi \
- java.nio \
- java.nio.channels \
- java.nio.channels.spi \
- java.nio.charset \
- java.nio.charset.spi \
- java.nio.file \
- java.nio.file.attribute \
- java.nio.file.spi \
- java.rmi \
- java.rmi.activation \
- java.rmi.dgc \
- java.rmi.registry \
- java.rmi.server \
- java.security \
- java.security.acl \
- java.security.cert \
- java.security.interfaces \
- java.security.spec \
- java.sql \
- java.text \
- java.text.spi \
- java.time \
- java.time.chrono \
- java.time.format \
- java.time.temporal \
- java.time.zone \
- java.util \
- java.util.concurrent \
- java.util.concurrent.atomic \
- java.util.concurrent.locks \
- java.util.function \
- java.util.jar \
- java.util.logging \
- java.util.prefs \
- java.util.regex \
- java.util.spi \
- java.util.stream \
- java.util.zip \
- javax.accessibility \
- javax.activation \
- javax.activity \
- javax.annotation \
- javax.annotation.processing \
- javax.crypto \
- javax.crypto.interfaces \
- javax.crypto.spec \
- javax.imageio \
- javax.imageio.event \
- javax.imageio.metadata \
- javax.imageio.plugins.jpeg \
- javax.imageio.plugins.bmp \
- javax.imageio.plugins.tiff \
- javax.imageio.spi \
- javax.imageio.stream \
- javax.jws \
- javax.jws.soap \
- javax.lang.model \
- javax.lang.model.element \
- javax.lang.model.type \
- javax.lang.model.util \
- javax.management \
- javax.management.loading \
- javax.management.monitor \
- javax.management.relation \
- javax.management.openmbean \
- javax.management.timer \
- javax.management.modelmbean \
- javax.management.remote \
- javax.management.remote.rmi \
- javax.naming \
- javax.naming.directory \
- javax.naming.event \
- javax.naming.ldap \
- javax.naming.spi \
- javax.net \
- javax.net.ssl \
- javax.print \
- javax.print.attribute \
- javax.print.attribute.standard \
- javax.print.event \
- javax.rmi \
- javax.rmi.CORBA \
- javax.rmi.ssl \
- javax.script \
- javax.security.auth \
- javax.security.auth.callback \
- javax.security.auth.kerberos \
- javax.security.auth.login \
- javax.security.auth.spi \
- javax.security.auth.x500 \
- javax.security.cert \
- javax.security.sasl \
- javax.sound.sampled \
- javax.sound.sampled.spi \
- javax.sound.midi \
- javax.sound.midi.spi \
- javax.sql \
- javax.sql.rowset \
- javax.sql.rowset.serial \
- javax.sql.rowset.spi \
- javax.swing \
- javax.swing.border \
- javax.swing.colorchooser \
- javax.swing.filechooser \
- javax.swing.event \
- javax.swing.table \
- javax.swing.text \
- javax.swing.text.html \
- javax.swing.text.html.parser \
- javax.swing.text.rtf \
- javax.swing.tree \
- javax.swing.undo \
- javax.swing.plaf \
- javax.swing.plaf.basic \
- javax.swing.plaf.metal \
- javax.swing.plaf.multi \
- javax.swing.plaf.nimbus \
- javax.swing.plaf.synth \
- javax.tools \
- javax.transaction \
- javax.transaction.xa \
- javax.xml.catalog \
- javax.xml.parsers \
- javax.xml.bind \
- javax.xml.bind.annotation \
- javax.xml.bind.annotation.adapters \
- javax.xml.bind.attachment \
- javax.xml.bind.helpers \
- javax.xml.bind.util \
- javax.xml.soap \
- javax.xml.ws \
- javax.xml.ws.handler \
- javax.xml.ws.handler.soap \
- javax.xml.ws.http \
- javax.xml.ws.soap \
- javax.xml.ws.spi \
- javax.xml.ws.spi.http \
- javax.xml.ws.wsaddressing \
- javax.xml.transform \
- javax.xml.transform.sax \
- javax.xml.transform.dom \
- javax.xml.transform.stax \
- javax.xml.transform.stream \
- javax.xml \
- javax.xml.crypto \
- javax.xml.crypto.dom \
- javax.xml.crypto.dsig \
- javax.xml.crypto.dsig.dom \
- javax.xml.crypto.dsig.keyinfo \
- javax.xml.crypto.dsig.spec \
- javax.xml.datatype \
- javax.xml.validation \
- javax.xml.namespace \
- javax.xml.xpath \
- javax.xml.stream \
- javax.xml.stream.events \
- javax.xml.stream.util \
- org.ietf.jgss \
- org.omg.CORBA \
- org.omg.CORBA.DynAnyPackage \
- org.omg.CORBA.ORBPackage \
- org.omg.CORBA.TypeCodePackage \
- org.omg.stub.java.rmi \
- org.omg.CORBA.portable \
- org.omg.CORBA_2_3 \
- org.omg.CORBA_2_3.portable \
- org.omg.CosNaming \
- org.omg.CosNaming.NamingContextExtPackage \
- org.omg.CosNaming.NamingContextPackage \
- org.omg.SendingContext \
- org.omg.PortableServer \
- org.omg.PortableServer.CurrentPackage \
- org.omg.PortableServer.POAPackage \
- org.omg.PortableServer.POAManagerPackage \
- org.omg.PortableServer.ServantLocatorPackage \
- org.omg.PortableServer.portable \
- org.omg.PortableInterceptor \
- org.omg.PortableInterceptor.ORBInitInfoPackage \
- org.omg.Messaging \
- org.omg.IOP \
- org.omg.IOP.CodecFactoryPackage \
- org.omg.IOP.CodecPackage \
- org.omg.Dynamic \
- org.omg.DynamicAny \
- org.omg.DynamicAny.DynAnyPackage \
- org.omg.DynamicAny.DynAnyFactoryPackage \
- org.w3c.dom \
- org.w3c.dom.events \
- org.w3c.dom.bootstrap \
- org.w3c.dom.ls \
- org.w3c.dom.ranges \
- org.w3c.dom.traversal \
- org.w3c.dom.views \
- org.xml.sax \
- org.xml.sax.ext \
- org.xml.sax.helpers
+# Core packages are all packages beginning with java, javax or org, except a few
+# excludes.
+
+ALL_PKG_DIRS := $(dir $(filter %.java, $(call CacheFind, \
+ $(wildcard $(JAVADOC_SOURCE_DIRS)))))
+ALL_SRC_PREFIXES := $(addsuffix /%, $(wildcard $(JAVADOC_SOURCE_DIRS)))
+ALL_PKG_DIRNAMES := $(foreach prefix, $(ALL_SRC_PREFIXES), \
+ $(patsubst $(prefix),%, $(filter $(prefix), $(ALL_PKG_DIRS))))
+ALL_PACKAGES := $(sort $(subst /,., $(patsubst %/, %, $(ALL_PKG_DIRNAMES))))
+
+JAVA_PACKAGES := $(filter java.%, $(ALL_PACKAGES))
+JAVAX_PACKAGES := $(filter javax.%, $(ALL_PACKAGES))
+ORG_PACKAGES := $(filter org.%, $(ALL_PACKAGES))
+
+# Allow custom makefile to add more excluded packages
+CORE_EXCLUDED_PACKAGES += \
+ java.awt.dnd.peer \
+ java.awt.peer \
+ javax.smartcardio \
+ org.jcp.xml.dsig.internal% \
+ org.w3c.dom.css \
+ org.w3c.dom.html \
+ org.w3c.dom.stylesheets \
+ org.w3c.dom.xpath \
+ #
+
+CORE_PACKAGES := $(filter-out $(CORE_EXCLUDED_PACKAGES), \
+ $(JAVA_PACKAGES) $(JAVAX_PACKAGES) $(ORG_PACKAGES))
$(eval $(call SetupJavadocGeneration, coredocs, \
MODULES := java.se.ee, \
@@ -600,13 +358,12 @@
IS_CORE := TRUE, \
OVERVIEW := $(JDK_TOPDIR)/src/java.base/share/classes/overview-core.html, \
WINDOW_TITLE := Java Platform SE $(VERSION_SPECIFICATION), \
- HEADER_TITLE := Java$(TRADEMARK) Platform<br>Standard Ed. $(VERSION_SPECIFICATION), \
- DOC_TITLE := Java$(TRADEMARK) Platform$(COMMA) Standard Edition \
+ HEADER_TITLE := Java™ Platform<br>Standard Ed. $(VERSION_SPECIFICATION), \
+ DOC_TITLE := Java™ Platform$(COMMA) Standard Edition \
$(VERSION_SPECIFICATION)<br>API Specification, \
FIRST_COPYRIGHT_YEAR := 1993, \
- DOCLINT := reference, \
+ DISABLED_DOCLINT := accessibility html missing syntax, \
DOCLINT_PACKAGES := -org.omg.* jdk.internal.logging.*, \
- ENCODING := ISO-8859-1, \
SPLIT_INDEX := TRUE, \
BOTTOM_COPYRIGHT_URL := $(CORE_BOTTOM_COPYRIGHT_URL), \
BOTTOM_TEXT := $(CORE_BOTTOM_TEXT), \
@@ -623,14 +380,10 @@
jdk.javadoc.doclet \
jdk.javadoc.doclet.taglet \
jdk.javadoc.doclets, \
- PACKAGE_FILTER := jdk.javadoc.doclet*, \
API_ROOT := jdk, \
DEST_DIR := javadoc/doclet, \
TITLE := Doclet API, \
FIRST_COPYRIGHT_YEAR := 1993, \
- BREAKITERATOR := TRUE, \
- BOTTOM_ADDRESS := $(COMMON_BOTTOM_ADDRESS), \
- BOTTOM_TEXT := $(COMMON_BOTTOM_TEXT), \
))
TARGETS += $(docletapi)
@@ -640,36 +393,23 @@
$(eval $(call SetupJavadocGeneration, old-docletapi, \
MODULES := jdk.javadoc, \
PACKAGES := com.sun.javadoc, \
- PACKAGE_FILTER := com.sun.javadoc, \
API_ROOT := jdk, \
DEST_DIR := javadoc/old/doclet, \
TITLE := Doclet API, \
FIRST_COPYRIGHT_YEAR := 1993, \
- BREAKITERATOR := TRUE, \
- BOTTOM_ADDRESS := $(COMMON_BOTTOM_ADDRESS), \
- BOTTOM_TEXT := $(COMMON_BOTTOM_TEXT), \
))
TARGETS += $(old-docletapi)
################################################################################
-# Specify a single class instead of a package
-TAGLET_PACKAGE_SINGLE_CLASS := com/sun/tools/doclets/Taglet.java
-TAGLET_PACKAGE_DIR := $(LANGTOOLS_TOPDIR)/src/jdk.javadoc/share/classes
-
$(eval $(call SetupJavadocGeneration, tagletapi, \
MODULES := jdk.javadoc, \
PACKAGES := com.sun.tools.doclets, \
- PACKAGES_SINGLE_CLASS := $(TAGLET_PACKAGE_DIR)/$(TAGLET_PACKAGE_SINGLE_CLASS), \
API_ROOT := jdk, \
DEST_DIR := javadoc/old/taglet, \
TITLE := Taglet API, \
FIRST_COPYRIGHT_YEAR := 1993, \
- BREAKITERATOR := TRUE, \
- NOINDEX := TRUE, \
- BOTTOM_ADDRESS := $(COMMON_BOTTOM_ADDRESS), \
- BOTTOM_TEXT := $(COMMON_BOTTOM_TEXT), \
))
TARGETS += $(tagletapi)
@@ -691,15 +431,12 @@
org.w3c.dom.css \
org.w3c.dom.events \
org.w3c.dom.views, \
- PACKAGE_FILTER := org.w3c.dom*, \
API_ROOT := jre, \
DEST_DIR := plugin/dom, \
TITLE := Common DOM API, \
FIRST_COPYRIGHT_YEAR := 2005, \
- DOCLINT := none, \
+ DISABLED_DOCLINT := accessibility html missing, \
SPLIT_INDEX := TRUE, \
- BOTTOM_ADDRESS := $(COMMON_BOTTOM_ADDRESS), \
- BOTTOM_TEXT := $(COMMON_BOTTOM_TEXT), \
))
TARGETS += $(domapi)
@@ -717,9 +454,10 @@
API_ROOT := jdk, \
DEST_DIR := jpda/jdi, \
OVERVIEW := $(JDK_TOPDIR)/src/jdk.jdi/share/classes/jdi-overview.html, \
- TITLE := Java$(TRADEMARK) Debug Interface, \
+ TITLE := Java™ Debug Interface, \
FIRST_COPYRIGHT_YEAR := 1999, \
- DOCLINT := none, \
+ DISABLED_DOCLINT := accessibility missing syntax, \
+ SPLIT_INDEX := TRUE, \
))
TARGETS += $(jdi)
@@ -736,9 +474,9 @@
API_ROOT := jre, \
DEST_DIR := security/jaas/spec, \
OVERVIEW := $(JDK_TOPDIR)/src/jdk.security.auth/share/classes/jaas-overview.html, \
- TITLE := Java$(TRADEMARK) Authentication and Authorization Service, \
+ TITLE := Java™ Authentication and Authorization Service, \
FIRST_COPYRIGHT_YEAR := 1998, \
- DOCLINT := none, \
+ DISABLED_DOCLINT := missing, \
))
TARGETS += $(jaas)
@@ -751,10 +489,8 @@
API_ROOT := jre, \
DEST_DIR := security/jgss/spec, \
OVERVIEW := $(JDK_TOPDIR)/src/java.security.jgss/share/classes/jgss-overview.html, \
- TITLE := Java$(TRADEMARK) GSS-API Utilities, \
+ TITLE := Java™ GSS-API Utilities, \
FIRST_COPYRIGHT_YEAR := 2000, \
- DOCLINT := none, \
- NODEPRECATEDLIST := TRUE, \
))
TARGETS += $(jgss)
@@ -766,10 +502,8 @@
PACKAGES := javax.smartcardio, \
API_ROOT := jre, \
DEST_DIR := security/smartcardio/spec, \
- TITLE := Java$(TRADEMARK) Smart Card I/O, \
+ TITLE := Java™ Smart Card I/O, \
FIRST_COPYRIGHT_YEAR := 2005, \
- DOCLINT := none, \
- NODEPRECATEDLIST := TRUE, \
))
TARGETS += $(smartcardio)
@@ -783,10 +517,9 @@
com.sun.net.httpserver.spi, \
API_ROOT := jre, \
DEST_DIR := net/httpserver/spec, \
- TITLE := Java$(TRADEMARK) HTTP Server, \
+ TITLE := Java™ HTTP Server, \
FIRST_COPYRIGHT_YEAR := 2005, \
- DOCLINT := none, \
- NODEPRECATEDLIST := TRUE, \
+ DISABLED_DOCLINT := accessibility missing syntax, \
))
TARGETS += $(httpserver)
@@ -799,9 +532,7 @@
API_ROOT := jre, \
DEST_DIR := plugin/jsobject, \
FIRST_COPYRIGHT_YEAR := 1993, \
- TITLE := Java$(TRADEMARK) JSObject Doc, \
- DOCLINT := none, \
- NODEPRECATEDLIST := TRUE, \
+ TITLE := Java™ JSObject Doc, \
))
TARGETS += $(jsobject)
@@ -814,10 +545,9 @@
API_ROOT := jre, \
DEST_DIR := management/extension, \
OVERVIEW := $(JDK_TOPDIR)/src/java.management/share/classes/mgmt-overview.html, \
- TITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform, \
+ TITLE := Monitoring and Management Interface for the Java™ Platform, \
FIRST_COPYRIGHT_YEAR := 2003, \
- DOCLINT := none, \
- NODEPRECATEDLIST := TRUE, \
+ DISABLED_DOCLINT := accessibility missing reference, \
))
TARGETS += $(mgmt)
@@ -833,8 +563,7 @@
DEST_DIR := attach/spec, \
TITLE := Attach API, \
FIRST_COPYRIGHT_YEAR := 2005, \
- DOCLINT := none, \
- NODEPRECATEDLIST := TRUE, \
+ DISABLED_DOCLINT := reference, \
))
TARGETS += $(attach)
@@ -848,15 +577,12 @@
DEST_DIR := jconsole/spec, \
TITLE := JConsole API, \
FIRST_COPYRIGHT_YEAR := 2006, \
- DOCLINT := none, \
- NODEPRECATEDLIST := TRUE, \
))
TARGETS += $(jconsole)
################################################################################
-# NOTE: Need to override RELATIVE_CORE_DIR to be bug compatible with old code.
$(eval $(call SetupJavadocGeneration, jshellapi, \
MODULES := jdk.jshell, \
PACKAGES := \
@@ -865,10 +591,8 @@
jdk.jshell.execution, \
API_ROOT := jdk, \
DEST_DIR := jshell, \
- RELATIVE_CORE_DIR := ../../../.., \
OVERVIEW := $(LANGTOOLS_TOPDIR)/src/jdk.jshell/share/classes/jdk/jshell/overview.html, \
TITLE := JShell API, \
- HEADER_TITLE := JSHELL API, \
FIRST_COPYRIGHT_YEAR := 2015, \
))
@@ -882,11 +606,11 @@
com.sun.source.doctree \
com.sun.source.tree \
com.sun.source.util, \
- PACKAGE_FILTER := com.sun.source.*, \
API_ROOT := jdk, \
DEST_DIR := javac/tree, \
TITLE := Compiler Tree API, \
FIRST_COPYRIGHT_YEAR := 2005, \
+ SPLIT_INDEX := TRUE, \
))
TARGETS += $(treeapi)
@@ -898,11 +622,11 @@
PACKAGES := \
jdk.nashorn.api.scripting \
jdk.nashorn.api.tree, \
- PACKAGE_FILTER := jdk.nashorn.api.*, \
API_ROOT := jdk, \
DEST_DIR := nashorn, \
TITLE := Nashorn API, \
FIRST_COPYRIGHT_YEAR := 2014, \
+ SPLIT_INDEX := TRUE, \
))
TARGETS += $(nashornapi)
@@ -934,8 +658,6 @@
DEST_DIR := nio/sctp/spec, \
TITLE := SCTP API, \
FIRST_COPYRIGHT_YEAR := 2009, \
- DOCLINT := none, \
- NODEPRECATEDLIST := TRUE, \
))
TARGETS += $(sctp)
@@ -949,7 +671,6 @@
DEST_DIR := accessibility/jaccess/spec, \
TITLE := JACCESS API, \
FIRST_COPYRIGHT_YEAR := 2002, \
- NODEPRECATEDLIST := TRUE, \
))
TARGETS += $(jaccess)
@@ -963,8 +684,7 @@
DEST_DIR := net/socketoptions/spec, \
TITLE := jdk.net API, \
FIRST_COPYRIGHT_YEAR := 2014, \
- DOCLINT := none, \
- NODEPRECATEDLIST := TRUE, \
+ DISABLED_DOCLINT := missing, \
))
TARGETS += $(jdknet)
@@ -980,8 +700,7 @@
DEST_DIR := jlink, \
TITLE := JLink Plugin API - EXPERIMENTAL, \
FIRST_COPYRIGHT_YEAR := 2015, \
- DOCLINT := none, \
- NODEPRECATEDLIST := TRUE, \
+ DISABLED_DOCLINT := html missing syntax, \
))
TARGETS += $(jlinkplugins)