include Modules.gmk

include ZipArchive.gmk

# This is needed to properly setup DOCS_MODULES.

$(eval $(call ReadImportMetaData))

# Javadoc settings

# All modules to have docs generated by docs-javadoc target

JAVADOC_MODULES := $(sort $(DOCS_MODULES))

# On top of the sources that was used to compile the JDK, we need some

# extra java.rmi sources that are used just for javadoc.

JAVADOC_SOURCE_PATH := $(call PathList, $(call GetModuleSrcPath) \

    $(SUPPORT_OUTPUTDIR)/rmic/* $(JDK_TOPDIR)/src/*/share/doc/stub)

COPYRIGHT_URL := {@docroot}/../legal/cpyr.html

JAVADOC_TAGS := \

# Which doclint checks to ignore

JAVADOC_DISABLED_DOCLINT := accessibility html missing syntax reference

# The initial set of options for javadoc

JAVADOC_OPTIONS := -XDignore.symbol.file=true -use -keywords -notimestamp \

    -serialwarn -encoding ISO-8859-1 -breakiterator -splitIndex --system none \

    --expand-requires transitive

# Should we add DRAFT stamps to the generated javadoc?

ifeq ($(VERSION_IS_GA), true)

  IS_DRAFT := false

else

  IS_DRAFT := true

endif

# General text snippets

FULL_COMPANY_NAME := Oracle and/or its affiliates

COMPANY_ADDRESS := 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA

ifeq ($(IS_DRAFT), true)

  DRAFT_MARKER_STR := <br><strong>DRAFT $(VERSION_STRING)</strong>

  ifeq ($(VERSION_BUILD), 0)

    DRAFT_MARKER_TITLE := [ad-hoc build]

    DRAFT_MARKER_TITLE := [build $(VERSION_BUILD)]

endif

# JDK javadoc titles/text snippets

JAVADOC_WINDOW_TITLE := Java Platform SE $(VERSION_SPECIFICATION) \

    $(DRAFT_MARKER_TITLE)

JAVADOC_DOC_TITLE := Java™ Platform, Standard Edition Development Kit \

    (JDK&trade;) $(VERSION_SPECIFICATION)<br>API Specification

JAVADOC_HEADER_TITLE := $(subst $(SPACE), ,$(strip \

    <strong>Java&trade; Platform<br>Standard Ed. \

    $(VERSION_SPECIFICATION)</strong>$(DRAFT_MARKER_STR)))

JAVADOC_BOTTOM := \

    <span style="font-size:smaller"> \

    <a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a><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.<br> \

    Java is a trademark or registered trademark of $(FULL_COMPANY_NAME) in \

    the US and other countries.<br> \

    <a href="$(COPYRIGHT_URL)">Copyright</a> \

    © 1993, $(COPYRIGHT_YEAR), $(FULL_COMPANY_NAME). \

    $(COMPANY_ADDRESS). All rights reserved.$(DRAFT_MARKER_STR)</span>

JAVADOC_TOP := \

    <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>

# Java SE Reference javadoc titles/text snippets

REFERENCE_DOC_TITLE := Java™ Platform, Standard Edition \

    $(VERSION_SPECIFICATION)<br>API Specification

# Setup call to JDK javadoc based on above settings

# Create a string like "-Xdoclint:all,-syntax,-html,..."

JAVADOC_OPTIONS += -Xdoclint:all,$(call CommaList, $(addprefix -, \

    $(JAVADOC_DISABLED_DOCLINT)))

ifneq ($($DOCROOTPARENT_FLAG), )

  JAVADOC_OPTIONS += -Xdocrootparent $(JAVADOC_BASE_URL)

endif

JAVADOC_TITLE_OPTIONS += -doctitle '$(JAVADOC_DOC_TITLE)'

JAVADOC_TITLE_OPTIONS += -windowtitle '$(JAVADOC_WINDOW_TITLE)'

JAVADOC_TITLE_OPTIONS += -header '$(JAVADOC_HEADER_TITLE)'

JAVADOC_TITLE_OPTIONS += -bottom '$(JAVADOC_BOTTOM)'

ifeq ($(IS_DRAFT), true)

  JAVADOC_TITLE_OPTIONS += -top '$(JAVADOC_TOP)'

endif

# Do not store debug level options in VARDEPS.

ifneq ($(LOG_LEVEL), trace)

  JAVADOC_LOG_OPTION += -quiet

else

  JAVADOC_LOG_OPTION += -verbose

endif

JAVADOC_VARDEPS := $(JAVADOC_OPTIONS) $(JAVADOC_TITLE_OPTIONS) $(JAVADOC_TAGS) \

    $(JAVADOC_MODULES) $(JAVADOC_SOURCE_PATH)

JAVADOC_VARDEPS_FILE := $(call DependOnVariable, JAVADOC_VARDEPS, \

    $(SUPPORT_OUTPUTDIR)/docs/javadoc.vardeps)

# Get a list of all files in all the source dirs for all included modules

JAVADOC_SOURCE_DEPS := $(call CacheFind, $(wildcard \

    $(foreach module, $(JAVADOC_MODULES), $(call FindModuleSrcDirs, $(module)))))

