archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-09-18 18:14:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8180208: Provide a new docs bundle page

Browse source 
Reviewed-by: ihse, jjg
This commit is contained in:
Mandy Chung 2017-05-12 13:29:22 -07:00
parent 3cd66ee880
commit d338fb31e1
2 changed files with 29 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

24
make/Docs.gmk
View file

@ -164,6 +164,11 @@ JDK_JAVADOC_DOC_TITLE := Java™ Platform, Standard Edition Development Kit
JAVASE_JAVADOC_DOC_TITLE := Java™ Platform, Standard Edition \
$(VERSION_SPECIFICATION)<br>API Specification
################################################################################
JDK_DOCS_INDEX_HTML_TITLE := Java&trade; Platform, Standard Edition Development Kit \
(JDK&trade;) $(VERSION_SPECIFICATION) Specification<br>$(DRAFT_MARKER_TITLE)
################################################################################
# Functions
@ -356,6 +361,18 @@ $(eval $(call SetupApiDocsGeneration, JAVASE_API, \
# Targets generated are returned in JAVASE_API_JAVADOC_TARGETS and
# JAVASE_API_MODULEGRAPH_TARGETS.
################################################################################
JDK_DOCS_INDEX_HTML := $(DOCS_OUTPUTDIR)/index.html
$(JDK_DOCS_INDEX_HTML): $(BUILD_JIGSAW_TOOLS)
$(call LogInfo, Generating docs bundle index page)
$(MKDIR) -p $(@D)
$(TOOL_GEN_DOCS_BUNDLE_PAGE) --title '$(JDK_DOCS_INDEX_HTML_TITLE)' \
--output $@
JDK_DOCS_INDEX_HTML_TARGETS := $(JDK_DOCS_INDEX_HTML)
################################################################################
# Copy JDK specs files
@ -454,10 +471,13 @@ docs-javase-api-modulegraph: $(JAVASE_API_MODULEGRAPH_TARGETS)
docs-jdk-specs: $(JDK_SPECS_TARGETS)
docs-jdk-index: $(JDK_DOCS_INDEX_HTML_TARGETS)
docs-zip: $(ZIP_TARGETS)
all: docs-jdk-api-javadoc docs-jdk-api-modulegraph docs-javase-api-javadoc \
docs-javase-api-modulegraph docs-jdk-specs docs-zip
docs-javase-api-modulegraph docs-jdk-specs docs-jdk-index docs-zip
.PHONY: default all docs-jdk-api-javadoc docs-jdk-api-modulegraph \
docs-javase-api-javadoc docs-javase-api-modulegraph docs-jdk-specs docs-zip
docs-javase-api-javadoc docs-javase-api-modulegraph docs-jdk-specs \
docs-jdk-index docs-zip

9
make/Main.gmk
View file

@ -380,6 +380,9 @@ docs-javase-api-modulegraph:
docs-jdk-specs:
+($(CD) $(SRC_ROOT)/make && $(MAKE) $(MAKE_ARGS) -f Docs.gmk docs-jdk-specs)
docs-jdk-index:
+($(CD) $(SRC_ROOT)/make && $(MAKE) $(MAKE_ARGS) -f Docs.gmk docs-jdk-index)
docs-zip:
+($(CD) $(SRC_ROOT)/make && $(MAKE) $(MAKE_ARGS) -f Docs.gmk docs-zip)
@ -388,7 +391,7 @@ update-build-docs:
ALL_TARGETS += docs-jdk-api-javadoc docs-jdk-api-modulegraph \
docs-javase-api-javadoc docs-javase-api-modulegraph docs-jdk-specs \
docs-zip update-build-docs
docs-jdk-index docs-zip update-build-docs
################################################################################
# Cross compilation support
@ -797,6 +800,8 @@ else
# The gensrc steps for hotspot and jdk.jdi create html spec files.
docs-jdk-specs: hotspot-$(JVM_VARIANT_MAIN)-gensrc jdk.jdi-gensrc
docs-jdk-index: exploded-image buildtools-modules
docs-zip: docs-jdk
test: jdk-image test-image
@ -926,7 +931,7 @@ ifeq ($(ENABLE_FULL_DOCS), true)
docs-javase-api: docs-javase-api-modulegraph
endif
docs-jdk: docs-jdk-api docs-jdk-specs
docs-jdk: docs-jdk-api docs-jdk-specs docs-jdk-index
docs-javase: docs-javase-api
# alias for backwards compatibility