stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8182408: Simplify the API-specification overview page

Browse Source 
Reviewed-by: erikj, mchung, jrose, alanb
This commit is contained in:
Mark Reinhold 2017-06-19 18:20:42 +02:00
parent 86c833ef23
commit 8906ca8e00
1 changed files with 46 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
make/Docs.gmk
View File

@ -116,9 +116,9 @@ endif
# General text snippets # General text snippets
FULL_COMPANY_NAME := Oracle and/or its affiliates FULL_COMPANY_NAME := Oracle and/or its affiliates
COMPANY_ADDRESS := 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA COMPANY_ADDRESS := 500 Oracle Parkway, Redwood Shores, CA 94065 USA
JAVA_PLATFORM := Java&trade; Platform JAVA_PLATFORM := Java Platform
ifeq ($(IS_DRAFT), true) ifeq ($(IS_DRAFT), true)
DRAFT_MARKER_STR := <br><strong>DRAFT $(VERSION_STRING)</strong> DRAFT_MARKER_STR := <br><strong>DRAFT $(VERSION_STRING)</strong>
@ -127,46 +127,44 @@ ifeq ($(IS_DRAFT), true)
else else
DRAFT_MARKER_TITLE := [build $(VERSION_BUILD)] DRAFT_MARKER_TITLE := [build $(VERSION_BUILD)]
endif endif
DRAFT_TEXT := Please note that the specifications and other information \ DRAFT_TEXT := This specification is not final and is subject to change. \
contained herein are not final and are subject to change. The \ Use is subject to <a href="$(LICENSE_URL)">license terms</a>.
information is being made available to you solely for purpose of \
evaluation.
endif endif
JAVADOC_BOTTOM := \ JAVADOC_BOTTOM := \
<span style="font-size:smaller"> \ <a href="$(BUG_SUBMIT_URL)">Report a bug or suggest an enhancement</a><br> \
<a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a><br> \ For further API reference and developer documentation see the \
For further API reference and developer documentation, see \
<a href="$(JAVADOC_BASE_URL)" target="_blank">Java SE \ <a href="$(JAVADOC_BASE_URL)" target="_blank">Java SE \
Documentation</a>. That documentation contains more detailed, \ Documentation</a>, which contains more detailed, \
developer-targeted descriptions, with conceptual overviews, definitions \ developer-targeted descriptions with conceptual overviews, definitions \
of terms, workarounds, and working code examples.<br> \ of terms, workarounds, and working code examples.<br> \
Java is a trademark or registered trademark of $(FULL_COMPANY_NAME) in \ Java is a trademark or registered trademark of $(FULL_COMPANY_NAME) in \
the US and other countries.<br> \ the US and other countries.<br> \
<a href="$(COPYRIGHT_URL)">Copyright</a> \ <a href="$(COPYRIGHT_URL)">Copyright</a> \
&copy; 1993, $(COPYRIGHT_YEAR), $(FULL_COMPANY_NAME). \ &copy; 1993, $(COPYRIGHT_YEAR), $(FULL_COMPANY_NAME), \
$(COMPANY_ADDRESS). All rights reserved. \ $(COMPANY_ADDRESS).<br>All rights reserved. \
Use is subject to <a href="$(LICENSE_URL)">license terms</a>. Also see the \ Use is subject to <a href="$(LICENSE_URL)">license terms</a> and the \
<a href="$(REDISTRIBUTION_URL)">documentation redistribution policy</a>. \ <a href="$(REDISTRIBUTION_URL)">documentation redistribution policy</a>. \
$(DRAFT_MARKER_STR)</span> $(DRAFT_MARKER_STR) <!-- Version $(VERSION_STRING) -->
JAVADOC_TOP := \ JAVADOC_TOP := \
<div style="background-color: $(HASH)EEEEEE"><div style="padding: 6px; \ <div style="padding: 6px; text-align: center; font-size: 80%; \
margin-top: 2px; margin-bottom: 6px; margin-left: 6px; margin-right: \ font-family: DejaVu Sans, Arial, Helvetica, sans-serif; \
6px; text-align: justify; font-size: 80%; font-family: Helvetica, Arial, \ font-weight: normal;">$(DRAFT_TEXT)</div>
sans-serif; font-weight: normal;">$(DRAFT_TEXT)</div></div>
################################################################################ ################################################################################
# JDK javadoc titles/text snippets # JDK javadoc titles/text snippets
JDK_SHORT_NAME := JDK&trade; $(VERSION_SPECIFICATION) JDK_SHORT_NAME := Java SE $(VERSION_SPECIFICATION) &amp; JDK $(VERSION_SPECIFICATION)
JDK_LONG_NAME := Standard Edition Development Kit (JDK&trade;) $(VERSION_SPECIFICATION) JDK_LONG_NAME := Java<sup>&reg;</sup> Platform, Standard Edition \
<span style="white-space: nowrap;">&amp; Java Development Kit</span>
################################################################################ ################################################################################
# Java SE javadoc titles/text snippets # Java SE javadoc titles/text snippets
JAVASE_SHORT_NAME := SE $(VERSION_SPECIFICATION) JAVASE_SHORT_NAME := Java SE $(VERSION_SPECIFICATION)
JAVASE_LONG_NAME := Standard Edition $(VERSION_SPECIFICATION) JAVASE_LONG_NAME := Java<sup>&reg;</sup> Platform, Standard Edition
################################################################################ ################################################################################
# Functions # Functions
@ -199,23 +197,19 @@ define create_overview_file
$1_OVERVIEW_TEXT := \ $1_OVERVIEW_TEXT := \
<!DOCTYPE html> \ <!DOCTYPE html> \
<html><head></head><body> \ <html><head></head><body> \
<p>This document is the API specification for $$($1_FULL_NAME).</p> \
# #
ifneq ($$($1_GROUPS),) ifneq ($$($1_GROUPS),)
$1_OVERVIEW_TEXT += \ $1_OVERVIEW_TEXT += \
<dl> \ <p>This document is divided into \
# $$(subst 2,two,$$(subst 3,three,$$(words $$($1_GROUPS)))) sections:</p> \
<blockquote><dl> \
#
$1_OVERVIEW_TEXT += $$(foreach g, $$($1_GROUPS), \ $1_OVERVIEW_TEXT += $$(foreach g, $$($1_GROUPS), \
<dt><a href="\#$$g">$$($$g_GROUP_NAME)</a></dt> \ <dt style="margin-top: 8px;"><a href="\#$$g">$$($$g_GROUP_NAME)</a></dt> \
<dd>$$($$g_GROUP_DESCRIPTION)</dt> \ <dd style="margin-top: 8px;">$$($$g_GROUP_DESCRIPTION)</dt> \
) )
$1_OVERVIEW_TEXT += \ $1_OVERVIEW_TEXT += \
</dl> \ </dl><blockquote> \
#
endif
ifeq ($$(IS_DRAFT), true)
$1_OVERVIEW_TEXT += \
<p><strong>$$(DRAFT_TEXT)</strong></p> \
# #
endif endif
$1_OVERVIEW_TEXT += \ $1_OVERVIEW_TEXT += \
@ -273,13 +267,16 @@ define SetupApiDocsGenerationBody
$1_OPTIONS += -Xdoclint:all,$$(call CommaList, $$(addprefix -, \ $1_OPTIONS += -Xdoclint:all,$$(call CommaList, $$(addprefix -, \
$$(JAVADOC_DISABLED_DOCLINT))) $$(JAVADOC_DISABLED_DOCLINT)))
$1_FULL_NAME := $$(JAVA_PLATFORM), $$($1_LONG_NAME) \ $1_DOC_TITLE := $$($1_LONG_NAME)<br>Version $$(VERSION_SPECIFICATION) API Specification
$$(DRAFT_MARKER_TITLE) $1_WINDOW_TITLE := $$(subst &amp;,&,$$($1_SHORT_NAME)) \
$1_DOC_TITLE := $$($1_FULL_NAME)<br>API Specification
$1_WINDOW_TITLE := $$(subst &trade;,,$$(JAVA_PLATFORM) $$($1_SHORT_NAME)) \
$$(DRAFT_MARKER_TITLE) $$(DRAFT_MARKER_TITLE)
$1_HEADER_TITLE := <strong>$$(JAVA_PLATFORM)<br>$$($1_SHORT_NAME)</strong> \ ifeq ($(VERSION_IS_GA), true) # Workaround stylesheet bug
$$(DRAFT_MARKER_STR) $1_HEADER_PAD := 14
else
$1_HEADER_PAD := 9
endif
$1_HEADER_TITLE := <div style="margin-top: $$($1_HEADER_PAD)px;"><strong>$$($1_SHORT_NAME)</strong> \
$$(DRAFT_MARKER_STR)</div>
$1_OPTIONS += -doctitle '$$($1_DOC_TITLE)' $1_OPTIONS += -doctitle '$$($1_DOC_TITLE)'
$1_OPTIONS += -windowtitle '$$($1_WINDOW_TITLE)' $1_OPTIONS += -windowtitle '$$($1_WINDOW_TITLE)'
@ -373,18 +370,18 @@ JavaSE_GROUP_NAME := Java SE
JavaSE_GROUP_MODULES := $(call ColonList, $(sort java.se.ee \ JavaSE_GROUP_MODULES := $(call ColonList, $(sort java.se.ee \
$(call FindTransitiveIndirectDepsForModules, java.se.ee))) $(call FindTransitiveIndirectDepsForModules, java.se.ee)))
JavaSE_GROUP_DESCRIPTION := \ JavaSE_GROUP_DESCRIPTION := \
The Java Platform, Standard Edition ("Java SE") APIs define the core Java \ The Java Platform, Standard Edition (Java SE) APIs define the core Java \
platform for general-purpose computing. These APIs are in modules with \ platform for general-purpose computing. These APIs are in modules whose \
names starting with the string "java.". \ names start with {@code java}. \
# #
JDK_GROUPS += JavaSE JDK_GROUPS += JavaSE
JDK_GROUP_NAME := JDK JDK_GROUP_NAME := JDK
JDK_GROUP_MODULES := jdk.* JDK_GROUP_MODULES := jdk.*
JDK_GROUP_DESCRIPTION := \ JDK_GROUP_DESCRIPTION := \
The Java Development Kit ("JDK") APIs define an implementation of the Java \ The Java Development Kit (JDK) APIs are specific to the JDK and will not \
SE Platform which may include platform-specific details. These APIs are in \ necessarily be available in all implementations of the Java SE Platform. \
modules with names starting with the string "jdk.". \ These APIs are in modules whose names start with {@code jdk}. \
# #
JDK_GROUPS += JDK JDK_GROUPS += JDK
@ -395,9 +392,9 @@ ifneq ($(findstring javafx., $(IMPORTED_MODULES)), )
JavaFX_GROUP_NAME := JavaFX JavaFX_GROUP_NAME := JavaFX
JavaFX_GROUP_MODULES := javafx.* JavaFX_GROUP_MODULES := javafx.*
JavaFX_GROUP_DESCRIPTION := \ JavaFX_GROUP_DESCRIPTION := \
The JavaFX APIs define a set of user interface (UI) controls, graphics, \ The JavaFX APIs define a set of user-interface controls, graphics, \
media, and web packages for developing rich client applications. These \ media, and web packages for developing rich client applications. These \
APIs are in modules with names starting with the string "javafx.". \ APIs are in modules whose names start with {@code javafx}. \
# #
JDK_GROUPS += JavaFX JDK_GROUPS += JavaFX
endif endif
@ -419,7 +416,7 @@ $(eval $(call SetupApiDocsGeneration, JDK_API, \
################################################################################ ################################################################################
# Setup generation of the Java SE API documentation (javadoc + modulegraph) # Setup generation of the Java SE API documentation (javadoc + modulegraph)
# The Java SE module scope is just java.se.ee and it's transitive indirect # The Java SE module scope is just java.se.ee and its transitive indirect
# exports. # exports.
JAVASE_MODULES := java.se.ee JAVASE_MODULES := java.se.ee