< prev index next >

make/Javadoc.gmk

Print this page


   1 # Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
   2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3 #
   4 # This code is free software; you can redistribute it and/or modify it
   5 # under the terms of the GNU General Public License version 2 only, as
   6 # published by the Free Software Foundation.  Oracle designates this
   7 # particular file as subject to the "Classpath" exception as provided
   8 # by Oracle in the LICENSE file that accompanied this code.
   9 #
  10 # This code is distributed in the hope that it will be useful, but WITHOUT
  11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12 # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13 # version 2 for more details (a copy is included in the LICENSE file that
  14 # accompanied this code).
  15 #
  16 # You should have received a copy of the GNU General Public License version
  17 # 2 along with this work; if not, write to the Free Software Foundation,
  18 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19 #
  20 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21 # or visit www.oracle.com if you need additional information or have any


  64 FIRST_COPYRIGHT_YEAR = 1993
  65 DOMAPI_FIRST_COPYRIGHT_YEAR = 2005
  66 MIRROR_FIRST_COPYRIGHT_YEAR = 2004
  67 DOCLETAPI_FIRST_COPYRIGHT_YEAR = 1993
  68 TAGLETAPI_FIRST_COPYRIGHT_YEAR = 1993
  69 JDI_FIRST_COPYRIGHT_YEAR = 1999
  70 JAAS_FIRST_COPYRIGHT_YEAR = 1998
  71 JGSS_FIRST_COPYRIGHT_YEAR = 2000
  72 SMARTCARDIO_FIRST_COPYRIGHT_YEAR = 2005
  73 HTTPSERVER_FIRST_COPYRIGHT_YEAR = 2005
  74 MGMT_FIRST_COPYRIGHT_YEAR = 2003
  75 ATTACH_FIRST_COPYRIGHT_YEAR = 2005
  76 JCONSOLE_FIRST_COPYRIGHT_YEAR = 2006
  77 SCTPAPI_FIRST_COPYRIGHT_YEAR = 2009
  78 TRACING_FIRST_COPYRIGHT_YEAR = 2008
  79 TREEAPI_FIRST_COPYRIGHT_YEAR = 2005
  80 NASHORNAPI_FIRST_COPYRIGHT_YEAR = 2014
  81 JNLP_FIRST_COPYRIGHT_YEAR = 1998
  82 PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007
  83 JDKNET_FIRST_COPYRIGHT_YEAR = 2014


  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:= ,
  99 EMPTY:=
 100 SPACE:=$(EMPTY) $(EMPTY)
 101 COPYRIGHT_SYMBOL = &\#x00a9;
 102 # Macro to construct the copyright line
 103 # (The GNU make 3.78.1 "if" conditional is broken, fixed in GNU make 3.81)


1213 # Create file with javadoc options in it
1214 $(SCTPAPI_OPTIONS_FILE):
1215         $(prep-target)
1216         @($(call COMMON_JAVADOCFLAGS) ; \
1217           $(call COMMON_JAVADOCTAGS) ; \
1218           $(call OptionOnly,-Xdoclint:none) ; \
1219           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1220           $(call OptionPair,-encoding,ascii) ; \
1221           $(call OptionOnly,-nodeprecatedlist) ; \
1222           $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \
1223           $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1224           $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \
1225           $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1226           $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1227         ) >> $@
1228 
1229 # Create a file with the package names in it
1230 $(SCTPAPI_PACKAGES_FILE): $(call PackageDependencies,$(SCTPAPI_PKGS))
1231         $(prep-target)
1232         $(call PackageFilter,$(SCTPAPI_PKGS))




















































1233 
1234 #############################################################
1235 #
1236 # jdk.net docs
1237 #
1238 
1239 ALL_OTHER_TARGETS += jdknetdocs
1240 
1241 JDKNET_DOCDIR := $(JRE_API_DOCSDIR)/net/socketoptions/spec
1242 JDKNET2COREAPI := ../../../$(JDKJRE2COREAPI)
1243 JDKNET_DOCTITLE := jdk.net API
1244 JDKNET_WINDOWTITLE := jdk.net API
1245 JDKNET_HEADER := <strong>jdk.net API</strong>
1246 JDKNET_BOTTOM := $(call CommonBottom,$(JDKNET_FIRST_COPYRIGHT_YEAR))
1247 JDKNET_PKGS := jdk.net
1248 
1249 JDKNET_INDEX_HTML = $(JDKNET_DOCDIR)/index.html
1250 JDKNET_OPTIONS_FILE = $(DOCSTMPDIR)/jdknet.options
1251 JDKNET_PACKAGES_FILE = $(DOCSTMPDIR)/jdknet.packages
1252 


   1 # Copyright (c) 1997, 2015, Oracle and/or its affiliates. All rights reserved.
   2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   3 #
   4 # This code is free software; you can redistribute it and/or modify it
   5 # under the terms of the GNU General Public License version 2 only, as
   6 # published by the Free Software Foundation.  Oracle designates this
   7 # particular file as subject to the "Classpath" exception as provided
   8 # by Oracle in the LICENSE file that accompanied this code.
   9 #
  10 # This code is distributed in the hope that it will be useful, but WITHOUT
  11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12 # FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  13 # version 2 for more details (a copy is included in the LICENSE file that
  14 # accompanied this code).
  15 #
  16 # You should have received a copy of the GNU General Public License version
  17 # 2 along with this work; if not, write to the Free Software Foundation,
  18 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  19 #
  20 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  21 # or visit www.oracle.com if you need additional information or have any


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


