< prev index next >

make/Javadoc.gmk

Print this page




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

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


1195 # Create file with javadoc options in it
1196 $(NASHORNAPI_OPTIONS_FILE):
1197         $(prep-target)
1198         @($(call COMMON_JAVADOCFLAGS) ; \
1199           $(call COMMON_JAVADOCTAGS) ; \
1200           $(call OptionOnly,-Xdoclint:all) ; \
1201           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1202           $(call OptionPair,-encoding,ascii) ; \
1203           $(call OptionPair,-doctitle,$(NASHORNAPI_DOCTITLE)) ; \
1204           $(call OptionPair,-windowtitle,$(NASHORNAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1205           $(call OptionPair,-header,$(NASHORNAPI_HEADER)$(DRAFT_HEADER)) ; \
1206           $(call OptionPair,-bottom,$(NASHORNAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1207           $(call OptionTrip,-group,$(NASHORNAPI_GROUPNAME),$(NASHORNAPI_REGEXP)); \
1208           $(call OptionTrip,-linkoffline,$(NASHORNAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1209         ) >> $@
1210 
1211 # Create a file with the package names in it
1212 $(NASHORNAPI_PACKAGES_FILE): $(call PackageDependencies,$(NASHORNAPI_PKGS))
1213         $(prep-target)
1214         $(call PackageFilter,$(NASHORNAPI_PKGS))






















































1215 
1216 #############################################################
1217 #
1218 # sctpdocs
1219 #
1220 
1221 ALL_OTHER_TARGETS += sctpdocs
1222 
1223 SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec
1224 SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
1225 SCTPAPI_DOCTITLE := SCTP API
1226 SCTPAPI_WINDOWTITLE := SCTP API
1227 SCTPAPI_HEADER := <strong>SCTP API</strong>
1228 SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR))
1229 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk
1230 
1231 SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html
1232 SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options
1233 SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages
1234 




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


1196 # Create file with javadoc options in it
1197 $(NASHORNAPI_OPTIONS_FILE):
1198         $(prep-target)
1199         @($(call COMMON_JAVADOCFLAGS) ; \
1200           $(call COMMON_JAVADOCTAGS) ; \
1201           $(call OptionOnly,-Xdoclint:all) ; \
1202           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1203           $(call OptionPair,-encoding,ascii) ; \
1204           $(call OptionPair,-doctitle,$(NASHORNAPI_DOCTITLE)) ; \
1205           $(call OptionPair,-windowtitle,$(NASHORNAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1206           $(call OptionPair,-header,$(NASHORNAPI_HEADER)$(DRAFT_HEADER)) ; \
1207           $(call OptionPair,-bottom,$(NASHORNAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1208           $(call OptionTrip,-group,$(NASHORNAPI_GROUPNAME),$(NASHORNAPI_REGEXP)); \
1209           $(call OptionTrip,-linkoffline,$(NASHORNAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1210         ) >> $@
1211 
1212 # Create a file with the package names in it
1213 $(NASHORNAPI_PACKAGES_FILE): $(call PackageDependencies,$(NASHORNAPI_PKGS))
1214         $(prep-target)
1215         $(call PackageFilter,$(NASHORNAPI_PKGS))
1216 
1217 #############################################################
1218 #
1219 # dynalinkapidocs
1220 #
1221 
1222 ALL_OTHER_TARGETS += dynalinkapidocs
1223 
1224 DYNALINKAPI_DOCDIR := $(JDK_API_DOCSDIR)/dynalink
1225 DYNALINKAPI2COREAPI := ../$(JDKJRE2COREAPI)
1226 DYNALINKAPI_DOCTITLE := Dynalink API
1227 DYNALINKAPI_WINDOWTITLE := Dynalink API
1228 DYNALINKAPI_HEADER := <strong>Dynalink API</strong>
1229 DYNALINKAPI_BOTTOM := $(call CommonBottom,$(DYNALINKAPI_FIRST_COPYRIGHT_YEAR))
1230 DYNALINKAPI_GROUPNAME := Packages
1231 DYNALINKAPI_REGEXP := jdk.dynalink.*
1232 # DYNALINKAPI_PKGS is located in NON_CORE_PKGS.gmk
1233 
1234 DYNALINKAPI_INDEX_HTML = $(DYNALINKAPI_DOCDIR)/index.html
1235 DYNALINKAPI_OPTIONS_FILE = $(DOCSTMPDIR)/dynalinkapi.options
1236 DYNALINKAPI_PACKAGES_FILE = $(DOCSTMPDIR)/dynalinkapi.packages
1237 
1238 dynalinkapidocs: $(DYNALINKAPI_INDEX_HTML)
1239 
1240 # Set relative location to core api document root
1241 $(DYNALINKAPI_INDEX_HTML): GET2DOCSDIR=$(DYNALINKAPI2COREAPI)/..
1242 
1243 # Run javadoc if the index file is out of date or missing
1244 $(DYNALINKAPI_INDEX_HTML): $(DYNALINKAPI_OPTIONS_FILE) $(DYNALINKAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1245         $(prep-javadoc)
1246         $(call JavadocSummary,$(DYNALINKAPI_OPTIONS_FILE),$(DYNALINKAPI_PACKAGES_FILE))
1247         $(JAVADOC_CMD_SMALL) -d $(@D) \
1248             @$(DYNALINKAPI_OPTIONS_FILE) @$(DYNALINKAPI_PACKAGES_FILE)
1249 
1250 # Create file with javadoc options in it
1251 $(DYNALINKAPI_OPTIONS_FILE):
1252         $(prep-target)
1253         @($(call COMMON_JAVADOCFLAGS) ; \
1254           $(call COMMON_JAVADOCTAGS) ; \
1255           $(call OptionOnly,-Xdoclint:all) ; \
1256           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1257           $(call OptionPair,-encoding,ascii) ; \
1258           $(call OptionPair,-doctitle,$(DYNALINKAPI_DOCTITLE)) ; \
1259           $(call OptionPair,-windowtitle,$(DYNALINKAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1260           $(call OptionPair,-header,$(DYNALINKAPI_HEADER)$(DRAFT_HEADER)) ; \
1261           $(call OptionPair,-bottom,$(DYNALINKAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1262           $(call OptionTrip,-group,$(DYNALINKAPI_GROUPNAME),$(DYNALINKAPI_REGEXP)); \
1263           $(call OptionTrip,-linkoffline,$(DYNALINKAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1264         ) >> $@
1265 
1266 # Create a file with the package names in it
1267 $(DYNALINKAPI_PACKAGES_FILE): $(call PackageDependencies,$(DYNALINKAPI_PKGS))
1268         $(prep-target)
1269         $(call PackageFilter,$(DYNALINKAPI_PKGS))
1270 
1271 #############################################################
1272 #
1273 # sctpdocs
1274 #
1275 
1276 ALL_OTHER_TARGETS += sctpdocs
1277 
1278 SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec
1279 SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
1280 SCTPAPI_DOCTITLE := SCTP API
1281 SCTPAPI_WINDOWTITLE := SCTP API
1282 SCTPAPI_HEADER := <strong>SCTP API</strong>
1283 SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR))
1284 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk
1285 
1286 SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html
1287 SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options
1288 SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages
1289 


< prev index next >