make/Docs.gmk
changeset 45229 88a3fab6006f
parent 45108 8ad1bd49f4bc
child 45233 538af025db97
equal deleted inserted replaced
45228:b32e004375c1 45229:88a3fab6006f
   161 JAVASE_JAVADOC_DOC_TITLE := Java™ Platform, Standard Edition \
   161 JAVASE_JAVADOC_DOC_TITLE := Java™ Platform, Standard Edition \
   162     $(VERSION_SPECIFICATION)<br>API Specification
   162     $(VERSION_SPECIFICATION)<br>API Specification
   163 
   163 
   164 ################################################################################
   164 ################################################################################
   165 
   165 
   166 JDK_DOCS_INDEX_HTML_TITLE := Java&trade; Platform, Standard Edition Development Kit \
   166 JDK_INDEX_TITLE := Java&trade; Platform, Standard Edition Development Kit \
   167     (JDK&trade;) $(VERSION_SPECIFICATION) Specification<br>$(DRAFT_MARKER_TITLE)
   167     (JDK&trade;) $(VERSION_SPECIFICATION) Specification<br>$(DRAFT_MARKER_TITLE)
   168 
   168 
   169 ################################################################################
   169 ################################################################################
   170 # Functions
   170 # Functions
   171 
   171 
   354 # Targets generated are returned in JAVASE_API_JAVADOC_TARGETS and
   354 # Targets generated are returned in JAVASE_API_JAVADOC_TARGETS and
   355 # JAVASE_API_MODULEGRAPH_TARGETS.
   355 # JAVASE_API_MODULEGRAPH_TARGETS.
   356 
   356 
   357 ################################################################################
   357 ################################################################################
   358 
   358 
   359 JDK_DOCS_INDEX_HTML := $(DOCS_OUTPUTDIR)/index.html
   359 JDK_INDEX_HTML := $(DOCS_OUTPUTDIR)/index.html
   360 
   360 JDK_INDEX_TOOLS_DIR := $(TOOLS_CLASSES_DIR)/build/tools/docs
   361 $(JDK_DOCS_INDEX_HTML): $(BUILD_JIGSAW_TOOLS)
   361 
       
   362 $(JDK_INDEX_HTML): $(BUILD_JIGSAW_TOOLS) \
       
   363     $(JDK_INDEX_TOOLS_DIR)/docs-bundle-page.html  \
       
   364     $(JDK_INDEX_TOOLS_DIR)/docs-module-groups.properties
   362 	$(call LogInfo, Generating docs bundle index page)
   365 	$(call LogInfo, Generating docs bundle index page)
   363 	$(MKDIR) -p $(@D)
   366 	$(MKDIR) -p $(@D)
   364 	$(TOOL_GEN_DOCS_BUNDLE_PAGE) --title '$(JDK_DOCS_INDEX_HTML_TITLE)' \
   367 	$(TOOL_GEN_DOCS_BUNDLE_PAGE) --title '$(JDK_INDEX_TITLE)' \
   365 		--output $@
   368 		--output $@
   366 
   369 
   367 JDK_DOCS_INDEX_HTML_TARGETS := $(JDK_DOCS_INDEX_HTML)
   370 JDK_INDEX_TARGETS := $(JDK_INDEX_HTML)
       
   371 
       
   372 # Copy the global resources
       
   373 GLOBAL_SPECS_RESOURCES_DIR := $(JDK_TOPDIR)/make/data/docs-resources/
       
   374 $(eval $(call SetupCopyFiles, COPY_GLOBAL_RESOURCES, \
       
   375     SRC := $(GLOBAL_SPECS_RESOURCES_DIR), \
       
   376     FILES := $(call CacheFind, $(GLOBAL_SPECS_RESOURCES_DIR)), \
       
   377     DEST := $(DOCS_OUTPUTDIR), \
       
   378 ))
       
   379 JDK_INDEX_TARGETS += $(COPY_GLOBAL_RESOURCES)
   368 
   380 
   369 ################################################################################
   381 ################################################################################
   370 # Copy JDK specs files
   382 # Copy JDK specs files
   371 
   383 
   372 # For all html documentation in $module/share/specs directories, copy it
   384 # For all html documentation in $module/share/specs directories, copy it
   387       $(eval JDK_SPECS_TARGETS += $(COPY_$m)) \
   399       $(eval JDK_SPECS_TARGETS += $(COPY_$m)) \
   388     ) \
   400     ) \
   389   ) \
   401   ) \
   390 )
   402 )
   391 
   403 
   392 # Copy the global resources
       
   393 GLOBAL_SPECS_RESOURCES_DIR := $(JDK_TOPDIR)/make/data/docs-resources/specs
       
   394 $(eval $(call SetupCopyFiles, COPY_GLOBAL_RESOURCES, \
       
   395     SRC := $(GLOBAL_SPECS_RESOURCES_DIR), \
       
   396     FILES := $(call CacheFind, $(GLOBAL_SPECS_RESOURCES_DIR)), \
       
   397     DEST := $(DOCS_OUTPUTDIR)/specs/, \
       
   398 ))
       
   399 JDK_SPECS_TARGETS += $(COPY_GLOBAL_RESOURCES)
       
   400 
       
   401 ifeq ($(ENABLE_FULL_DOCS), true)
   404 ifeq ($(ENABLE_FULL_DOCS), true)
   402   # For all markdown files in $module/share/specs directories, convert them to
   405   # For all markdown files in $module/share/specs directories, convert them to
   403   # html.
   406   # html.
   404 
   407 
   405   GLOBAL_SPECS_DEFAULT_CSS_FILE := $(DOCS_OUTPUTDIR)/specs/resources/jdk-default.css
   408   GLOBAL_SPECS_DEFAULT_CSS_FILE := $(DOCS_OUTPUTDIR)/resources/jdk-default.css
   406 
   409 
   407   $(foreach m, $(ALL_MODULES), \
   410   $(foreach m, $(ALL_MODULES), \
   408     $(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \
   411     $(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \
   409     $(foreach d, $(SPECS_$m), \
   412     $(foreach d, $(SPECS_$m), \
   410       $(if $(filter %.md, $(call CacheFind, $d)), \
   413       $(if $(filter %.md, $(call CacheFind, $d)), \
   462 
   465 
   463 docs-javase-api-modulegraph: $(JAVASE_API_MODULEGRAPH_TARGETS)
   466 docs-javase-api-modulegraph: $(JAVASE_API_MODULEGRAPH_TARGETS)
   464 
   467 
   465 docs-jdk-specs: $(JDK_SPECS_TARGETS)
   468 docs-jdk-specs: $(JDK_SPECS_TARGETS)
   466 
   469 
   467 docs-jdk-index: $(JDK_DOCS_INDEX_HTML_TARGETS)
   470 docs-jdk-index: $(JDK_INDEX_TARGETS)
   468 
   471 
   469 docs-zip: $(ZIP_TARGETS)
   472 docs-zip: $(ZIP_TARGETS)
   470 
   473 
   471 all: docs-jdk-api-javadoc docs-jdk-api-modulegraph docs-javase-api-javadoc \
   474 all: docs-jdk-api-javadoc docs-jdk-api-modulegraph docs-javase-api-javadoc \
   472     docs-javase-api-modulegraph docs-jdk-specs docs-jdk-index docs-zip
   475     docs-javase-api-modulegraph docs-jdk-specs docs-jdk-index docs-zip