1215 # Create file with javadoc options in it
1216 $(SCTPAPI_OPTIONS_FILE):
1217         $(prep-target)
1218         @($(call COMMON_JAVADOCFLAGS) ; \
1219           $(call COMMON_JAVADOCTAGS) ; \
1220           $(call OptionOnly,-Xdoclint:none) ; \
1221           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1222           $(call OptionPair,-encoding,ascii) ; \
1223           $(call OptionOnly,-nodeprecatedlist) ; \
1224           $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \
1225           $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1226           $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \
1227           $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1228           $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1229         ) >> $@
1230 
1231 # Create a file with the package names in it
1232 $(SCTPAPI_PACKAGES_FILE): $(call PackageDependencies,$(SCTPAPI_PKGS))
1233         $(prep-target)
1234         $(call PackageFilter,$(SCTPAPI_PKGS))
1235 
1236 #############################################################
1237 #
1238 # jaccessdocs - Java Accessibility Utilities
1239 #
1240 
1241 ALL_OTHER_TARGETS += jaccessdocs
1242 
1243 JACCESSAPI_DOCDIR := $(JRE_API_DOCSDIR)/accessibility/jaccess/spec
1244 JACCESSAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
1245 JACCESSAPI_DOCTITLE := JACCESS API
1246 JACCESSAPI_WINDOWTITLE := JACCESS API
1247 JACCESSAPI_HEADER := <strong>JACCESS API</strong>
1248 JACCESSAPI_BOTTOM := $(call CommonBottom,$(JACCESSAPI_FIRST_COPYRIGHT_YEAR))
1249 # JACCESSAPI_PKGS is located in NON_CORE_PKGS.gmk
1250 
1251 JACCESSAPI_INDEX_HTML = $(JACCESSAPI_DOCDIR)/index.html
1252 JACCESSAPI_OPTIONS_FILE = $(DOCSTMPDIR)/jaccess.options
1253 JACCESSAPI_PACKAGES_FILE = $(DOCSTMPDIR)/jaccess.packages
1254 
1255 jaccessdocs: $(JACCESSAPI_INDEX_HTML)
1256 
1257 # Set relative location to core api document root
1258 $(JACCESSAPI_INDEX_HTML): GET2DOCSDIR=$(JACCESSAPI2COREAPI)/..
1259 
1260 # Run javadoc if the index file is out of date or missing
1261 $(JACCESSAPI_INDEX_HTML): $(JACCESSAPI_OPTIONS_FILE) $(JACCESSAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1262         $(prep-javadoc)
1263         $(call JavadocSummary,$(JACCESSAPI_OPTIONS_FILE),$(JACCESSAPI_PACKAGES_FILE))
1264         $(JAVADOC_CMD) -d $(@D) \
1265             @$(JACCESSAPI_OPTIONS_FILE) @$(JACCESSAPI_PACKAGES_FILE)
1266 
1267 # Create file with javadoc options in it
1268 $(JACCESSAPI_OPTIONS_FILE):
1269         $(prep-target)
1270         @($(call COMMON_JAVADOCFLAGS) ; \
1271           $(call COMMON_JAVADOCTAGS) ; \
1272           $(call OptionOnly,-Xdoclint:all) ; \
1273           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1274           $(call OptionPair,-encoding,ascii) ; \
1275           $(call OptionOnly,-nodeprecatedlist) ; \
1276           $(call OptionPair,-doctitle,$(JACCESSAPI_DOCTITLE)) ; \
1277           $(call OptionPair,-windowtitle,$(JACCESSAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1278           $(call OptionPair,-header,$(JACCESSAPI_HEADER)$(DRAFT_HEADER)) ; \
1279           $(call OptionPair,-bottom,$(JACCESSAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1280           $(call OptionTrip,-linkoffline,$(JACCESSAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1281         ) >> $@
1282 
1283 # Create a file with the package names in it
1284 $(JACCESSAPI_PACKAGES_FILE): $(call PackageDependencies,$(JACCESSAPI_PKGS))
1285         $(prep-target)
1286         $(call PackageFilter,$(JACCESSAPI_PKGS))
1287 
1288 #############################################################
1289 #
1290 # jdk.net docs
1291 #
1292 
1293 ALL_OTHER_TARGETS += jdknetdocs
1294 
1295 JDKNET_DOCDIR := $(JRE_API_DOCSDIR)/net/socketoptions/spec
1296 JDKNET2COREAPI := ../../../$(JDKJRE2COREAPI)
1297 JDKNET_DOCTITLE := jdk.net API
1298 JDKNET_WINDOWTITLE := jdk.net API
1299 JDKNET_HEADER := <strong>jdk.net API</strong>
1300 JDKNET_BOTTOM := $(call CommonBottom,$(JDKNET_FIRST_COPYRIGHT_YEAR))
1301 JDKNET_PKGS := jdk.net
1302 
1303 JDKNET_INDEX_HTML = $(JDKNET_DOCDIR)/index.html
1304 JDKNET_OPTIONS_FILE = $(DOCSTMPDIR)/jdknet.options
1305 JDKNET_PACKAGES_FILE = $(DOCSTMPDIR)/jdknet.packages
1306 


< prev index next >