make/Javadoc.gmk
changeset 44482 d045646dedfa
parent 44397 f932d6b9f7fe
child 44725 8747b14eb49c
child 46202 6221728aa15e
equal deleted inserted replaced
44481:f2b3b6bb1f4a 44482:d045646dedfa
    25 default: all
    25 default: all
    26 
    26 
    27 include $(SPEC)
    27 include $(SPEC)
    28 include MakeBase.gmk
    28 include MakeBase.gmk
    29 include $(JDK_TOPDIR)/make/Tools.gmk
    29 include $(JDK_TOPDIR)/make/Tools.gmk
       
    30 include $(JDK_TOPDIR)/make/ModuleTools.gmk
    30 
    31 
    31 ################################################################################
    32 ################################################################################
    32 
    33 
    33 # List of all possible directories for javadoc to look for sources
    34 # List of all possible directories for javadoc to look for sources
    34 # Allow custom to overwrite.
    35 # Allow custom to overwrite.
   172     -tag 'implSpec:a:Implementation Requirements:' \
   173     -tag 'implSpec:a:Implementation Requirements:' \
   173     -tag 'implNote:a:Implementation Note:' \
   174     -tag 'implNote:a:Implementation Note:' \
   174     -tag param \
   175     -tag param \
   175     -tag return \
   176     -tag return \
   176     -tag throws \
   177     -tag throws \
       
   178     -taglet build.tools.taglet.ModuleGraph \
   177     -tag since \
   179     -tag since \
   178     -tag version \
   180     -tag version \
   179     -tag serialData \
   181     -tag serialData \
   180     -tag factory \
   182     -tag factory \
   181     -tag see \
   183     -tag see \
   185     -tagletpath $(BUILDTOOLS_OUTPUTDIR)/jdk_tools_classes \
   187     -tagletpath $(BUILDTOOLS_OUTPUTDIR)/jdk_tools_classes \
   186     #
   188     #
   187 
   189 
   188 DEFAULT_JAVADOC_OPTIONS := -XDignore.symbol.file=true -use -keywords -notimestamp \
   190 DEFAULT_JAVADOC_OPTIONS := -XDignore.symbol.file=true -use -keywords -notimestamp \
   189     -serialwarn -encoding ISO-8859-1 -breakiterator --system none
   191     -serialwarn -encoding ISO-8859-1 -breakiterator --system none
       
   192 
       
   193 #
       
   194 # TODO: this should be set by the configure option.
       
   195 #
       
   196 ifndef ENABLE_MODULE_GRAPH
       
   197    ENABLE_MODULE_GRAPH=false
       
   198 endif
   190 
   199 
   191 ################################################################################
   200 ################################################################################
   192 # Setup make rules for running javadoc.
   201 # Setup make rules for running javadoc.
   193 #
   202 #
   194 # Parameter 1 is the name of the rule. This name is used as variable prefix,
   203 # Parameter 1 is the name of the rule. This name is used as variable prefix,
   319 	$$(call MakeDir, $$(@D))
   328 	$$(call MakeDir, $$(@D))
   320         ifneq ($$($1_PACKAGES_FILE), )
   329         ifneq ($$($1_PACKAGES_FILE), )
   321 	  $$(eval $$(call ListPathsSafely, $1_PACKAGES, $$($1_PACKAGES_FILE)))
   330 	  $$(eval $$(call ListPathsSafely, $1_PACKAGES, $$($1_PACKAGES_FILE)))
   322         endif
   331         endif
   323 	$$(call ExecuteWithLog, $$(SUPPORT_OUTPUTDIR)/docs/$1.javadoc, \
   332 	$$(call ExecuteWithLog, $$(SUPPORT_OUTPUTDIR)/docs/$1.javadoc, \
   324 	    $$($1_JAVA) -Djava.awt.headless=true $(NEW_JAVADOC) -d $$(@D) \
   333 	    $$($1_JAVA) -Djava.awt.headless=true -DenableModuleGraph=$(ENABLE_MODULE_GRAPH) \
       
   334 		$(NEW_JAVADOC) -d $$(@D) \
   325 	        $$(DEFAULT_JAVADOC_TAGS) $$(DEFAULT_JAVADOC_OPTIONS) \
   335 	        $$(DEFAULT_JAVADOC_TAGS) $$(DEFAULT_JAVADOC_OPTIONS) \
   326 	        --module-source-path $$(call PathList, $$(JAVADOC_SOURCE_DIRS)) \
   336 	        --module-source-path $$(call PathList, $$(JAVADOC_SOURCE_DIRS)) \
   327 	        $$($1_OPTIONS) $$($1_PACKAGES_ARG))
   337 	        $$($1_OPTIONS) $$($1_PACKAGES_ARG))
   328 
   338 
   329   # The output returned will be the index.html file
   339   # The output returned will be the index.html file
   733 	popd ;
   743 	popd ;
   734 
   744 
   735 ZIP_TARGETS += $(JAVADOC_ARCHIVE)
   745 ZIP_TARGETS += $(JAVADOC_ARCHIVE)
   736 
   746 
   737 ################################################################################
   747 ################################################################################
       
   748 # generate .dot files for module graphs
       
   749 
       
   750 JAVADOC_MODULE_GRAPHS_DIR := $(SUPPORT_OUTPUTDIR)/docs/module-graphs
       
   751 JAVADOC_MODULE_GRAPHS := $(JAVADOC_MODULE_GRAPHS_DIR)/java.se.dot
       
   752 JAVADOC_MODULE_GRAPHS_PROPS := $(JDK_TOPDIR)/make/src/classes/build/tools/jigsaw/javadoc-graphs.properties
       
   753 
       
   754 $(JAVADOC_MODULE_GRAPHS): $(BUILD_JIGSAW_TOOLS) $(JAVADOC_MODULE_GRAPHS_PROPS)
       
   755 	$(MKDIR) -p $(@D)
       
   756 	$(TOOL_GENGRAPHS) --spec --output $(JAVADOC_MODULE_GRAPHS_DIR) \
       
   757 	    --dot-attributes $(JAVADOC_MODULE_GRAPHS_PROPS)
       
   758 
       
   759 MODULE_GRAPH_TARGETS += $(JAVADOC_MODULE_GRAPHS)
       
   760 
       
   761 ################################################################################
   738 
   762 
   739 # Hook to include the corresponding custom file, if present.
   763 # Hook to include the corresponding custom file, if present.
   740 $(eval $(call IncludeCustomExtension, , Javadoc.gmk))
   764 $(eval $(call IncludeCustomExtension, , Javadoc.gmk))
   741 
   765 
   742 ################################################################################
   766 ################################################################################
   743 
   767 
       
   768 docs-module-graphs: $(MODULE_GRAPH_TARGETS) 
       
   769 
   744 docs-javadoc: $(TARGETS)
   770 docs-javadoc: $(TARGETS)
   745 
   771 
   746 docs-copy: $(COPY_TARGETS)
   772 docs-copy: $(COPY_TARGETS)
   747 
   773 
   748 docs-zip: $(ZIP_TARGETS)
   774 docs-zip: $(ZIP_TARGETS)
   749 
   775 
   750 all: docs-javadoc docs-copy docs-zip
   776 all: docs-module-graphs docs-javadoc docs-copy docs-zip
   751 
   777 
   752 .PHONY: default all docs-javadoc docs-copy docs-zip
   778 .PHONY: default all docs-module-graphs docs-javadoc docs-copy docs-zip