< prev index next >

make/Javadoc.gmk

Print this page




  57     -bootclasspath $(JDK_OUTPUTDIR)/classes
  58 
  59 # Copyright year for beginning of Java and some of the apis
  60 # (Needed when creating the javadocs)
  61 FIRST_COPYRIGHT_YEAR = 1993
  62 DOMAPI_FIRST_COPYRIGHT_YEAR = 2005
  63 MIRROR_FIRST_COPYRIGHT_YEAR = 2004
  64 DOCLETAPI_FIRST_COPYRIGHT_YEAR = 1993
  65 TAGLETAPI_FIRST_COPYRIGHT_YEAR = 1993
  66 JDI_FIRST_COPYRIGHT_YEAR = 1999
  67 JAAS_FIRST_COPYRIGHT_YEAR = 1998
  68 JGSS_FIRST_COPYRIGHT_YEAR = 2000
  69 SMARTCARDIO_FIRST_COPYRIGHT_YEAR = 2005
  70 HTTPSERVER_FIRST_COPYRIGHT_YEAR = 2005
  71 MGMT_FIRST_COPYRIGHT_YEAR = 2003
  72 ATTACH_FIRST_COPYRIGHT_YEAR = 2005
  73 JCONSOLE_FIRST_COPYRIGHT_YEAR = 2006
  74 SCTPAPI_FIRST_COPYRIGHT_YEAR = 2009
  75 TRACING_FIRST_COPYRIGHT_YEAR = 2008
  76 TREEAPI_FIRST_COPYRIGHT_YEAR = 2005

  77 JNLP_FIRST_COPYRIGHT_YEAR = 1998
  78 PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007
  79 JDKNET_FIRST_COPYRIGHT_YEAR = 2014
  80 
  81 # Oracle name
  82 FULL_COMPANY_NAME = Oracle and/or its affiliates
  83 
  84 # Copyright address
  85 COMPANY_ADDRESS = 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA.
  86 
  87 # The trademark symbol
  88 TRADEMARK = &trade;
  89 
  90 # Common copyright lines used
  91 # The word "Copyright" might optionally be a link to the file cpyr.html.
  92 # The first year of copyright may vary or not be available.
  93 # The address to the company might be optional.
  94 COMMA:= ,
  95 EMPTY:=
  96 SPACE:=$(EMPTY) $(EMPTY)


 123 DOCS_BASE_URL = http://download.oracle.com/javase/7/docs
 124 
 125 # Common Java trademark line
 126 JAVA_TRADEMARK_LINE = Java is a trademark or registered trademark of \
 127 $(FULL_COMPANY_NAME) in the US and other countries.
 128 
 129 #################################################################
 130 # Macros:
 131 
 132 
 133 # List of all possible directories for javadoc to look for sources
 134 # NOTE: Quotes are required around sourcepath argument only on Windows.
 135 # Otherwise, you get "No packages or classes specified." due
 136 # to $(PATH_SEP) being interpreted as an end of
 137 # command (newline or shell ; character)
 138 ALL_SOURCE_DIRS := $(wildcard \
 139       $(JDK_TOPDIR)/src/*/share/classes \
 140       $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS)/classes \
 141       $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS_TYPE)/classes \
 142       $(LANGTOOLS_TOPDIR)/src/*/share/classes \

 143       $(CORBA_TOPDIR)/src/*/share/classes \
 144       $(JAXP_TOPDIR)/src/*/share/classes \
 145       $(JAXWS_TOPDIR)/src/*/share/classes \
 146       $(JDK_OUTPUTDIR)/gensrc/j* \
 147       $(JDK_OUTPUTDIR)/gendocsrc_rmic \
 148       $(CORBA_OUTPUTDIR)/gensrc/j* \
 149       $(JDK_TOPDIR)/src/*/share/doc/stub \
 150       ) \
 151       #
 152 
 153 # List with classpath separator between them
 154 EMPTY:=
 155 SPACE:= $(EMPTY) $(EMPTY)
 156 RELEASEDOCS_SOURCEPATH = \
 157     $(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_SOURCE_DIRS)))
 158 
 159 define prep-target
 160         $(MKDIR) -p $(@D)
 161         $(RM) $@
 162 endef


