make/Javadoc.gmk
changeset 25854 98ce0879ab4c
parent 25614 0d18591d71d8
child 26119 40d3b21dbede
equal deleted inserted replaced
25853:63fbc565bba5 25854:98ce0879ab4c
    39 
    39 
    40 .SUFFIXES: # Delete the default suffixes
    40 .SUFFIXES: # Delete the default suffixes
    41 .SUFFIXES: .java
    41 .SUFFIXES: .java
    42 
    42 
    43 #
    43 #
    44 # Definitions for $(DOCSDIR), $(MKDIR), $(BINDIR), etc.
    44 # Definitions for directories
    45 #
    45 #
    46 
    46 
    47 DOCSDIR=$(OUTPUT_ROOT)/docs
    47 DOCSDIR := $(OUTPUT_ROOT)/docs
    48 TEMPDIR=$(OUTPUT_ROOT)/docstemp
    48 TEMPDIR := $(OUTPUT_ROOT)/docstemp
    49 
       
    50 JDK_SHARE_SRC=$(JDK_TOPDIR)/src/share
       
    51 JDK_SHARE_CLASSES=$(JDK_SHARE_SRC)/classes
       
    52 
       
    53 JDK_IMPSRC = $(JDK_OUTPUTDIR)/impsrc
       
    54 
       
    55 JDK_GENSRC = $(JDK_OUTPUTDIR)/gensrc
       
    56 
    49 
    57 HOTSPOT_DOCS_IMPORT_PATH=$(HOTSPOT_OUTPUTDIR)/docs
    50 HOTSPOT_DOCS_IMPORT_PATH=$(HOTSPOT_OUTPUTDIR)/docs
    58 
    51 
    59 BUILD_NUMBER=$(JDK_BUILD_NUMBER)
    52 BUILD_NUMBER=$(JDK_BUILD_NUMBER)
    60 
    53 
   141 # List of all possible directories for javadoc to look for sources
   134 # List of all possible directories for javadoc to look for sources
   142 # NOTE: Quotes are required around sourcepath argument only on Windows.
   135 # NOTE: Quotes are required around sourcepath argument only on Windows.
   143 # Otherwise, you get "No packages or classes specified." due
   136 # Otherwise, you get "No packages or classes specified." due
   144 # to $(PATH_SEP) being interpreted as an end of
   137 # to $(PATH_SEP) being interpreted as an end of
   145 # command (newline or shell ; character)
   138 # command (newline or shell ; character)
   146 ALL_SOURCE_DIRS = $(JDK_SHARE_CLASSES) \
   139 ALL_SOURCE_DIRS := $(wildcard \
   147     $(JDK_IMPSRC) \
   140       $(JDK_TOPDIR)/src/*/share/classes \
   148     $(JDK_GENSRC) \
   141       $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS_API_DIR)/classes \
   149     $(JDK_OUTPUTDIR)/gendocsrc_rmic \
   142       $(LANGTOOLS_TOPDIR)/src/*/share/classes \
   150     $(JDK_TOPDIR)/src/solaris/classes \
   143       $(CORBA_TOPDIR)/src/*/share/classes \
   151     $(JDK_TOPDIR)/src/windows/classes \
   144       $(JAXP_TOPDIR)/src/*/share/classes \
   152     $(JDK_SHARE_SRC)/doc/stub
   145       $(JAXWS_TOPDIR)/src/*/share/classes \
   153 
   146       $(JDK_OUTPUTDIR)/gensrc/j* \
   154 # List of directories that actually exist
   147       $(JDK_OUTPUTDIR)/gendocsrc_rmic \
   155 ALL_EXISTING_SOURCE_DIRS := $(wildcard $(ALL_SOURCE_DIRS))
   148       $(CORBA_OUTPUTDIR)/gensrc/j* \
       
   149       $(JDK_TOPDIR)/src/*/share/doc/stub \
       
   150       ) \
       
   151       #
   156 
   152 
   157 # List with classpath separator between them
   153 # List with classpath separator between them
   158 EMPTY:=
   154 EMPTY:=
   159 SPACE:= $(EMPTY) $(EMPTY)
   155 SPACE:= $(EMPTY) $(EMPTY)
   160 RELEASEDOCS_SOURCEPATH = \
   156 RELEASEDOCS_SOURCEPATH = \
   174 	$(MKDIR) -p $(@D)
   170 	$(MKDIR) -p $(@D)
   175 endef
   171 endef
   176 
   172 
   177 $(eval $(call FillCacheFind, $(ALL_SOURCE_DIRS)))
   173 $(eval $(call FillCacheFind, $(ALL_SOURCE_DIRS)))
   178 define PackageDependencies
   174 define PackageDependencies
   179   $(call CacheFind, $(foreach p, $(subst .,/,$1), $(addsuffix /$p, $(ALL_SOURCE_DIRS))))
   175   $(call CacheFind, $(wildcard $(foreach p, $(subst .,/,$1), $(addsuffix /$p, $(ALL_SOURCE_DIRS)))))
   180 endef
   176 endef
   181 
   177 
   182 # Given a list of packages, add packages that exist to $@, print summary
   178 # Given a list of packages, add packages that exist to $@, print summary
   183 define PackageFilter # packages
   179 define PackageFilter # packages
   184 	@if [ "$1" != "" ] ; then \
   180 	@if [ "$1" != "" ] ; then \
   380 COREAPI_WINDOWTITLE = Java Platform SE $(JDK_MINOR_VERSION)
   376 COREAPI_WINDOWTITLE = Java Platform SE $(JDK_MINOR_VERSION)
   381 COREAPI_HEADER = \
   377 COREAPI_HEADER = \
   382 <strong>Java$(TRADEMARK)&nbsp;Platform<br>Standard&nbsp;Ed.&nbsp;$(JDK_MINOR_VERSION)</strong>
   378 <strong>Java$(TRADEMARK)&nbsp;Platform<br>Standard&nbsp;Ed.&nbsp;$(JDK_MINOR_VERSION)</strong>
   383 
   379 
   384 # Overview file for core apis
   380 # Overview file for core apis
   385 COREAPI_OVERVIEW = $(JDK_SHARE_CLASSES)/overview-core.html
   381 COREAPI_OVERVIEW = $(JDK_TOPDIR)/src/java.base/share/classes/overview-core.html
   386 
   382 
   387 # The index.html, options, and packages files
   383 # The index.html, options, and packages files
   388 COREAPI_INDEX_FILE = $(COREAPI_DOCSDIR)/index.html
   384 COREAPI_INDEX_FILE = $(COREAPI_DOCSDIR)/index.html
   389 COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options
   385 COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options
   390 COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages
   386 COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages
   532 	) >> $@
   528 	) >> $@
   533 
   529 
   534 # Create a file with the package names in it
   530 # Create a file with the package names in it
   535 $(TAGLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(TAGLETAPI_PKGS))
   531 $(TAGLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(TAGLETAPI_PKGS))
   536 	$(prep-target)
   532 	$(prep-target)
   537 	@($(ECHO) "$(JDK_IMPSRC)/$(TAGLETAPI_FILE)" ) > $@
   533 	@($(ECHO) "$(LANGTOOLS_TOPDIR)/src/jdk.javadoc/share/classes/$(TAGLETAPI_FILE)" ) > $@
   538 
   534 
   539 #############################################################
   535 #############################################################
   540 #
   536 #
   541 # domapidocs
   537 # domapidocs
   542 #
   538 #
   612 JDI2COREAPI := ../../$(JDKJRE2COREAPI)
   608 JDI2COREAPI := ../../$(JDKJRE2COREAPI)
   613 JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface
   609 JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface
   614 JDI_WINDOWTITLE := Java Debug Interface
   610 JDI_WINDOWTITLE := Java Debug Interface
   615 JDI_HEADER := <strong>Java Debug Interface</strong>
   611 JDI_HEADER := <strong>Java Debug Interface</strong>
   616 JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR))
   612 JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR))
   617 JDI_OVERVIEW := $(JDK_SHARE_CLASSES)/jdi-overview.html
   613 JDI_OVERVIEW := $(JDK_TOPDIR)/src/jdk.jdi/share/classes/jdi-overview.html
   618 # JDI_PKGS is located in NON_CORE_PKGS.gmk
   614 # JDI_PKGS is located in NON_CORE_PKGS.gmk
   619 
   615 
   620 # The index.html, options, and packages files
   616 # The index.html, options, and packages files
   621 JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html
   617 JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html
   622 JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options
   618 JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options
   701 JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service
   697 JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service
   702 JAAS_WINDOWTITLE := Java Authentication and Authorization Service
   698 JAAS_WINDOWTITLE := Java Authentication and Authorization Service
   703 JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong>
   699 JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong>
   704 JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR))
   700 JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR))
   705 # JAAS_PKGS is located in NON_CORE_PKGS.gmk
   701 # JAAS_PKGS is located in NON_CORE_PKGS.gmk
   706 JAAS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/auth/jaas-overview.html
   702 JAAS_OVERVIEW := $(JDK_TOPDIR)/src/jdk.security.auth/share/classes/jaas-overview.html
   707 
   703 
   708 # The index.html, options, and packages files
   704 # The index.html, options, and packages files
   709 JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html
   705 JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html
   710 JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options
   706 JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options
   711 JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages
   707 JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages
   754 JGSS2COREAPI := ../../../$(JDKJRE2COREAPI)
   750 JGSS2COREAPI := ../../../$(JDKJRE2COREAPI)
   755 JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities
   751 JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities
   756 JGSS_WINDOWTITLE := Java GSS-API Utilities
   752 JGSS_WINDOWTITLE := Java GSS-API Utilities
   757 JGSS_HEADER := <strong>Java GSS-API Utilities</strong>
   753 JGSS_HEADER := <strong>Java GSS-API Utilities</strong>
   758 JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR))
   754 JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR))
   759 JGSS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/jgss/jgss-overview.html
   755 JGSS_OVERVIEW := $(JDK_TOPDIR)/src/java.security.jgss/share/classes/jgss-overview.html
   760 # JGSS_PKGS is located in NON_CORE_PKGS.gmk
   756 # JGSS_PKGS is located in NON_CORE_PKGS.gmk
   761 
   757 
   762 # The index.html, options, and packages files
   758 # The index.html, options, and packages files
   763 JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html
   759 JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html
   764 JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options
   760 JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options
   911 ALL_OTHER_TARGETS += mgmtdocs
   907 ALL_OTHER_TARGETS += mgmtdocs
   912 
   908 
   913 MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension
   909 MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension
   914 MGMT2COREAPI := ../../$(JDKJRE2COREAPI)
   910 MGMT2COREAPI := ../../$(JDKJRE2COREAPI)
   915 JVM_MIB_NAME := JVM-MANAGEMENT-MIB.mib
   911 JVM_MIB_NAME := JVM-MANAGEMENT-MIB.mib
   916 JVM_MIB_SRC := $(JDK_TOPDIR)/src/closed/share/classes/sun/management/snmp/$(JVM_MIB_NAME)
   912 JVM_MIB_SRC := $(JDK_TOPDIR)/src/closed/jdk.snmp/share/classes/sun/management/snmp/$(JVM_MIB_NAME)
   917 MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform
   913 MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform
   918 MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform
   914 MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform
   919 MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong>
   915 MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong>
   920 MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR))
   916 MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR))
   921 MGMT_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/management/mgmt-overview.html
   917 MGMT_OVERVIEW := $(JDK_TOPDIR)/src/java.management/share/classes/mgmt-overview.html
   922 # MGMT_PKGS is located in NON_CORE_PKGS.gmk
   918 # MGMT_PKGS is located in NON_CORE_PKGS.gmk
   923 
   919 
   924 # The index.html, options, and packages files
   920 # The index.html, options, and packages files
   925 MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html
   921 MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html
   926 MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options
   922 MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options