JAVADOC_TARGET_DIR := $(JAVADOC_OUTPUTDIR)/api

JAVADOC_OVERVIEW := $(JDK_TOPDIR)/src/java.base/share/classes/overview-core.html

# Javadoc creates a lot of files but use index.html as a marker

$(JAVADOC_TARGET_DIR)/index.html: $(BUILD_TOOLS_JDK) $(JAVADOC_VARDEPS_FILE) \

    $(JAVADOC_SOURCE_DEPS) $(JAVADOC_OVERVIEW)

	$(call LogWarn, Generating Javadoc for $(words $(JAVADOC_MODULES)) modules)

	$(call LogInfo, Javadoc modules: $(JAVADOC_MODULES))

	$(call MakeDir, $(JAVADOC_TARGET_DIR))

	$(call ExecuteWithLog, $(SUPPORT_OUTPUTDIR)/docs/javadoc, \

	    $(JAVA) -Djava.awt.headless=true \

	        -DenableModuleGraph=$(ENABLE_MODULE_GRAPH) \

	        $(NEW_JAVADOC) -d $(JAVADOC_TARGET_DIR) \

	        $(JAVADOC_TAGS) $(JAVADOC_OPTIONS) $(JAVADOC_LOG_OPTION) \

	        $(JAVADOC_TITLE_OPTIONS) -overview $(JAVADOC_OVERVIEW) \

	        --module-source-path $(JAVADOC_SOURCE_PATH) \

	        --module $(call CommaList, $(JAVADOC_MODULES)))

JAVADOC_TARGETS += $(JAVADOC_TARGET_DIR)/index.html

# Setup call to Java SE Reference javadoc based on above settings

REFERENCE_TARGET_DIR := $(IMAGES_OUTPUTDIR)/javase-docs/api

REFERENCE_OVERVIEW := $(JDK_TOPDIR)/src/java.base/share/classes/overview-core.html

REFERENCE_TITLE_OPTIONS += -doctitle '$(REFERENCE_DOC_TITLE)'

REFERENCE_TITLE_OPTIONS += -windowtitle '$(JAVADOC_WINDOW_TITLE)'

REFERENCE_TITLE_OPTIONS += -header '$(JAVADOC_HEADER_TITLE)'

REFERENCE_TITLE_OPTIONS += -bottom '$(JAVADOC_BOTTOM)'

ifeq ($(IS_DRAFT), true)

  REFERENCE_TITLE_OPTIONS += -top '$(JAVADOC_TOP)'

endif

REFERENCE_VARDEPS := $(JAVADOC_OPTIONS) $(REFERENCE_TITLE_OPTIONS) $(JAVADOC_TAGS) \

    $(JAVADOC_MODULES) $(JAVADOC_SOURCE_PATH)

REFERENCE_VARDEPS_FILE := $(call DependOnVariable, REFERENCE_VARDEPS, \

    $(SUPPORT_OUTPUTDIR)/docs/reference.vardeps)

# Javadoc creates a lot of files but use index.html as a marker.

$(REFERENCE_TARGET_DIR)/index.html: $(BUILD_TOOLS_JDK) $(REFERENCE_VARDEPS_FILE) \

    $(JAVADOC_SOURCE_DEPS) $(REFERENCE_OVERVIEW)

	$(call LogWarn, Generating reference Javadoc for Java SE)

	$(call MakeDir, $(REFERENCE_TARGET_DIR))

	$(call ExecuteWithLog, $(SUPPORT_OUTPUTDIR)/docs/reference, \

	    $(JAVA) -Djava.awt.headless=true \

	        -DenableModuleGraph=$(ENABLE_MODULE_GRAPH) \

	        $(NEW_JAVADOC) -d $(REFERENCE_TARGET_DIR) \

	        $(JAVADOC_TAGS) $(JAVADOC_OPTIONS) $(JAVADOC_LOG_OPTION) \

	        $(REFERENCE_TITLE_OPTIONS) -overview $(REFERENCE_OVERVIEW) \

	        --module-source-path $(JAVADOC_SOURCE_PATH) \

	        --module java.se.ee)

REFERENCE_TARGETS += $(REFERENCE_TARGET_DIR)/index.html

# Copy targets

JAVADOC_ZIP_NAME := jdk-$(VERSION_STRING)-docs.zip

JAVADOC_ZIP_FILE := $(OUTPUT_ROOT)/bundles/$(JAVADOC_ZIP_NAME)

$(eval $(call SetupZipArchive, BUILD_JAVADOC_ZIP, \

  SRC := $(JAVADOC_OUTPUTDIR), \

  ZIP := $(JAVADOC_ZIP_FILE), \

  EXTRA_DEPS := $(JAVADOC_TARGETS) $(COPY_TARGETS), \

))

ZIP_TARGETS += $(BUILD_JAVADOC_ZIP)

docs-module-graphs: $(MODULE_GRAPH_TARGETS)

docs-javadoc: $(JAVADOC_TARGETS)

docs-reference: $(REFERENCE_TARGETS)

all: docs-module-graphs docs-javadoc docs-reference docs-copy docs-zip

.PHONY: default all docs-module-graphs docs-javadoc docs-reference docs-copy docs-zip