make/Javadoc.gmk
changeset 39932 a0794ee00a5b
parent 39609 59f6b3bda1b6
child 39935 6016bd47edc9
equal deleted inserted replaced
39678:5bf88dce615f 39932:a0794ee00a5b
    80 DYNALINKAPI_FIRST_COPYRIGHT_YEAR = 2015
    80 DYNALINKAPI_FIRST_COPYRIGHT_YEAR = 2015
    81 JNLP_FIRST_COPYRIGHT_YEAR = 1998
    81 JNLP_FIRST_COPYRIGHT_YEAR = 1998
    82 PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007
    82 PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007
    83 JDKNET_FIRST_COPYRIGHT_YEAR = 2014
    83 JDKNET_FIRST_COPYRIGHT_YEAR = 2014
    84 JACCESSAPI_FIRST_COPYRIGHT_YEAR = 2002
    84 JACCESSAPI_FIRST_COPYRIGHT_YEAR = 2002
    85 
    85 JSOBJECT_FIRST_COPYRIGHT_YEAR = 1993
    86 
    86 
    87 # Oracle name
    87 # Oracle name
    88 FULL_COMPANY_NAME = Oracle and/or its affiliates
    88 FULL_COMPANY_NAME = Oracle and/or its affiliates
    89 
    89 
    90 # Copyright address
    90 # Copyright address
  1025 	$(prep-target)
  1025 	$(prep-target)
  1026 	$(call PackageFilter,$(HTTPSERVER_PKGS))
  1026 	$(call PackageFilter,$(HTTPSERVER_PKGS))
  1027 
  1027 
  1028 #############################################################
  1028 #############################################################
  1029 #
  1029 #
       
  1030 # jsobjectdocs
       
  1031 #
       
  1032 
       
  1033 ALL_OTHER_TARGETS += jsobjectdocs
       
  1034 
       
  1035 JSOBJECT_DOCDIR := $(JRE_API_DOCSDIR)/plugin/jsobject
       
  1036 JSOBJECT2COREAPI := ../../$(JDKJRE2COREAPI)
       
  1037 JSOBJECT_DOCTITLE := Java$(TRADEMARK) JSObject Doc
       
  1038 JSOBJECT_WINDOWTITLE := Java JSObject Doc
       
  1039 JSOBJECT_HEADER := <strong>Java JSObject Doc</strong>
       
  1040 JSOBJECT_BOTTOM := $(call CommonBottom,$(JSOBJECT_FIRST_COPYRIGHT_YEAR))
       
  1041 # JSOBJECT_PKGS is located in NON_CORE_PKGS.gmk
       
  1042 
       
  1043 JSOBJECT_INDEX_HTML = $(JSOBJECT_DOCDIR)/index.html
       
  1044 JSOBJECT_OPTIONS_FILE = $(DOCSTMPDIR)/jsobject.options
       
  1045 JSOBJECT_PACKAGES_FILE = $(DOCSTMPDIR)/jsobject.packages
       
  1046 
       
  1047 # The modules required to be documented
       
  1048 JSOBJECT_MODULES = jdk.jsobject
       
  1049 
       
  1050 jsobjectdocs: $(JSOBJECT_INDEX_HTML)
       
  1051 
       
  1052 # Set relative location to core api document root
       
  1053 $(JSOBJECT_INDEX_HTML): GET2DOCSDIR=$(JSOBJECT2COREAPI)/..
       
  1054 
       
  1055 # Run javadoc if the index file is out of date or missing
       
  1056 $(JSOBJECT_INDEX_HTML): $(JSOBJECT_OPTIONS_FILE) $(JSOBJECT_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
       
  1057 	$(prep-javadoc)
       
  1058 	$(call JavadocSummary,$(JSOBJECT_OPTIONS_FILE),$(JSOBJECT_PACKAGES_FILE))
       
  1059 	$(JAVADOC_CMD_SMALL) -d $(@D) \
       
  1060 	    @$(JSOBJECT_OPTIONS_FILE) @$(JSOBJECT_PACKAGES_FILE)
       
  1061 
       
  1062 # Create file with javadoc options in it
       
  1063 $(JSOBJECT_OPTIONS_FILE):
       
  1064 	$(prep-target)
       
  1065 	@($(call COMMON_JAVADOCFLAGS) ; \
       
  1066           $(call COMMON_JAVADOCTAGS) ; \
       
  1067 	  $(call OptionOnly,-Xdoclint:none) ; \
       
  1068           $(call OptionPair,-system,none) ; \
       
  1069 	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
       
  1070 	  $(call OptionPair,-addmods,$(JSOBJECT_MODULES)) ; \
       
  1071 	  $(call OptionPair,-encoding,ascii) ; \
       
  1072 	  $(call OptionOnly,-nodeprecatedlist) ; \
       
  1073 	  $(call OptionPair,-doctitle,$(JSOBJECT_DOCTITLE)) ; \
       
  1074 	  $(call OptionPair,-windowtitle,$(JSOBJECT_WINDOWTITLE) $(DRAFT_WINTITLE)); \
       
  1075 	  $(call OptionPair,-header,$(JSOBJECT_HEADER)$(DRAFT_HEADER)); \
       
  1076 	  $(call OptionPair,-bottom,$(JSOBJECT_BOTTOM)$(DRAFT_BOTTOM)); \
       
  1077 	  $(call OptionTrip,-linkoffline,$(JSOBJECT2COREAPI),$(COREAPI_DOCSDIR)/); \
       
  1078 	) >> $@
       
  1079 
       
  1080 # Create a file with the package names in it
       
  1081 $(JSOBJECT_PACKAGES_FILE): $(call PackageDependencies,$(JSOBJECT_PKGS))
       
  1082 	$(prep-target)
       
  1083 	$(call PackageFilter,$(JSOBJECT_PKGS))
       
  1084 
       
  1085 
       
  1086 #############################################################
       
  1087 #
  1030 # mgmtdocs
  1088 # mgmtdocs
  1031 #
  1089 #
  1032 
  1090 
  1033 ALL_OTHER_TARGETS += mgmtdocs
  1091 ALL_OTHER_TARGETS += mgmtdocs
  1034 
  1092 
  1608 #
  1666 #
  1609 # jlink plugin API docs
  1667 # jlink plugin API docs
  1610 #
  1668 #
  1611 # TODO: Need to decide when the plugin API is ready to publish as experimental API.
  1669 # TODO: Need to decide when the plugin API is ready to publish as experimental API.
  1612 # This target is temporarily added for internal use for now.
  1670 # This target is temporarily added for internal use for now.
  1613 #        
  1671 #
  1614 
  1672 
  1615 ALL_OTHER_TARGETS += jlinkdocs
  1673 ALL_OTHER_TARGETS += jlinkdocs
  1616 
  1674 
  1617 JLINK_PLUGIN_FIRST_COPYRIGHT_YEAR = 2015
  1675 JLINK_PLUGIN_FIRST_COPYRIGHT_YEAR = 2015
  1618 JLINK_PLUGIN_DOCDIR := $(JDK_API_DOCSDIR)/jlink
  1676 JLINK_PLUGIN_DOCDIR := $(JDK_API_DOCSDIR)/jlink