1112         @($(call COMMON_JAVADOCFLAGS) ; \
1113           $(call COMMON_JAVADOCTAGS) ; \
1114           $(call OptionOnly,-Xdoclint:all) ; \
1115           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1116           $(call OptionPair,-encoding,ascii) ; \
1117           $(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \
1118           $(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1119           $(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \
1120           $(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1121           $(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \
1122           $(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1123         ) >> $@
1124 
1125 # Create a file with the package names in it
1126 $(TREEAPI_PACKAGES_FILE): $(call PackageDependencies,$(TREEAPI_PKGS))
1127         $(prep-target)
1128         $(call PackageFilter,$(TREEAPI_PKGS))
1129 
1130 #############################################################
1131 #






















































1132 # sctpdocs
1133 #
1134 
1135 ALL_OTHER_TARGETS += sctpdocs
1136 
1137 SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec
1138 SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
1139 SCTPAPI_DOCTITLE := SCTP API
1140 SCTPAPI_WINDOWTITLE := SCTP API
1141 SCTPAPI_HEADER := <strong>SCTP API</strong>
1142 SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR))
1143 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk
1144 
1145 SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html
1146 SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options
1147 SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages
1148 
1149 sctpdocs: $(SCTPAPI_INDEX_HTML)
1150 
1151 # Set relative location to core api document root




  57     -bootclasspath $(JDK_OUTPUTDIR)/classes
  58 
  59 # Copyright year for beginning of Java and some of the apis
  60 # (Needed when creating the javadocs)
  61 FIRST_COPYRIGHT_YEAR = 1993
  62 DOMAPI_FIRST_COPYRIGHT_YEAR = 2005
  63 MIRROR_FIRST_COPYRIGHT_YEAR = 2004
  64 DOCLETAPI_FIRST_COPYRIGHT_YEAR = 1993
  65 TAGLETAPI_FIRST_COPYRIGHT_YEAR = 1993
  66 JDI_FIRST_COPYRIGHT_YEAR = 1999
  67 JAAS_FIRST_COPYRIGHT_YEAR = 1998
  68 JGSS_FIRST_COPYRIGHT_YEAR = 2000
  69 SMARTCARDIO_FIRST_COPYRIGHT_YEAR = 2005
  70 HTTPSERVER_FIRST_COPYRIGHT_YEAR = 2005
  71 MGMT_FIRST_COPYRIGHT_YEAR = 2003
  72 ATTACH_FIRST_COPYRIGHT_YEAR = 2005
  73 JCONSOLE_FIRST_COPYRIGHT_YEAR = 2006
  74 SCTPAPI_FIRST_COPYRIGHT_YEAR = 2009
  75 TRACING_FIRST_COPYRIGHT_YEAR = 2008
  76 TREEAPI_FIRST_COPYRIGHT_YEAR = 2005
  77 NASHORNAPI_FIRST_COPYRIGHT_YEAR = 2014
  78 JNLP_FIRST_COPYRIGHT_YEAR = 1998
  79 PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007
  80 JDKNET_FIRST_COPYRIGHT_YEAR = 2014
  81 
  82 # Oracle name
  83 FULL_COMPANY_NAME = Oracle and/or its affiliates
  84 
  85 # Copyright address
  86 COMPANY_ADDRESS = 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA.
  87 
  88 # The trademark symbol
  89 TRADEMARK = &trade;
  90 
  91 # Common copyright lines used
  92 # The word "Copyright" might optionally be a link to the file cpyr.html.
  93 # The first year of copyright may vary or not be available.
  94 # The address to the company might be optional.
  95 COMMA:= ,
  96 EMPTY:=
  97 SPACE:=$(EMPTY) $(EMPTY)


 124 DOCS_BASE_URL = http://download.oracle.com/javase/7/docs
 125 
 126 # Common Java trademark line
 127 JAVA_TRADEMARK_LINE = Java is a trademark or registered trademark of \
 128 $(FULL_COMPANY_NAME) in the US and other countries.
 129 
 130 #################################################################
 131 # Macros:
 132 
 133 
 134 # List of all possible directories for javadoc to look for sources
 135 # NOTE: Quotes are required around sourcepath argument only on Windows.
 136 # Otherwise, you get "No packages or classes specified." due
 137 # to $(PATH_SEP) being interpreted as an end of
 138 # command (newline or shell ; character)
 139 ALL_SOURCE_DIRS := $(wildcard \
 140       $(JDK_TOPDIR)/src/*/share/classes \
 141       $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS)/classes \
 142       $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS_TYPE)/classes \
 143       $(LANGTOOLS_TOPDIR)/src/*/share/classes \
 144       $(NASHORN_TOPDIR)/src/*/share/classes \
 145       $(CORBA_TOPDIR)/src/*/share/classes \
 146       $(JAXP_TOPDIR)/src/*/share/classes \
 147       $(JAXWS_TOPDIR)/src/*/share/classes \
 148       $(JDK_OUTPUTDIR)/gensrc/j* \
 149       $(JDK_OUTPUTDIR)/gendocsrc_rmic \
 150       $(CORBA_OUTPUTDIR)/gensrc/j* \
 151       $(JDK_TOPDIR)/src/*/share/doc/stub \
 152       ) \
 153       #
 154 
 155 # List with classpath separator between them
 156 EMPTY:=
 157 SPACE:= $(EMPTY) $(EMPTY)
 158 RELEASEDOCS_SOURCEPATH = \
 159     $(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_SOURCE_DIRS)))
 160 
 161 define prep-target
 162         $(MKDIR) -p $(@D)
 163         $(RM) $@
 164 endef


1114         @($(call COMMON_JAVADOCFLAGS) ; \
1115           $(call COMMON_JAVADOCTAGS) ; \
1116           $(call OptionOnly,-Xdoclint:all) ; \
1117           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1118           $(call OptionPair,-encoding,ascii) ; \
1119           $(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \
1120           $(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1121           $(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \
1122           $(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1123           $(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \
1124           $(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1125         ) >> $@
1126 
1127 # Create a file with the package names in it
1128 $(TREEAPI_PACKAGES_FILE): $(call PackageDependencies,$(TREEAPI_PKGS))
1129         $(prep-target)
1130         $(call PackageFilter,$(TREEAPI_PKGS))
1131 
1132 #############################################################
1133 #
1134 # nashornapidocs
1135 #
1136 
1137 ALL_OTHER_TARGETS += nashornapidocs
1138 
1139 NASHORNAPI_DOCDIR := $(JDK_API_DOCSDIR)/nashorn
1140 NASHORNAPI2COREAPI := ../$(JDKJRE2COREAPI)
1141 NASHORNAPI_DOCTITLE := Nashorn API
1142 NASHORNAPI_WINDOWTITLE := Nashorn API
1143 NASHORNAPI_HEADER := <strong>Nashorn API</strong>
1144 NASHORNAPI_BOTTOM := $(call CommonBottom,$(NASHORNAPI_FIRST_COPYRIGHT_YEAR))
1145 NASHORNAPI_GROUPNAME := Packages
1146 NASHORNAPI_REGEXP := jdk.nashorn.api.scripting.*
1147 # NASHORNAPI_PKGS is located in NON_CORE_PKGS.gmk
1148 
1149 NASHORNAPI_INDEX_HTML = $(NASHORNAPI_DOCDIR)/index.html
1150 NASHORNAPI_OPTIONS_FILE = $(DOCSTMPDIR)/nashornapi.options
1151 NASHORNAPI_PACKAGES_FILE = $(DOCSTMPDIR)/nashornapi.packages
1152 
1153 nashornapidocs: $(NASHORNAPI_INDEX_HTML)
1154 
1155 # Set relative location to core api document root
1156 $(NASHORNAPI_INDEX_HTML): GET2DOCSDIR=$(NASHORNAPI2COREAPI)/..
1157 
1158 # Run javadoc if the index file is out of date or missing
1159 $(NASHORNAPI_INDEX_HTML): $(NASHORNAPI_OPTIONS_FILE) $(NASHORNAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1160         $(prep-javadoc)
1161         $(call JavadocSummary,$(NASHORNAPI_OPTIONS_FILE),$(NASHORNAPI_PACKAGES_FILE))
1162         $(JAVADOC_CMD) -d $(@D) \
1163             @$(NASHORNAPI_OPTIONS_FILE) @$(NASHORNAPI_PACKAGES_FILE)
1164 
1165 # Create file with javadoc options in it
1166 $(NASHORNAPI_OPTIONS_FILE):
1167         $(prep-target)
1168         @($(call COMMON_JAVADOCFLAGS) ; \
1169           $(call COMMON_JAVADOCTAGS) ; \
1170           $(call OptionOnly,-Xdoclint:all) ; \
1171           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1172           $(call OptionPair,-encoding,ascii) ; \
1173           $(call OptionPair,-doctitle,$(NASHORNAPI_DOCTITLE)) ; \
1174           $(call OptionPair,-windowtitle,$(NASHORNAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1175           $(call OptionPair,-header,$(NASHORNAPI_HEADER)$(DRAFT_HEADER)) ; \
1176           $(call OptionPair,-bottom,$(NASHORNAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1177           $(call OptionTrip,-group,$(NASHORNAPI_GROUPNAME),$(NASHORNAPI_REGEXP)); \
1178           $(call OptionTrip,-linkoffline,$(NASHORNAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1179         ) >> $@
1180 
1181 # Create a file with the package names in it
1182 $(NASHORNAPI_PACKAGES_FILE): $(call PackageDependencies,$(NASHORNAPI_PKGS))
1183         $(prep-target)
1184         $(call PackageFilter,$(NASHORNAPI_PKGS))
1185 
1186 #############################################################
1187 #
1188 # sctpdocs
1189 #
1190 
1191 ALL_OTHER_TARGETS += sctpdocs
1192 
1193 SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec
1194 SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
1195 SCTPAPI_DOCTITLE := SCTP API
1196 SCTPAPI_WINDOWTITLE := SCTP API
1197 SCTPAPI_HEADER := <strong>SCTP API</strong>
1198 SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR))
1199 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk
1200 
1201 SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html
1202 SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options
1203 SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages
1204 
1205 sctpdocs: $(SCTPAPI_INDEX_HTML)
1206 
1207 # Set relative location to core api document root


< prev index next >