make/Javadoc.gmk

Print this page




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

  75 
  76 # Oracle name
  77 FULL_COMPANY_NAME = Oracle and/or its affiliates
  78 
  79 # Copyright address
  80 COMPANY_ADDRESS = 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA.
  81 
  82 # The trademark symbol
  83 TRADEMARK = &trade;
  84 
  85 # Common copyright lines used
  86 # The word "Copyright" might optionally be a link to the file cpyr.html.
  87 # The first year of copyright may vary or not be available.
  88 # The address to the company might be optional.
  89 COMMA:= ,
  90 EMPTY:=
  91 SPACE:=$(EMPTY) $(EMPTY)
  92 COPYRIGHT_SYMBOL = &\#x00a9;
  93 # Macro to construct the copyright line
  94 # (The GNU make 3.78.1 "if" conditional is broken, fixed in GNU make 3.81)


1142 $(SCTPAPI_OPTIONS_FILE):
1143         $(prep-target)
1144         @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1145           $(call OptionOnly,-Xdoclint:none) ; \
1146           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1147           $(call OptionPair,-encoding,ascii) ; \
1148           $(call OptionOnly,-nodeprecatedlist) ; \
1149           $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \
1150           $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1151           $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \
1152           $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1153           $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1154         ) >> $@
1155 
1156 # Create a file with the package names in it
1157 $(SCTPAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SCTPAPI_PKGS))
1158         $(prep-target)
1159         $(call PackageFilter,$(SCTPAPI_PKGS))
1160 
1161 #############################################################



















































1162 #
1163 # Get a cache of all the directories
1164 
1165 $(DIRECTORY_CACHE): $(ALL_EXISTING_SOURCE_DIRS)
1166         $(prep-target)
1167         @for cp in $(ALL_EXISTING_SOURCE_DIRS) ; do \
1168           $(ECHO) "$(FIND) $${cp} -type f >> $@"; \
1169           $(FIND) $${cp} -type f >> $@; \
1170         done
1171 
1172 #############################################################
1173 #release version of core packages ########
1174 
1175 # The rel-coredocs and rel-docs targets were added by Eric Armstrong. rel-coredocs
1176 # assumes the kind of large, 32-bit machine used in the javapubs group's docs-release
1177 # process. It specifies memory settings accordingly to maximize performance.
1178 #
1179 # The performance settings, like the sanity check, are most important for the core
1180 # docs--the platform APIs. Running javadoc on those APIs takes a significant amount
1181 # of time and memory. Setting the initial heap size as large as possible is important




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


1143 $(SCTPAPI_OPTIONS_FILE):
1144         $(prep-target)
1145         @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1146           $(call OptionOnly,-Xdoclint:none) ; \
1147           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1148           $(call OptionPair,-encoding,ascii) ; \
1149           $(call OptionOnly,-nodeprecatedlist) ; \
1150           $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \
1151           $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1152           $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \
1153           $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1154           $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1155         ) >> $@
1156 
1157 # Create a file with the package names in it
1158 $(SCTPAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SCTPAPI_PKGS))
1159         $(prep-target)
1160         $(call PackageFilter,$(SCTPAPI_PKGS))
1161 
1162 #############################################################
1163 #
1164 # jdk.net docs
1165 #
1166 
1167 ALL_OTHER_TARGETS += jdknetdocs
1168 
1169 JDKNET_DOCDIR := $(JRE_API_DOCSDIR)/net/socketoptions/spec
1170 JDKNET2COREAPI := ../../../$(JDKJRE2COREAPI)
1171 JDKNET_DOCTITLE := jdk.net API
1172 JDKNET_WINDOWTITLE := jdk.net API
1173 JDKNET_HEADER := <strong>jdk.net API</strong>
1174 JDKNET_BOTTOM := $(call CommonBottom,$(JDKNET_FIRST_COPYRIGHT_YEAR))
1175 JDKNET_PKGS := jdk.net
1176 
1177 JDKNET_INDEX_HTML = $(JDKNET_DOCDIR)/index.html
1178 JDKNET_OPTIONS_FILE = $(DOCSTMPDIR)/jdknet.options
1179 JDKNET_PACKAGES_FILE = $(DOCSTMPDIR)/jdknet.packages
1180 
1181 jdknetdocs: $(JDKNET_INDEX_HTML)
1182 
1183 # Set relative location to core api document root
1184 $(JDKNET_INDEX_HTML): GET2DOCSDIR=$(JDKNET2COREAPI)/..
1185 
1186 # Run javadoc if the index file is out of date or missing
1187 $(JDKNET_INDEX_HTML): $(JDKNET_OPTIONS_FILE) $(JDKNET_PACKAGES_FILE) coredocs
1188         $(prep-javadoc)
1189         $(call JavadocSummary,$(JDKNET_OPTIONS_FILE),$(JDKNET_PACKAGES_FILE))
1190         $(JAVADOC_CMD) -d $(@D) \
1191             @$(JDKNET_OPTIONS_FILE) @$(JDKNET_PACKAGES_FILE)
1192 
1193 # Create file with javadoc options in it
1194 $(JDKNET_OPTIONS_FILE):
1195         $(prep-target)
1196         @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1197           $(call OptionOnly,-Xdoclint:none) ; \
1198           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1199           $(call OptionPair,-encoding,ascii) ; \
1200           $(call OptionOnly,-nodeprecatedlist) ; \
1201           $(call OptionPair,-doctitle,$(JDKNET_DOCTITLE)) ; \
1202           $(call OptionPair,-windowtitle,$(JDKNET_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1203           $(call OptionPair,-header,$(JDKNET_HEADER)$(DRAFT_HEADER)); \
1204           $(call OptionPair,-bottom,$(JDKNET_BOTTOM)$(DRAFT_BOTTOM)); \
1205           $(call OptionTrip,-linkoffline,$(JDKNET2COREAPI),$(COREAPI_DOCSDIR)/); \
1206         ) >> $@
1207 
1208 # Create a file with the package names in it
1209 $(JDKNET_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JDKNET_PKGS))
1210         $(prep-target)
1211         $(call PackageFilter,$(JDKNET_PKGS))
1212 
1213 #############################################################
1214 #
1215 # Get a cache of all the directories
1216 
1217 $(DIRECTORY_CACHE): $(ALL_EXISTING_SOURCE_DIRS)
1218         $(prep-target)
1219         @for cp in $(ALL_EXISTING_SOURCE_DIRS) ; do \
1220           $(ECHO) "$(FIND) $${cp} -type f >> $@"; \
1221           $(FIND) $${cp} -type f >> $@; \
1222         done
1223 
1224 #############################################################
1225 #release version of core packages ########
1226 
1227 # The rel-coredocs and rel-docs targets were added by Eric Armstrong. rel-coredocs
1228 # assumes the kind of large, 32-bit machine used in the javapubs group's docs-release
1229 # process. It specifies memory settings accordingly to maximize performance.
1230 #
1231 # The performance settings, like the sanity check, are most important for the core
1232 # docs--the platform APIs. Running javadoc on those APIs takes a significant amount
1233 # of time and memory. Setting the initial heap size as large as possible is important