< prev index next >

make/Docs.gmk

Print this page

        

*** 95,112 **** --- 95,123 ---- -taglet build.tools.taglet.Incubating \ -tagletpath $(BUILDTOOLS_OUTPUTDIR)/jdk_tools_classes \ $(CUSTOM_JAVADOC_TAGS) \ # + # The reference tags must stay stable to allow for comparisons across the + # development cycle. If JAVADOC_TAGS needs to change, make sure that + # REFERENCE_TAGS remains unchanged, by copying and hardcoding, if necessary. + REFERENCE_TAGS := $(JAVADOC_TAGS) + # Which doclint checks to ignore JAVADOC_DISABLED_DOCLINT := accessibility html missing syntax reference # The initial set of options for javadoc JAVADOC_OPTIONS := -use -keywords -notimestamp \ -serialwarn -encoding ISO-8859-1 -docencoding UTF-8 -breakiterator \ -splitIndex --system none -html5 -javafx --expand-requires transitive + # The reference options must stay stable to allow for comparisons across the + # development cycle. + REFERENCE_OPTIONS := -XDignore.symbol.file=true -use -keywords -notimestamp \ + -serialwarn -encoding ISO-8859-1 -breakiterator -splitIndex --system none \ + -html5 -javafx --expand-requires transitive + # Should we add DRAFT stamps to the generated javadoc? ifeq ($(VERSION_IS_GA), true) IS_DRAFT := false else IS_DRAFT := true
*** 127,136 **** --- 138,152 ---- else DRAFT_MARKER_TITLE := [build $(VERSION_BUILD)] endif DRAFT_TEXT := This specification is not final and is subject to change. \ Use is subject to <a href="$(LICENSE_URL)">license terms</a>. + + # Workaround stylesheet bug + HEADER_STYLE := style="margin-top: 9px;" + else + HEADER_STYLE := style="margin-top: 14px;" endif JAVADOC_BOTTOM := \ <a href="$(BUG_SUBMIT_URL)">Report a bug or suggest an enhancement</a><br> \ For further API reference and developer documentation see the \
*** 145,160 **** $(COMPANY_ADDRESS).<br>All rights reserved. \ Use is subject to <a href="$(LICENSE_URL)">license terms</a> and the \ <a href="$(REDISTRIBUTION_URL)">documentation redistribution policy</a>. \ $(DRAFT_MARKER_STR) <!-- Version $(VERSION_STRING) --> - JAVADOC_TOP := \ <div style="padding: 6px; text-align: center; font-size: 80%; \ font-family: DejaVu Sans, Arial, Helvetica, sans-serif; \ font-weight: normal;">$(DRAFT_TEXT)</div> ################################################################################ # JDK javadoc titles/text snippets JDK_SHORT_NAME := Java SE $(VERSION_SPECIFICATION) &amp; JDK $(VERSION_SPECIFICATION) JDK_LONG_NAME := Java<sup>&reg;</sup> Platform, Standard Edition \ --- 161,183 ---- $(COMPANY_ADDRESS).<br>All rights reserved. \ Use is subject to <a href="$(LICENSE_URL)">license terms</a> and the \ <a href="$(REDISTRIBUTION_URL)">documentation redistribution policy</a>. \ $(DRAFT_MARKER_STR) <!-- Version $(VERSION_STRING) --> JAVADOC_TOP := \ <div style="padding: 6px; text-align: center; font-size: 80%; \ font-family: DejaVu Sans, Arial, Helvetica, sans-serif; \ font-weight: normal;">$(DRAFT_TEXT)</div> + JDK_INDEX_CONTENT := \ + <!DOCTYPE html> \ + <html lang="en"> \ + <head> \ + <meta http-equiv="refresh" content="0;url=api/index.html"> \ + </head> \ + </html> + ################################################################################ # JDK javadoc titles/text snippets JDK_SHORT_NAME := Java SE $(VERSION_SPECIFICATION) &amp; JDK $(VERSION_SPECIFICATION) JDK_LONG_NAME := Java<sup>&reg;</sup> Platform, Standard Edition \
*** 255,283 **** # Tell the ModuleGraph taglet to generate html links to soon-to-be-created # png files with module graphs. $1_JAVA_ARGS += -DenableModuleGraph=true endif ! # Always include tags and basic options ! $1_OPTIONS := $$(JAVADOC_TAGS) $$(JAVADOC_OPTIONS) $1_OPTIONS += --module-source-path $$(MODULES_SOURCE_PATH) $1_OPTIONS += --module $$(call CommaList, $$($1_MODULES)) # Create a string like "-Xdoclint:all,-syntax,-html,..." $1_OPTIONS += -Xdoclint:all,$$(call CommaList, $$(addprefix -, \ $$(JAVADOC_DISABLED_DOCLINT))) ! $1_DOC_TITLE := $$($1_LONG_NAME)<br>Version $$(VERSION_SPECIFICATION) API Specification ! $1_WINDOW_TITLE := $$(subst &amp;,&,$$($1_SHORT_NAME)) \ ! $$(DRAFT_MARKER_TITLE) ! ifeq ($(VERSION_IS_GA), true) # Workaround stylesheet bug ! $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 += -windowtitle '$$($1_WINDOW_TITLE)' $1_OPTIONS += -header '$$($1_HEADER_TITLE)' --- 278,307 ---- # Tell the ModuleGraph taglet to generate html links to soon-to-be-created # png files with module graphs. $1_JAVA_ARGS += -DenableModuleGraph=true endif ! # Start with basic options and tags ! ifeq ($$($1_OPTIONS), ) ! $1_OPTIONS := $$(JAVADOC_OPTIONS) ! endif ! ifeq ($$($1_TAGS), ) ! $1_TAGS := $$(JAVADOC_TAGS) ! endif ! $1_OPTIONS += $$($1_TAGS) $1_OPTIONS += --module-source-path $$(MODULES_SOURCE_PATH) $1_OPTIONS += --module $$(call CommaList, $$($1_MODULES)) # Create a string like "-Xdoclint:all,-syntax,-html,..." $1_OPTIONS += -Xdoclint:all,$$(call CommaList, $$(addprefix -, \ $$(JAVADOC_DISABLED_DOCLINT))) ! $1_DOC_TITLE := $$($1_LONG_NAME)<br>Version $$(VERSION_SPECIFICATION) API \ ! Specification ! $1_WINDOW_TITLE := $$(subst &amp;,&,$$($1_SHORT_NAME)) $$(DRAFT_MARKER_TITLE) ! $1_HEADER_TITLE := <div $$(HEADER_STYLE)><strong>$$($1_SHORT_NAME)</strong> \ $$(DRAFT_MARKER_STR)</div> $1_OPTIONS += -doctitle '$$($1_DOC_TITLE)' $1_OPTIONS += -windowtitle '$$($1_WINDOW_TITLE)' $1_OPTIONS += -header '$$($1_HEADER_TITLE)'
*** 300,311 **** $$(foreach g, $$($1_GROUPS), \ $$(eval $1_OPTIONS += -group "$$($$g_GROUP_NAME)" "$$($$g_GROUP_MODULES)") \ ) $1_VARDEPS := $$($1_JAVA_ARGS) $$($1_OPTIONS) $$(MODULES_SOURCE_PATH) \ ! $$($1_ALL_MODULES) $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, \ $$(SUPPORT_OUTPUTDIR)/docs/$1.vardeps) # Get a list of all files in all the source dirs for all included modules $1_SOURCE_DEPS := $$(call CacheFind, $$(wildcard $$(foreach module, \ --- 324,340 ---- $$(foreach g, $$($1_GROUPS), \ $$(eval $1_OPTIONS += -group "$$($$g_GROUP_NAME)" "$$($$g_GROUP_MODULES)") \ ) + ifeq ($$($1_JAVADOC_CMD), ) + $1_JAVADOC_CMD := $$(JAVA) -Djava.awt.headless=true $$($1_JAVA_ARGS) \ + $$(NEW_JAVADOC) + endif + $1_VARDEPS := $$($1_JAVA_ARGS) $$($1_OPTIONS) $$(MODULES_SOURCE_PATH) \ ! $$($1_ALL_MODULES) $$($1_JAVADOC_CMD) $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, \ $$(SUPPORT_OUTPUTDIR)/docs/$1.vardeps) # Get a list of all files in all the source dirs for all included modules $1_SOURCE_DEPS := $$(call CacheFind, $$(wildcard $$(foreach module, \
*** 317,329 **** $$(call LogWarn, Generating $1 javadoc for \ $$(words $$($1_ALL_MODULES)) modules) $$(call LogInfo, Javadoc modules: $$($1_ALL_MODULES)) $$(call MakeDir, $$($1_TARGET_DIR)) $$(call ExecuteWithLog, $$(SUPPORT_OUTPUTDIR)/docs/$1, \ ! $$(JAVA) -Djava.awt.headless=true $$($1_JAVA_ARGS) \ ! $$(NEW_JAVADOC) -d $$($1_TARGET_DIR) \ ! $$(JAVADOC_TAGS) $$($1_OPTIONS) $$($1_LOG_OPTION)) $1_JAVADOC_TARGETS := $$($1_TARGET_DIR)/index.html ifeq ($$(ENABLE_FULL_DOCS), true) # We have asked ModuleGraph to generate links to png files. Now we must --- 346,357 ---- $$(call LogWarn, Generating $1 javadoc for \ $$(words $$($1_ALL_MODULES)) modules) $$(call LogInfo, Javadoc modules: $$($1_ALL_MODULES)) $$(call MakeDir, $$($1_TARGET_DIR)) $$(call ExecuteWithLog, $$(SUPPORT_OUTPUTDIR)/docs/$1, \ ! $$($1_JAVADOC_CMD) -d $$($1_TARGET_DIR) \ ! $$($1_OPTIONS) $$($1_LOG_OPTION)) $1_JAVADOC_TARGETS := $$($1_TARGET_DIR)/index.html ifeq ($$(ENABLE_FULL_DOCS), true) # We have asked ModuleGraph to generate links to png files. Now we must
*** 429,448 **** # Targets generated are returned in JAVASE_API_JAVADOC_TARGETS and # JAVASE_API_MODULEGRAPH_TARGETS. ################################################################################ ! JDK_INDEX_HTML := $(DOCS_OUTPUTDIR)/index.html ! JDK_INDEX_CONTENT := \ ! <!DOCTYPE html> \ ! <html lang="en"> \ ! <head> \ ! <meta http-equiv="refresh" content="0;url=api/index.html"> \ ! </head> \ ! </html> $(JDK_INDEX_HTML): $(ECHO) '$(JDK_INDEX_CONTENT)' > $@ JDK_INDEX_TARGETS += $(JDK_INDEX_HTML) --- 457,487 ---- # Targets generated are returned in JAVASE_API_JAVADOC_TARGETS and # JAVASE_API_MODULEGRAPH_TARGETS. ################################################################################ + # Setup generation of the reference Java SE API documentation (javadoc + modulegraph) ! # The reference javadoc is just the same as javase, but using the BootJDK javadoc ! # and a stable set of javadoc options. ! $(eval $(call SetupApiDocsGeneration, REFERENCE_API, \ ! MODULES := $(JAVASE_MODULES), \ ! SHORT_NAME := $(JAVASE_SHORT_NAME), \ ! LONG_NAME := $(JAVASE_LONG_NAME), \ ! TARGET_DIR := $(IMAGES_OUTPUTDIR)/reference-docs/api, \ ! JAVADOC_CMD := $(JAVADOC), \ ! OPTIONS := $(REFERENCE_OPTIONS), \ ! TAGS := $(REFERENCE_TAGS), \ ! )) ! ! # Targets generated are returned in REFERENCE_API_JAVADOC_TARGETS and ! # REFERENCE_API_MODULEGRAPH_TARGETS. ! ! ################################################################################ ! ! JDK_INDEX_HTML := $(DOCS_OUTPUTDIR)/index.html $(JDK_INDEX_HTML): $(ECHO) '$(JDK_INDEX_CONTENT)' > $@ JDK_INDEX_TARGETS += $(JDK_INDEX_HTML)
*** 551,567 **** docs-javase-api-javadoc: $(JAVASE_API_JAVADOC_TARGETS) $(JAVASE_API_CUSTOM_TARGETS) docs-javase-api-modulegraph: $(JAVASE_API_MODULEGRAPH_TARGETS) docs-jdk-specs: $(JDK_SPECS_TARGETS) docs-jdk-index: $(JDK_INDEX_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-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-jdk-index docs-zip --- 590,612 ---- docs-javase-api-javadoc: $(JAVASE_API_JAVADOC_TARGETS) $(JAVASE_API_CUSTOM_TARGETS) docs-javase-api-modulegraph: $(JAVASE_API_MODULEGRAPH_TARGETS) + docs-reference-api-javadoc: $(REFERENCE_API_JAVADOC_TARGETS) $(REFERENCE_API_CUSTOM_TARGETS) + + docs-reference-api-modulegraph: $(REFERENCE_API_MODULEGRAPH_TARGETS) + docs-jdk-specs: $(JDK_SPECS_TARGETS) docs-jdk-index: $(JDK_INDEX_TARGETS) docs-zip: $(ZIP_TARGETS) all: docs-jdk-api-javadoc docs-jdk-api-modulegraph docs-javase-api-javadoc \ ! docs-javase-api-modulegraph docs-reference-api-javadoc \ ! docs-reference-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-reference-api-javadoc docs-reference-api-modulegraph docs-jdk-specs \ docs-jdk-index docs-zip
< prev index next >