< prev index next >

make/Javadoc.gmk

Print this page


   1 # Copyright (c) 1997, 2013, 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


  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 NASHORNAPI_FIRST_COPYRIGHT_YEAR = 2014
  74 JNLP_FIRST_COPYRIGHT_YEAR = 1998
  75 PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007
  76 JDKNET_FIRST_COPYRIGHT_YEAR = 2014

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


1188             @$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE)
1189 
1190 # Create file with javadoc options in it
1191 $(SCTPAPI_OPTIONS_FILE):
1192         $(prep-target)
1193         @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1194           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1195           $(call OptionPair,-encoding,ascii) ; \
1196           $(call OptionOnly,-nodeprecatedlist) ; \
1197           $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \
1198           $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1199           $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \
1200           $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1201           $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1202         ) >> $@
1203 
1204 # Create a file with the package names in it
1205 $(SCTPAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SCTPAPI_PKGS))
1206         $(prep-target)
1207         $(call PackageFilter,$(SCTPAPI_PKGS))


















































1208 
1209 #############################################################
1210 #
1211 # jdk.net docs
1212 #
1213 
1214 ALL_OTHER_TARGETS += jdknetdocs
1215 
1216 JDKNET_DOCDIR := $(JRE_API_DOCSDIR)/net/socketoptions/spec
1217 JDKNET2COREAPI := ../../../$(JDKJRE2COREAPI)
1218 JDKNET_DOCTITLE := jdk.net API
1219 JDKNET_WINDOWTITLE := jdk.net API
1220 JDKNET_HEADER := <strong>jdk.net API</strong>
1221 JDKNET_BOTTOM := $(call CommonBottom,$(JDKNET_FIRST_COPYRIGHT_YEAR))
1222 JDKNET_PKGS := jdk.net
1223 
1224 JDKNET_INDEX_HTML = $(JDKNET_DOCDIR)/index.html
1225 JDKNET_OPTIONS_FILE = $(DOCSTMPDIR)/jdknet.options
1226 JDKNET_PACKAGES_FILE = $(DOCSTMPDIR)/jdknet.packages
1227 


   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


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


1189             @$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE)
1190 
1191 # Create file with javadoc options in it
1192 $(SCTPAPI_OPTIONS_FILE):
1193         $(prep-target)
1194         @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1195           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1196           $(call OptionPair,-encoding,ascii) ; \
1197           $(call OptionOnly,-nodeprecatedlist) ; \
1198           $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \
1199           $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1200           $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \
1201           $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1202           $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1203         ) >> $@
1204 
1205 # Create a file with the package names in it
1206 $(SCTPAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SCTPAPI_PKGS))
1207         $(prep-target)
1208         $(call PackageFilter,$(SCTPAPI_PKGS))
1209 
1210 #############################################################
1211 #
1212 # jaccessdocs - Java Accessibility Utilities
1213 #
1214 
1215 ALL_OTHER_TARGETS += jaccessdocs
1216 
1217 JACCESSAPI_DOCDIR := $(JRE_API_DOCSDIR)/accessibility/jaccess/spec
1218 JACCESSAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
1219 JACCESSAPI_DOCTITLE := JACCESS API
1220 JACCESSAPI_WINDOWTITLE := JACCESS API
1221 JACCESSAPI_HEADER := <strong>JACCESS API</strong>
1222 JACCESSAPI_BOTTOM := $(call CommonBottom,$(JACCESSAPI_FIRST_COPYRIGHT_YEAR))
1223 # JACCESSAPI_PKGS is located in NON_CORE_PKGS.gmk
1224 
1225 JACCESSAPI_INDEX_HTML = $(JACCESSAPI_DOCDIR)/index.html
1226 JACCESSAPI_OPTIONS_FILE = $(DOCSTMPDIR)/jaccess.options
1227 JACCESSAPI_PACKAGES_FILE = $(DOCSTMPDIR)/jaccess.packages
1228 
1229 jaccessdocs: $(JACCESSAPI_INDEX_HTML)
1230 
1231 # Set relative location to core api document root
1232 $(JACCESSAPI_INDEX_HTML): GET2DOCSDIR=$(JACCESSAPI2COREAPI)/..
1233 
1234 # Run javadoc if the index file is out of date or missing
1235 $(JACCESSAPI_INDEX_HTML): $(JACCESSAPI_OPTIONS_FILE) $(JACCESSAPI_PACKAGES_FILE) coredocs
1236         $(prep-javadoc)
1237         $(call JavadocSummary,$(JACCESSAPI_OPTIONS_FILE),$(JACCESSAPI_PACKAGES_FILE))
1238         $(JAVADOC_CMD) -d $(@D) \
1239             @$(JACCESSAPI_OPTIONS_FILE) @$(JACCESSAPI_PACKAGES_FILE)
1240 
1241 # Create file with javadoc options in it
1242 $(JACCESSAPI_OPTIONS_FILE):
1243         $(prep-target)
1244         @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1245           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1246           $(call OptionPair,-encoding,ascii) ; \
1247           $(call OptionOnly,-nodeprecatedlist) ; \
1248           $(call OptionPair,-doctitle,$(JACCESSAPI_DOCTITLE)) ; \
1249           $(call OptionPair,-windowtitle,$(JACCESSAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1250           $(call OptionPair,-header,$(JACCESSAPI_HEADER)$(DRAFT_HEADER)) ; \
1251           $(call OptionPair,-bottom,$(JACCESSAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1252           $(call OptionTrip,-linkoffline,$(JACCESSAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1253         ) >> $@
1254 
1255 # Create a file with the package names in it
1256 $(JACCESSAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JACCESSAPI_PKGS))
1257         $(prep-target)
1258         $(call PackageFilter,$(JACCESSAPI_PKGS))
1259 
1260 #############################################################
1261 #
1262 # jdk.net docs
1263 #
1264 
1265 ALL_OTHER_TARGETS += jdknetdocs
1266 
1267 JDKNET_DOCDIR := $(JRE_API_DOCSDIR)/net/socketoptions/spec
1268 JDKNET2COREAPI := ../../../$(JDKJRE2COREAPI)
1269 JDKNET_DOCTITLE := jdk.net API
1270 JDKNET_WINDOWTITLE := jdk.net API
1271 JDKNET_HEADER := <strong>jdk.net API</strong>
1272 JDKNET_BOTTOM := $(call CommonBottom,$(JDKNET_FIRST_COPYRIGHT_YEAR))
1273 JDKNET_PKGS := jdk.net
1274 
1275 JDKNET_INDEX_HTML = $(JDKNET_DOCDIR)/index.html
1276 JDKNET_OPTIONS_FILE = $(DOCSTMPDIR)/jdknet.options
1277 JDKNET_PACKAGES_FILE = $(DOCSTMPDIR)/jdknet.packages
1278 


< prev index next >