author | sundar |
Fri, 28 Nov 2014 18:31:05 +0530 | |
changeset 27596 | da40665398a4 |
parent 27595 | cff167b3bfa2 |
child 27602 | 236555ddac42 |
permissions | -rw-r--r-- |
27328 | 1 |
# Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved. |
13697 | 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 |
|
22 |
# questions. |
|
23 |
# |
|
24 |
||
25 |
include $(SPEC) |
|
26 |
include MakeBase.gmk |
|
27 |
||
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
28 |
################################################################# |
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
29 |
# |
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
30 |
# CORE_PKGS environment variable has been moved to the following file |
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
31 |
# |
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
32 |
include CORE_PKGS.gmk |
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
33 |
# |
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
34 |
# Load environment variables for API package names that are not part of |
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
35 |
# the Java SE platform |
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
36 |
# |
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
37 |
include NON_CORE_PKGS.gmk |
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
38 |
|
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
39 |
|
13697 | 40 |
.SUFFIXES: # Delete the default suffixes |
41 |
.SUFFIXES: .java |
|
42 |
||
43 |
# |
|
25854 | 44 |
# Definitions for directories |
13697 | 45 |
# |
46 |
||
25854 | 47 |
DOCSDIR := $(OUTPUT_ROOT)/docs |
48 |
TEMPDIR := $(OUTPUT_ROOT)/docstemp |
|
13697 | 49 |
|
50 |
HOTSPOT_DOCS_IMPORT_PATH=$(HOTSPOT_OUTPUTDIR)/docs |
|
51 |
||
52 |
BUILD_NUMBER=$(JDK_BUILD_NUMBER) |
|
53 |
||
15393
e3761cf4e010
8006872: Stop creating four jars with identical content in the new build system.
ohrstrom
parents:
15172
diff
changeset
|
54 |
JAVADOC_CMD = $(JAVA) \ |
20363 | 55 |
-Djava.awt.headless=true \ |
56 |
$(NEW_JAVADOC) \ |
|
57 |
-bootclasspath $(JDK_OUTPUTDIR)/classes |
|
13697 | 58 |
|
59 |
# Copyright year for beginning of Java and some of the apis |
|
20363 | 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 |
|
27596
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
77 |
NASHORNAPI_FIRST_COPYRIGHT_YEAR = 2014 |
20363 | 78 |
JNLP_FIRST_COPYRIGHT_YEAR = 1998 |
79 |
PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007 |
|
23836
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
80 |
JDKNET_FIRST_COPYRIGHT_YEAR = 2014 |
13697 | 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 = ™ |
|
90 |
||
91 |
# Common copyright lines used |
|
20363 | 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. |
|
13697 | 95 |
COMMA:= , |
96 |
EMPTY:= |
|
97 |
SPACE:=$(EMPTY) $(EMPTY) |
|
98 |
COPYRIGHT_SYMBOL = &\#x00a9; |
|
99 |
# Macro to construct the copyright line |
|
20363 | 100 |
# (The GNU make 3.78.1 "if" conditional is broken, fixed in GNU make 3.81) |
13697 | 101 |
define CopyrightLine # optionalurl optionalfirstyear optionaladdress |
102 |
$(if $(strip $1),<a href="$(strip $1)">Copyright</a>,Copyright) \ |
|
103 |
$(COPYRIGHT_SYMBOL) $(if $2,$2${COMMA},) $(COPYRIGHT_YEAR),\ |
|
104 |
$(FULL_COMPANY_NAME). $3 All rights reserved. |
|
105 |
endef |
|
106 |
||
107 |
# Url to root of documents |
|
108 |
DOCSDIR_URL = {@docroot}/$(GET2DOCSDIR) |
|
109 |
||
110 |
# Url to copyright html file |
|
24232
ddfae175a8d2
8042348: Copyright link in Javadoc page for Java SE 8
erikj
parents:
23986
diff
changeset
|
111 |
COPYRIGHT_URL = $(DOCSDIR_URL)/legal/cpyr.html |
13697 | 112 |
|
113 |
# Url to bug filing site |
|
25043
b5598c2ddf6f
8048302: Update bug reporting URL in make/Javadoc.gmk
darcy
parents:
24232
diff
changeset
|
114 |
BUG_SUBMIT_URL = http://bugreport.java.com/bugreport/ |
13697 | 115 |
|
116 |
# Common line for how to submit a bug or rfe |
|
117 |
BUG_SUBMIT_LINE = <a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a> |
|
118 |
||
119 |
# Url to devdocs page |
|
20363 | 120 |
# Was: http://java.sun.com/javase/6/webnotes/devdocs-vs-specs.html |
13697 | 121 |
DEV_DOCS_URL-7 = http://download.oracle.com/javase/7/docs/index.html |
20341
7a8b7863c491
8025741: Fix jdk/make/docs/Makefile to point to correct docs URL for JDK 8.
bpatel
parents:
17067
diff
changeset
|
122 |
DEV_DOCS_URL-8 = http://download.oracle.com/javase/8/docs/index.html |
13697 | 123 |
DEV_DOCS_URL = $(DEV_DOCS_URL-$(JDK_MINOR_VERSION)) |
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 |
|
20363 | 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) |
|
25854 | 139 |
ALL_SOURCE_DIRS := $(wildcard \ |
140 |
$(JDK_TOPDIR)/src/*/share/classes \ |
|
27586
e7cfdc266a70
8058631: Rename posix to unix in build system to match file name changes
ihse
parents:
27328
diff
changeset
|
141 |
$(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS)/classes \ |
e7cfdc266a70
8058631: Rename posix to unix in build system to match file name changes
ihse
parents:
27328
diff
changeset
|
142 |
$(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS_TYPE)/classes \ |
25854 | 143 |
$(LANGTOOLS_TOPDIR)/src/*/share/classes \ |
27596
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
144 |
$(NASHORN_TOPDIR)/src/*/share/classes \ |
25854 | 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 |
# |
|
13697 | 154 |
|
155 |
# List with classpath separator between them |
|
156 |
EMPTY:= |
|
157 |
SPACE:= $(EMPTY) $(EMPTY) |
|
158 |
RELEASEDOCS_SOURCEPATH = \ |
|
15052 | 159 |
$(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_SOURCE_DIRS))) |
13697 | 160 |
|
161 |
define prep-target |
|
20363 | 162 |
$(MKDIR) -p $(@D) |
163 |
$(RM) $@ |
|
13697 | 164 |
endef |
165 |
||
166 |
# Prep for javadoc creation, assumes $@ is an index.html file |
|
167 |
define prep-javadoc |
|
20363 | 168 |
@if [ -f "$@" -a "$?" != "" ] ; then \ |
169 |
$(ECHO) "# Dependencies have changed: $?"; \ |
|
170 |
fi |
|
171 |
$(RM) -r $(@D) |
|
172 |
$(MKDIR) -p $(@D) |
|
13697 | 173 |
endef |
174 |
||
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
175 |
$(eval $(call FillCacheFind, $(ALL_SOURCE_DIRS))) |
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
176 |
define PackageDependencies |
25854 | 177 |
$(call CacheFind, $(wildcard $(foreach p, $(subst .,/,$1), $(addsuffix /$p, $(ALL_SOURCE_DIRS))))) |
13697 | 178 |
endef |
179 |
||
180 |
# Given a list of packages, add packages that exist to $@, print summary |
|
181 |
define PackageFilter # packages |
|
20363 | 182 |
@if [ "$1" != "" ] ; then \ |
183 |
for p in $1 ; do \ |
|
184 |
pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \ |
|
185 |
found="false"; \ |
|
186 |
for cp in $(ALL_SOURCE_DIRS) ; do \ |
|
187 |
if [ -d $${cp}/$${pd} ] ; then \ |
|
188 |
$(ECHO) "$${p}" >> $@; \ |
|
189 |
found="true"; \ |
|
190 |
break; \ |
|
191 |
fi; \ |
|
192 |
done; \ |
|
193 |
if [ "$${found}" = "false" ] ; then \ |
|
194 |
$(ECHO) "WARNING: Package not found: $${p}"; \ |
|
195 |
fi; \ |
|
196 |
done; \ |
|
197 |
fi |
|
13697 | 198 |
endef |
199 |
||
200 |
# Print out a summary of the javadoc command about to be run |
|
201 |
define JavadocSummary # optionsfile packagesfile |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
202 |
@$(ECHO) "# Running javadoc for $(patsubst $(OUTPUT_ROOT)/%,%,$@)" $(LOG_WARN) |
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
203 |
@($(ECHO) "# Options (`$(BASENAME) $1`):"; $(SED) -e 's@^@# @' $1) $(LOG_DEBUG) |
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
204 |
@($(ECHO) "# Packages (`$(BASENAME) $2`):";$(SED) -e 's@^@# @' $2) $(LOG_DEBUG) |
13697 | 205 |
endef |
206 |
||
207 |
# |
|
208 |
# Temporary directory for javadoc creation |
|
209 |
# |
|
210 |
DOCSTMPDIR = $(TEMPDIR)/doctmp |
|
211 |
||
212 |
# |
|
213 |
# Different api directories created from root directory |
|
214 |
# |
|
20363 | 215 |
COREAPI_DOCSDIR = $(DOCSDIR)/api |
216 |
JDK_API_DOCSDIR = $(DOCSDIR)/jdk/api |
|
217 |
JRE_API_DOCSDIR = $(DOCSDIR)/jre/api |
|
218 |
PLATFORM_DOCSDIR = $(DOCSDIR)/platform |
|
13697 | 219 |
|
220 |
# The non-core api javadocs need to be able to access the root of the core |
|
20363 | 221 |
# api directory, so for jdk/api or jre/api to get to the core api/ |
222 |
# directory we would use this: |
|
223 |
JDKJRE2COREAPI = ../../api |
|
13697 | 224 |
|
225 |
# Common bottom argument |
|
226 |
define CommonBottom # year |
|
227 |
<font size="-1"><br> $(call CopyrightLine,,$1,)</font> |
|
228 |
endef |
|
229 |
||
230 |
# Common trademark bottom argument (Not sure why this is used sometimes) |
|
231 |
define CommonTrademarkBottom # year |
|
232 |
<font size="-1">\ |
|
233 |
$(BUG_SUBMIT_LINE)<br>$(JAVA_TRADEMARK_LINE)<br>\ |
|
234 |
$(call CopyrightLine,,$1,$(COMPANY_ADDRESS))\ |
|
235 |
</font> |
|
236 |
endef |
|
237 |
||
238 |
# Common echo of option |
|
239 |
define OptionOnly # opt |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
240 |
if [ "$1" != "" ] ; then \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
241 |
$(PRINTF) "%s\n" "$1"; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
242 |
fi |
13697 | 243 |
endef |
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
244 |
|
13697 | 245 |
define OptionPair # opt arg |
20363 | 246 |
$(PRINTF) "%s '%s'\n" "$1" '$2' |
13697 | 247 |
endef |
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
248 |
|
13697 | 249 |
define OptionTrip # opt arg arg |
20363 | 250 |
$(PRINTF) "%s '%s' '%s'\n" "$1" '$2' '$3' |
13697 | 251 |
endef |
252 |
||
253 |
# Core api bottom argument (with special sauce) |
|
254 |
COREAPI_BOTTOM = <font size="-1"> $(BUG_SUBMIT_LINE)\ |
|
255 |
<br>For further API reference and developer documentation, \ |
|
256 |
see <a href="$(DEV_DOCS_URL)" target="_blank">Java SE Documentation</a>. \ |
|
257 |
That documentation contains more detailed, developer-targeted descriptions, \ |
|
258 |
with conceptual overviews, definitions of terms, workarounds, \ |
|
259 |
and working code examples.<br>\ |
|
260 |
$(call CopyrightLine,$(COPYRIGHT_URL),$(FIRST_COPYRIGHT_YEAR),)\ |
|
261 |
</font> |
|
262 |
||
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
263 |
# Common javadoc options used by all bundles |
13697 | 264 |
|
265 |
ifdef OPENJDK |
|
20363 | 266 |
ADDITIONAL_JAVADOCFLAGS = \ |
267 |
-Xdocrootparent $(DOCS_BASE_URL) |
|
13697 | 268 |
else |
269 |
ADDITIONAL_JAVADOCFLAGS = |
|
270 |
endif |
|
271 |
||
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
272 |
define COMMON_JAVADOCFLAGS |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
273 |
$(call OptionOnly,-XDignore.symbol.file=true) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
274 |
$(call OptionOnly,-quiet) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
275 |
$(call OptionOnly,-use) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
276 |
$(call OptionOnly,-keywords) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
277 |
$(call OptionPair,-Xprofilespath,$(JDK_TOPDIR)/make/profile-rtjar-includes.txt) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
278 |
$(call OptionOnly,$(ADDITIONAL_JAVADOCFLAGS)) |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
279 |
endef |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
280 |
|
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
281 |
# Common javadoc tags used by all bundles |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
282 |
|
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
283 |
# Java language specification cite |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
284 |
TAG_JLS = jls:a:See <cite> \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
285 |
The Java™ Language Specification</cite>: |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
286 |
|
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
287 |
# Java virtual machine specification cite |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
288 |
TAG_JVMS = jvms:a:See <cite> \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
289 |
The Java™ Virtual Machine Specification</cite>: |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
290 |
|
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
291 |
# In order to get a specific ordering it's necessary to specify the total |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
292 |
# ordering of tags as the tags are otherwise ordered in order of definition. |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
293 |
define COMMON_JAVADOCTAGS |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
294 |
$(call OptionPair,-tag,beaninfo:X) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
295 |
$(call OptionPair,-tag,revised:X) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
296 |
$(call OptionPair,-tag,since.unbundled:X) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
297 |
$(call OptionPair,-tag,spec:X) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
298 |
$(call OptionPair,-tag,specdefault:X) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
299 |
$(call OptionPair,-tag,Note:X) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
300 |
$(call OptionPair,-tag,ToDo:X) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
301 |
$(call OptionPair,-tag,apiNote:a:API Note:) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
302 |
$(call OptionPair,-tag,implSpec:a:Implementation Requirements:) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
303 |
$(call OptionPair,-tag,implNote:a:Implementation Note:) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
304 |
$(call OptionPair,-tag,param) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
305 |
$(call OptionPair,-tag,return) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
306 |
$(call OptionPair,-tag,throws) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
307 |
$(call OptionPair,-tag,since) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
308 |
$(call OptionPair,-tag,version) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
309 |
$(call OptionPair,-tag,serialData) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
310 |
$(call OptionPair,-tag,factory) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
311 |
$(call OptionPair,-tag,see) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
312 |
$(call OptionPair,-tag,$(TAG_JVMS)) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
313 |
$(call OptionPair,-tag,$(TAG_JLS)) |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
314 |
endef |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
315 |
|
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
316 |
|
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
317 |
|
13697 | 318 |
# Draft used for non-fcs documents |
319 |
DRAFT_HEADER = |
|
320 |
ifneq ($(MILESTONE), fcs) |
|
20363 | 321 |
DRAFT_HEADER = <br><strong>DRAFT $(MILESTONE)-$(BUILD_NUMBER)</strong> |
322 |
DRAFT_BOTTOM = <br><strong>DRAFT $(MILESTONE)-$(BUILD_NUMBER)</strong> |
|
323 |
DRAFT_WINTITLE = $(BUILD_NUMBER) |
|
324 |
# Early access top text (not used in FCS releases) |
|
325 |
COREAPI_TOP_EARLYACCESS = \ |
|
13697 | 326 |
<div style="background-color: \#EEEEEE"> \ |
327 |
<div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; \ |
|
328 |
margin-left: 6px; margin-right: 6px; text-align: justify; \ |
|
329 |
font-size: 80%; font-family: Helvetica, Arial, sans-serif; \ |
|
330 |
font-weight: normal;"> \ |
|
331 |
Please note that the specifications and other information \ |
|
332 |
contained herein are not final and are subject to change. \ |
|
333 |
The information is being made available to you solely for purpose of \ |
|
334 |
evaluation. \ |
|
335 |
</div> </div> |
|
20363 | 336 |
|
13697 | 337 |
endif |
338 |
||
339 |
################################################################# |
|
340 |
||
341 |
# |
|
27328 | 342 |
# Load custom Javadoc rules |
343 |
# |
|
344 |
||
345 |
$(eval $(call IncludeCustomExtension, , Javadoc.gmk)) |
|
346 |
||
347 |
################################################################# |
|
348 |
||
349 |
# |
|
13697 | 350 |
# Default target is same as docs target, create core api and all others it can |
351 |
# |
|
352 |
||
353 |
all: docs |
|
354 |
docs: coredocs otherdocs |
|
355 |
||
356 |
################################################################# |
|
357 |
# Production Targets -- USE THESE TARGETS WHEN: |
|
20363 | 358 |
# a) You're generating docs outside of release engineering's |
359 |
# standard control build. |
|
360 |
# b) The docs will be pushed to the web and/or included in |
|
361 |
# the downloaded doc bundle. |
|
13697 | 362 |
# |
20363 | 363 |
# See: Notes.html#releaseTargets |
13697 | 364 |
# Note: Spaces precede ifdef/ifndef indents. Tabs precede target commands (!) |
365 |
# |
|
366 |
||
367 |
sanitycheckcoredocs: |
|
368 |
@$(ECHO) "" |
|
369 |
@$(ECHO) "Building core api docs with these values:" |
|
370 |
@$(ECHO) " BUILD_NUMBER = $(BUILD_NUMBER)" |
|
371 |
@$(ECHO) " MILESTONE = $(MILESTONE)" |
|
372 |
@$(ECHO) "" |
|
20363 | 373 |
ifeq ($(BUILD_NUMBER), b00) |
374 |
@$(ECHO) "ERROR: Build number must be defined" |
|
375 |
@$(ECHO) "MILESTONE is set to $(MILESTONE)" |
|
376 |
@$(ECHO) "" |
|
377 |
exit 1 |
|
378 |
endif |
|
13697 | 379 |
|
380 |
############################################################# |
|
381 |
# |
|
382 |
# coredocs |
|
383 |
# |
|
20363 | 384 |
COREAPI_DOCTITLE = Java$(TRADEMARK) Platform, Standard Edition \ |
13697 | 385 |
$(JDK_MINOR_VERSION)<br>API Specification |
20363 | 386 |
COREAPI_WINDOWTITLE = Java Platform SE $(JDK_MINOR_VERSION) |
13697 | 387 |
COREAPI_HEADER = \ |
388 |
<strong>Java$(TRADEMARK) Platform<br>Standard Ed. $(JDK_MINOR_VERSION)</strong> |
|
389 |
||
390 |
# Overview file for core apis |
|
25854 | 391 |
COREAPI_OVERVIEW = $(JDK_TOPDIR)/src/java.base/share/classes/overview-core.html |
13697 | 392 |
|
393 |
# The index.html, options, and packages files |
|
20363 | 394 |
COREAPI_INDEX_FILE = $(COREAPI_DOCSDIR)/index.html |
395 |
COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options |
|
13697 | 396 |
COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages |
397 |
||
398 |
coredocs: $(COREAPI_INDEX_FILE) |
|
399 |
||
400 |
# Set relative location to core api document root |
|
401 |
$(COREAPI_INDEX_FILE): GET2DOCSDIR=.. |
|
402 |
||
403 |
# Run javadoc if the index file is out of date or missing |
|
404 |
$(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE) |
|
405 |
$(prep-javadoc) |
|
406 |
$(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE)) |
|
407 |
$(JAVADOC_CMD) -d $(@D) \ |
|
20363 | 408 |
@$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE) |
13697 | 409 |
|
410 |
# Create file with javadoc options in it |
|
411 |
$(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW) |
|
412 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
413 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
414 |
$(call COMMON_JAVADOCTAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
415 |
$(call OptionOnly,-Xdoclint:none) ; \ |
20363 | 416 |
$(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ |
417 |
$(call OptionPair,-encoding,ISO-8859-1) ; \ |
|
418 |
$(call OptionOnly,-splitIndex) ; \ |
|
419 |
$(call OptionPair,-overview,$(COREAPI_OVERVIEW)) ; \ |
|
420 |
$(call OptionPair,-doctitle,$(COREAPI_DOCTITLE)) ; \ |
|
421 |
$(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ; \ |
|
422 |
$(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER)) ; \ |
|
423 |
$(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
424 |
) >> $@ |
|
425 |
ifdef COREAPI_TOP_EARLYACCESS |
|
426 |
@$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@ |
|
427 |
endif |
|
13697 | 428 |
|
429 |
# Create a file with the package names in it |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
430 |
$(COREAPI_PACKAGES_FILE): $(call PackageDependencies,$(CORE_PKGS)) |
13697 | 431 |
$(prep-target) |
432 |
$(call PackageFilter,$(CORE_PKGS)) |
|
433 |
||
434 |
############################################################# |
|
435 |
# |
|
436 |
# docletapidocs |
|
437 |
# |
|
438 |
||
439 |
ALL_OTHER_TARGETS += docletapidocs |
|
440 |
||
20363 | 441 |
DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet |
442 |
DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI) |
|
443 |
DOCLETAPI_DOCTITLE := Doclet API |
|
444 |
DOCLETAPI_WINDOWTITLE := Doclet API |
|
445 |
DOCLETAPI_HEADER := <strong>Doclet API</strong> |
|
446 |
DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR)) |
|
447 |
DOCLETAPI_GROUPNAME := Packages |
|
448 |
DOCLETAPI_REGEXP := com.sun.javadoc |
|
13697 | 449 |
# DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk |
450 |
||
451 |
# The index.html, options, and packages files |
|
20363 | 452 |
DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html |
453 |
DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options |
|
13697 | 454 |
DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages |
455 |
||
456 |
docletapidocs: $(DOCLETAPI_INDEX_FILE) |
|
457 |
||
458 |
# Set relative location to core api document root |
|
459 |
$(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/.. |
|
460 |
||
461 |
# Run javadoc if the index file is out of date or missing |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
462 |
$(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 463 |
$(prep-javadoc) |
464 |
$(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE)) |
|
465 |
$(JAVADOC_CMD) -d $(@D) \ |
|
20363 | 466 |
@$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE) |
13697 | 467 |
|
468 |
# Create file with javadoc options in it |
|
469 |
$(DOCLETAPI_OPTIONS_FILE): |
|
470 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
471 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
472 |
$(call COMMON_JAVADOCTAGS) ; \ |
25043
b5598c2ddf6f
8048302: Update bug reporting URL in make/Javadoc.gmk
darcy
parents:
24232
diff
changeset
|
473 |
$(call OptionOnly,-Xdoclint:all) ; \ |
20363 | 474 |
$(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ |
475 |
$(call OptionPair,-encoding,ascii) ; \ |
|
476 |
$(call OptionOnly,-breakiterator) ; \ |
|
477 |
$(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \ |
|
478 |
$(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
|
479 |
$(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \ |
|
480 |
$(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 481 |
$(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \ |
482 |
$(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
|
20363 | 483 |
) >> $@ |
13697 | 484 |
|
485 |
# Create a file with the package names in it |
|
27595
cff167b3bfa2
8065914: Various improvements and cleanup of build system
ihse
parents:
27586
diff
changeset
|
486 |
$(DOCLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(DOCLETAPI_PKGS)) |
13697 | 487 |
$(prep-target) |
488 |
$(call PackageFilter,$(DOCLETAPI_PKGS)) |
|
489 |
||
490 |
############################################################# |
|
491 |
# |
|
492 |
# tagletapidocs |
|
493 |
# |
|
494 |
||
495 |
ALL_OTHER_TARGETS += tagletapidocs |
|
20363 | 496 |
TAGLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/taglet |
497 |
TAGLETAPI2COREAPI := ../../$(JDKJRE2COREAPI) |
|
498 |
TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR)) |
|
13697 | 499 |
# TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk |
500 |
||
501 |
# Temporary directory (special generation rules) |
|
20363 | 502 |
TAGLETAPI_TEMPDIR = $(DOCSTMPDIR)/taglets_temp |
13697 | 503 |
|
504 |
# The index.html, options, and packages files |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
505 |
TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/com/sun/tools/doclets/Taglet.html |
20363 | 506 |
TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options |
13697 | 507 |
TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages |
508 |
||
509 |
tagletapidocs: $(TAGLETAPI_INDEX_FILE) |
|
510 |
||
511 |
# Set relative location to core api document root |
|
512 |
$(TAGLETAPI_INDEX_FILE): GET2DOCSDIR=$(TAGLETAPI2COREAPI)/.. |
|
513 |
||
514 |
# Run javadoc if the index file is out of date or missing |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
515 |
$(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 516 |
$(prep-javadoc) |
517 |
$(RM) -r $(TAGLETAPI_TEMPDIR) |
|
518 |
$(MKDIR) -p $(TAGLETAPI_TEMPDIR) |
|
519 |
$(call JavadocSummary,$(TAGLETAPI_OPTIONS_FILE),$(TAGLETAPI_PACKAGES_FILE)) |
|
520 |
$(JAVADOC_CMD) -d $(TAGLETAPI_TEMPDIR) \ |
|
20363 | 521 |
@$(TAGLETAPI_OPTIONS_FILE) @$(TAGLETAPI_PACKAGES_FILE) |
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
522 |
cp -r $(TAGLETAPI_TEMPDIR)/com $(TAGLETAPI_DOCDIR) |
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
523 |
cp $(TAGLETAPI_TEMPDIR)/stylesheet.css $(TAGLETAPI_DOCDIR) |
13697 | 524 |
$(RM) -r $(TAGLETAPI_TEMPDIR) |
525 |
||
526 |
# Create file with javadoc options in it |
|
527 |
$(TAGLETAPI_OPTIONS_FILE): |
|
528 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
529 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
530 |
$(call COMMON_JAVADOCTAGS) ; \ |
25043
b5598c2ddf6f
8048302: Update bug reporting URL in make/Javadoc.gmk
darcy
parents:
24232
diff
changeset
|
531 |
$(call OptionOnly,-Xdoclint:all) ; \ |
20363 | 532 |
$(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ |
533 |
$(call OptionPair,-encoding,ascii) ; \ |
|
534 |
$(call OptionOnly,-nonavbar) ; \ |
|
535 |
$(call OptionOnly,-noindex) ; \ |
|
536 |
$(call OptionPair,-bottom,$(TAGLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 537 |
$(call OptionTrip,-linkoffline,$(TAGLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
20363 | 538 |
) >> $@ |
13697 | 539 |
|
540 |
# Create a file with the package names in it |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
541 |
$(TAGLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(TAGLETAPI_PKGS)) |
13697 | 542 |
$(prep-target) |
25854 | 543 |
@($(ECHO) "$(LANGTOOLS_TOPDIR)/src/jdk.javadoc/share/classes/$(TAGLETAPI_FILE)" ) > $@ |
13697 | 544 |
|
545 |
############################################################# |
|
546 |
# |
|
547 |
# domapidocs |
|
548 |
# |
|
549 |
||
550 |
ALL_OTHER_TARGETS += domapidocs |
|
551 |
||
20363 | 552 |
DOMAPI_DOCDIR := $(JRE_API_DOCSDIR)/plugin/dom |
553 |
DOMAPI2COREAPI := ../../$(JDKJRE2COREAPI) |
|
554 |
DOMAPI_DOCTITLE := Common DOM API |
|
555 |
DOMAPI_WINDOWTITLE := Common DOM API |
|
556 |
DOMAPI_HEADER := <strong>Common DOM API</strong> |
|
557 |
DOMAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOMAPI_FIRST_COPYRIGHT_YEAR)) |
|
558 |
DOMAPI_GROUPNAME := Packages |
|
25045
7b8a6a85baa4
8044063: Remove com.sun.java.browser.* from jdk repo
mchung
parents:
24232
diff
changeset
|
559 |
DOMAPI_REGEXP := org.w3c.dom* |
13697 | 560 |
# DOMAPI_PKGS is located in NON_CORE_PKGS.gmk |
561 |
||
562 |
# The index.html, options, and packages files |
|
20363 | 563 |
DOMAPI_INDEX_FILE = $(DOMAPI_DOCDIR)/index.html |
564 |
DOMAPI_OPTIONS_FILE = $(DOCSTMPDIR)/domapi.options |
|
13697 | 565 |
DOMAPI_PACKAGES_FILE = $(DOCSTMPDIR)/domapi.packages |
566 |
||
567 |
domapidocs: $(DOMAPI_INDEX_FILE) |
|
568 |
||
569 |
# Set relative location to core api document root |
|
570 |
$(DOMAPI_INDEX_FILE): GET2DOCSDIR=$(DOMAPI2COREAPI)/.. |
|
571 |
||
572 |
# Run javadoc if the index file is out of date or missing |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
573 |
$(DOMAPI_INDEX_FILE): $(DOMAPI_OPTIONS_FILE) $(DOMAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 574 |
$(prep-javadoc) |
575 |
$(call JavadocSummary,$(DOMAPI_OPTIONS_FILE),$(DOMAPI_PACKAGES_FILE)) |
|
576 |
$(JAVADOC_CMD) -d $(@D) \ |
|
20363 | 577 |
@$(DOMAPI_OPTIONS_FILE) @$(DOMAPI_PACKAGES_FILE) |
13697 | 578 |
|
579 |
# Create file with javadoc options in it |
|
580 |
$(DOMAPI_OPTIONS_FILE): |
|
581 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
582 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
583 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
584 |
$(call OptionOnly,-Xdoclint:none) ; \ |
20363 | 585 |
$(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ |
586 |
$(call OptionPair,-encoding,ascii) ; \ |
|
587 |
$(call OptionOnly,-splitIndex) ; \ |
|
588 |
$(call OptionPair,-doctitle,$(DOMAPI_DOCTITLE)) ; \ |
|
589 |
$(call OptionPair,-windowtitle,$(DOMAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
|
590 |
$(call OptionPair,-header,$(DOMAPI_HEADER)$(DRAFT_HEADER)) ; \ |
|
591 |
$(call OptionPair,-bottom,$(DOMAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 592 |
$(call OptionTrip,-group,$(DOMAPI_GROUPNAME),$(DOMAPI_REGEXP)); \ |
593 |
$(call OptionTrip,-linkoffline,$(DOMAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
|
20363 | 594 |
) >> $@ |
13697 | 595 |
|
596 |
# Create a file with the package names in it |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
597 |
$(DOMAPI_PACKAGES_FILE): $(call PackageDependencies,$(DOMAPI_PKGS)) |
13697 | 598 |
$(prep-target) |
599 |
$(call PackageFilter,$(DOMAPI_PKGS)) |
|
600 |
||
601 |
############################################################# |
|
602 |
# |
|
603 |
# jpdadocs |
|
604 |
# |
|
605 |
||
606 |
ALL_OTHER_TARGETS += jpdadocs |
|
607 |
||
608 |
jpdadocs: jdidocs jdwpdocs jvmtidocs |
|
609 |
||
610 |
############################################################# |
|
611 |
# |
|
612 |
# jdidocs |
|
613 |
# |
|
614 |
||
615 |
ALL_OTHER_TARGETS += jdidocs |
|
616 |
||
20363 | 617 |
JDI_DOCDIR := $(JDK_API_DOCSDIR)/jpda/jdi |
618 |
JDI2COREAPI := ../../$(JDKJRE2COREAPI) |
|
619 |
JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface |
|
13697 | 620 |
JDI_WINDOWTITLE := Java Debug Interface |
20363 | 621 |
JDI_HEADER := <strong>Java Debug Interface</strong> |
622 |
JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR)) |
|
25854 | 623 |
JDI_OVERVIEW := $(JDK_TOPDIR)/src/jdk.jdi/share/classes/jdi-overview.html |
13697 | 624 |
# JDI_PKGS is located in NON_CORE_PKGS.gmk |
625 |
||
626 |
# The index.html, options, and packages files |
|
20363 | 627 |
JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html |
628 |
JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options |
|
13697 | 629 |
JDI_PACKAGES_FILE = $(DOCSTMPDIR)/jdi.packages |
630 |
||
631 |
jdidocs: $(JDI_INDEX_FILE) |
|
632 |
||
633 |
# Set relative location to core api document root |
|
634 |
$(JDI_INDEX_FILE): GET2DOCSDIR=$(JDI2COREAPI)/.. |
|
635 |
||
636 |
# Run javadoc if the index file is out of date or missing |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
637 |
$(JDI_INDEX_FILE): $(JDI_OPTIONS_FILE) $(JDI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 638 |
$(prep-javadoc) |
639 |
$(call JavadocSummary,$(JDI_OPTIONS_FILE),$(JDI_PACKAGES_FILE)) |
|
640 |
$(JAVADOC_CMD) -d $(@D) \ |
|
20363 | 641 |
@$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE) |
13697 | 642 |
|
643 |
# Create file with javadoc options in it |
|
644 |
$(JDI_OPTIONS_FILE): $(JDI_OVERVIEW) |
|
645 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
646 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
647 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
648 |
$(call OptionOnly,-Xdoclint:none) ; \ |
20363 | 649 |
$(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ |
650 |
$(call OptionPair,-encoding,ascii) ; \ |
|
651 |
$(call OptionPair,-overview,$(JDI_OVERVIEW)) ; \ |
|
652 |
$(call OptionPair,-doctitle,$(JDI_DOCTITLE)) ; \ |
|
13697 | 653 |
$(call OptionPair,-windowtitle,$(JDI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
20363 | 654 |
$(call OptionPair,-header,$(JDI_HEADER)$(DRAFT_HEADER)) ; \ |
655 |
$(call OptionPair,-bottom,$(JDI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 656 |
$(call OptionTrip,-linkoffline,$(JDI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
20363 | 657 |
) >> $@ |
13697 | 658 |
|
659 |
# Create a file with the package names in it |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
660 |
$(JDI_PACKAGES_FILE): $(call PackageDependencies,$(JDI_PKGS)) |
13697 | 661 |
$(prep-target) |
662 |
$(call PackageFilter,$(JDI_PKGS)) |
|
663 |
||
664 |
############################################################# |
|
665 |
# |
|
666 |
# jdwpdocs |
|
667 |
# |
|
668 |
||
669 |
ALL_OTHER_TARGETS += jdwpdocs |
|
670 |
||
20363 | 671 |
JDWP_DOCDIR = $(PLATFORM_DOCSDIR)/jpda/jdwp |
13697 | 672 |
|
673 |
jdwpdocs: $(JDWP_DOCDIR)/jdwp-protocol.html |
|
674 |
$(JDWP_DOCDIR)/jdwp-protocol.html : $(JDK_OUTPUTDIR)/gensrc_jdwp_doc/jdwp-protocol.html |
|
675 |
$(MKDIR) -p $(@D) |
|
676 |
$(RM) $@ |
|
677 |
$(CP) $< $@ |
|
678 |
||
679 |
############################################################# |
|
680 |
# |
|
681 |
# jvmtidocs |
|
682 |
# |
|
683 |
||
684 |
ALL_OTHER_TARGETS += jvmtidocs |
|
685 |
||
20363 | 686 |
JVMTI_DOCDIR = $(PLATFORM_DOCSDIR)/jvmti |
687 |
JVMTI_HTML = $(HOTSPOT_DIST)/docs/platform/jvmti/jvmti.html |
|
13697 | 688 |
|
20363 | 689 |
jvmtidocs: $(JVMTI_DOCDIR)/jvmti.html |
13697 | 690 |
$(JVMTI_DOCDIR)/jvmti.html: |
691 |
@$(prep-javadoc) |
|
20363 | 692 |
@if [ -f $(JVMTI_HTML) ] ; then \ |
693 |
$(CP) $(JVMTI_HTML) $@; \ |
|
694 |
else \ |
|
13697 | 695 |
$(ECHO) "WARNING: Generated file does not exist: $(JVMTI_HTML)"; \ |
696 |
fi |
|
697 |
||
698 |
############################################################# |
|
699 |
# |
|
700 |
# jaasdocs |
|
701 |
# |
|
702 |
||
703 |
ALL_OTHER_TARGETS += jaasdocs |
|
704 |
||
20363 | 705 |
JAAS_DOCDIR := $(JRE_API_DOCSDIR)/security/jaas/spec |
706 |
JAAS2COREAPI := ../../../$(JDKJRE2COREAPI) |
|
707 |
JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service |
|
13697 | 708 |
JAAS_WINDOWTITLE := Java Authentication and Authorization Service |
20363 | 709 |
JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong> |
710 |
JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR)) |
|
13697 | 711 |
# JAAS_PKGS is located in NON_CORE_PKGS.gmk |
25854 | 712 |
JAAS_OVERVIEW := $(JDK_TOPDIR)/src/jdk.security.auth/share/classes/jaas-overview.html |
13697 | 713 |
|
714 |
# The index.html, options, and packages files |
|
20363 | 715 |
JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html |
716 |
JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options |
|
13697 | 717 |
JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages |
718 |
||
719 |
jaasdocs: $(JAAS_INDEX_FILE) |
|
720 |
||
721 |
# Set relative location to core api document root |
|
722 |
$(JAAS_INDEX_FILE): GET2DOCSDIR=$(JAAS2COREAPI)/.. |
|
723 |
||
724 |
# Run javadoc if the index file is out of date or missing |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
725 |
$(JAAS_INDEX_FILE): $(JAAS_OPTIONS_FILE) $(JAAS_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 726 |
$(prep-javadoc) |
727 |
$(call JavadocSummary,$(JAAS_OPTIONS_FILE),$(JAAS_PACKAGES_FILE)) |
|
728 |
$(JAVADOC_CMD) -d $(@D) \ |
|
20363 | 729 |
@$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE) |
13697 | 730 |
|
731 |
# Create file with javadoc options in it |
|
732 |
$(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW) |
|
733 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
734 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
735 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
736 |
$(call OptionOnly,-Xdoclint:none) ; \ |
20363 | 737 |
$(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ |
738 |
$(call OptionPair,-encoding,ascii) ; \ |
|
739 |
$(call OptionPair,-overview,$(JAAS_OVERVIEW)) ; \ |
|
740 |
$(call OptionPair,-doctitle,$(JAAS_DOCTITLE)) ; \ |
|
13697 | 741 |
$(call OptionPair,-windowtitle,$(JAAS_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
20363 | 742 |
$(call OptionPair,-header,$(JAAS_HEADER)$(DRAFT_HEADER)) ; \ |
743 |
$(call OptionPair,-bottom,$(JAAS_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 744 |
$(call OptionTrip,-linkoffline,$(JAAS2COREAPI),$(COREAPI_DOCSDIR)/); \ |
20363 | 745 |
) >> $@ |
13697 | 746 |
|
747 |
# Create a file with the package names in it |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
748 |
$(JAAS_PACKAGES_FILE): $(call PackageDependencies,$(JAAS_PKGS)) |
13697 | 749 |
$(prep-target) |
750 |
$(call PackageFilter,$(JAAS_PKGS)) |
|
751 |
||
752 |
############################################################# |
|
753 |
# |
|
754 |
# jgssdocs |
|
755 |
# |
|
756 |
||
757 |
ALL_OTHER_TARGETS += jgssdocs |
|
758 |
||
20363 | 759 |
JGSS_DOCDIR := $(JRE_API_DOCSDIR)/security/jgss/spec |
760 |
JGSS2COREAPI := ../../../$(JDKJRE2COREAPI) |
|
761 |
JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities |
|
13697 | 762 |
JGSS_WINDOWTITLE := Java GSS-API Utilities |
20363 | 763 |
JGSS_HEADER := <strong>Java GSS-API Utilities</strong> |
764 |
JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR)) |
|
25854 | 765 |
JGSS_OVERVIEW := $(JDK_TOPDIR)/src/java.security.jgss/share/classes/jgss-overview.html |
13697 | 766 |
# JGSS_PKGS is located in NON_CORE_PKGS.gmk |
767 |
||
768 |
# The index.html, options, and packages files |
|
20363 | 769 |
JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html |
770 |
JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options |
|
13697 | 771 |
JGSS_PACKAGES_FILE = $(DOCSTMPDIR)/jgss.packages |
772 |
||
773 |
jgssdocs: $(JGSS_INDEX_FILE) |
|
774 |
||
775 |
# Set relative location to core api document root |
|
776 |
$(JGSS_INDEX_FILE): GET2DOCSDIR=$(JGSS2COREAPI)/.. |
|
777 |
||
778 |
# Run javadoc if the index file is out of date or missing |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
779 |
$(JGSS_INDEX_FILE): $(JGSS_OPTIONS_FILE) $(JGSS_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 780 |
$(prep-javadoc) |
781 |
$(call JavadocSummary,$(JGSS_OPTIONS_FILE),$(JGSS_PACKAGES_FILE)) |
|
782 |
$(JAVADOC_CMD) -d $(@D) \ |
|
20363 | 783 |
@$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE) |
13697 | 784 |
|
785 |
# Create file with javadoc options in it |
|
786 |
$(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW) |
|
787 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
788 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
789 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
790 |
$(call OptionOnly,-Xdoclint:none) ; \ |
20363 | 791 |
$(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ |
792 |
$(call OptionPair,-encoding,ascii) ; \ |
|
793 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
|
794 |
$(call OptionPair,-overview,$(JGSS_OVERVIEW)) ; \ |
|
795 |
$(call OptionPair,-doctitle,$(JGSS_DOCTITLE)) ; \ |
|
13697 | 796 |
$(call OptionPair,-windowtitle,$(JGSS_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
20363 | 797 |
$(call OptionPair,-header,$(JGSS_HEADER)$(DRAFT_HEADER)) ; \ |
798 |
$(call OptionPair,-bottom,$(JGSS_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 799 |
$(call OptionTrip,-linkoffline,$(JGSS2COREAPI),$(COREAPI_DOCSDIR)/); \ |
20363 | 800 |
) >> $@ |
13697 | 801 |
|
802 |
# Create a file with the package names in it |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
803 |
$(JGSS_PACKAGES_FILE): $(call PackageDependencies,$(JGSS_PKGS)) |
13697 | 804 |
$(prep-target) |
805 |
$(call PackageFilter,$(JGSS_PKGS)) |
|
806 |
||
807 |
############################################################# |
|
808 |
# |
|
809 |
# smartcardiodocs |
|
810 |
# |
|
811 |
||
812 |
ALL_OTHER_TARGETS += smartcardiodocs |
|
813 |
||
20363 | 814 |
SMARTCARDIO_DOCDIR := $(JRE_API_DOCSDIR)/security/smartcardio/spec |
815 |
SMARTCARDIO2COREAPI := ../../../$(JDKJRE2COREAPI) |
|
816 |
SMARTCARDIO_DOCTITLE := Java$(TRADEMARK) Smart Card I/O |
|
13697 | 817 |
SMARTCARDIO_WINDOWTITLE := Java Smart Card I/O |
20363 | 818 |
SMARTCARDIO_HEADER := <strong>Java Smart Card I/O</strong> |
819 |
SMARTCARDIO_BOTTOM := $(call CommonBottom,$(SMARTCARDIO_FIRST_COPYRIGHT_YEAR)) |
|
13697 | 820 |
# SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk |
821 |
||
822 |
# The index.html, options, and packages files |
|
20363 | 823 |
SMARTCARDIO_INDEX_FILE = $(SMARTCARDIO_DOCDIR)/index.html |
824 |
SMARTCARDIO_OPTIONS_FILE = $(DOCSTMPDIR)/smartcardio.options |
|
13697 | 825 |
SMARTCARDIO_PACKAGES_FILE = $(DOCSTMPDIR)/smartcardio.packages |
826 |
||
827 |
smartcardiodocs: $(SMARTCARDIO_INDEX_FILE) |
|
828 |
||
829 |
# Set relative location to core api document root |
|
830 |
$(SMARTCARDIO_INDEX_FILE): GET2DOCSDIR=$(SMARTCARDIO2COREAPI)/.. |
|
831 |
||
832 |
# Run javadoc if the index file is out of date or missing |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
833 |
$(SMARTCARDIO_INDEX_FILE): $(SMARTCARDIO_OPTIONS_FILE) $(SMARTCARDIO_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 834 |
$(prep-javadoc) |
835 |
$(call JavadocSummary,$(SMARTCARDIO_OPTIONS_FILE),$(SMARTCARDIO_PACKAGES_FILE)) |
|
836 |
$(JAVADOC_CMD) -d $(@D) \ |
|
20363 | 837 |
@$(SMARTCARDIO_OPTIONS_FILE) @$(SMARTCARDIO_PACKAGES_FILE) |
13697 | 838 |
|
839 |
# Create file with javadoc options in it |
|
840 |
$(SMARTCARDIO_OPTIONS_FILE): |
|
841 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
842 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
843 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
844 |
$(call OptionOnly,-Xdoclint:none) ; \ |
20363 | 845 |
$(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ |
846 |
$(call OptionPair,-encoding,ascii) ; \ |
|
847 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
|
848 |
$(call OptionPair,-doctitle,$(SMARTCARDIO_DOCTITLE)) ; \ |
|
849 |
$(call OptionPair,-windowtitle,$(SMARTCARDIO_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
|
13697 | 850 |
$(call OptionPair,-header,$(SMARTCARDIO_HEADER)$(DRAFT_HEADER)); \ |
851 |
$(call OptionPair,-bottom,$(SMARTCARDIO_BOTTOM)$(DRAFT_BOTTOM)); \ |
|
852 |
$(call OptionTrip,-linkoffline,$(SMARTCARDIO2COREAPI),$(COREAPI_DOCSDIR)/); \ |
|
20363 | 853 |
) >> $@ |
13697 | 854 |
|
855 |
# Create a file with the package names in it |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
856 |
$(SMARTCARDIO_PACKAGES_FILE): $(call PackageDependencies,$(SMARTCARDIO_PKGS)) |
13697 | 857 |
$(prep-target) |
858 |
$(call PackageFilter,$(SMARTCARDIO_PKGS)) |
|
859 |
||
860 |
############################################################# |
|
861 |
# |
|
862 |
# httpserverdocs |
|
863 |
# |
|
864 |
||
865 |
ALL_OTHER_TARGETS += httpserverdocs |
|
866 |
||
20363 | 867 |
HTTPSERVER_DOCDIR := $(JRE_API_DOCSDIR)/net/httpserver/spec |
868 |
HTTPSERVER2COREAPI := ../../../$(JDKJRE2COREAPI) |
|
869 |
HTTPSERVER_DOCTITLE := Java$(TRADEMARK) HTTP Server |
|
13697 | 870 |
HTTPSERVER_WINDOWTITLE := Java HTTP Server |
20363 | 871 |
HTTPSERVER_HEADER := <strong>Java HTTP Server</strong> |
872 |
HTTPSERVER_BOTTOM := $(call CommonBottom,$(HTTPSERVER_FIRST_COPYRIGHT_YEAR)) |
|
13697 | 873 |
# HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk |
874 |
||
20363 | 875 |
HTTPSERVER_INDEX_HTML = $(HTTPSERVER_DOCDIR)/index.html |
876 |
HTTPSERVER_OPTIONS_FILE = $(DOCSTMPDIR)/httpserver.options |
|
13697 | 877 |
HTTPSERVER_PACKAGES_FILE = $(DOCSTMPDIR)/httpserver.packages |
878 |
||
879 |
httpserverdocs: $(HTTPSERVER_INDEX_HTML) |
|
880 |
||
881 |
# Set relative location to core api document root |
|
882 |
$(HTTPSERVER_INDEX_HTML): GET2DOCSDIR=$(HTTPSERVER2COREAPI)/.. |
|
883 |
||
884 |
# Run javadoc if the index file is out of date or missing |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
885 |
$(HTTPSERVER_INDEX_HTML): $(HTTPSERVER_OPTIONS_FILE) $(HTTPSERVER_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 886 |
$(prep-javadoc) |
887 |
$(call JavadocSummary,$(HTTPSERVER_OPTIONS_FILE),$(HTTPSERVER_PACKAGES_FILE)) |
|
888 |
$(JAVADOC_CMD) -d $(@D) \ |
|
20363 | 889 |
@$(HTTPSERVER_OPTIONS_FILE) @$(HTTPSERVER_PACKAGES_FILE) |
13697 | 890 |
|
891 |
# Create file with javadoc options in it |
|
892 |
$(HTTPSERVER_OPTIONS_FILE): |
|
893 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
894 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
895 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
896 |
$(call OptionOnly,-Xdoclint:none) ; \ |
20363 | 897 |
$(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ |
898 |
$(call OptionPair,-encoding,ascii) ; \ |
|
899 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
|
900 |
$(call OptionPair,-doctitle,$(HTTPSERVER_DOCTITLE)) ; \ |
|
901 |
$(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
|
13697 | 902 |
$(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \ |
903 |
$(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \ |
|
904 |
$(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \ |
|
20363 | 905 |
) >> $@ |
13697 | 906 |
|
907 |
# Create a file with the package names in it |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
908 |
$(HTTPSERVER_PACKAGES_FILE): $(call PackageDependencies,$(HTTPSERVER_PKGS)) |
13697 | 909 |
$(prep-target) |
910 |
$(call PackageFilter,$(HTTPSERVER_PKGS)) |
|
911 |
||
912 |
############################################################# |
|
913 |
# |
|
914 |
# mgmtdocs |
|
915 |
# |
|
916 |
||
917 |
ALL_OTHER_TARGETS += mgmtdocs |
|
918 |
||
20363 | 919 |
MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension |
920 |
MGMT2COREAPI := ../../$(JDKJRE2COREAPI) |
|
921 |
JVM_MIB_NAME := JVM-MANAGEMENT-MIB.mib |
|
25854 | 922 |
JVM_MIB_SRC := $(JDK_TOPDIR)/src/closed/jdk.snmp/share/classes/sun/management/snmp/$(JVM_MIB_NAME) |
20363 | 923 |
MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform |
13697 | 924 |
MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform |
20363 | 925 |
MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong> |
926 |
MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR)) |
|
25854 | 927 |
MGMT_OVERVIEW := $(JDK_TOPDIR)/src/java.management/share/classes/mgmt-overview.html |
13697 | 928 |
# MGMT_PKGS is located in NON_CORE_PKGS.gmk |
929 |
||
930 |
# The index.html, options, and packages files |
|
20363 | 931 |
MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html |
932 |
MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options |
|
13697 | 933 |
MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages |
934 |
||
935 |
mgmtdocs: $(MGMT_INDEX_FILE) |
|
936 |
||
937 |
# Set relative location to core api document root |
|
938 |
$(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/.. |
|
939 |
||
940 |
# Run javadoc if the index file is out of date or missing |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
941 |
$(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 942 |
$(prep-javadoc) |
20363 | 943 |
@if [ -f $(JVM_MIB_SRC) ] ; then \ |
944 |
$(CP) $(JVM_MIB_SRC) $(@D)/.. ; \ |
|
945 |
else \ |
|
946 |
$(ECHO) "WARNING: File $(JVM_MIB_NAME) not available."; \ |
|
13697 | 947 |
fi |
948 |
$(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE)) |
|
949 |
$(JAVADOC_CMD) -d $(@D) \ |
|
20363 | 950 |
@$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE) |
13697 | 951 |
|
952 |
# Create file with javadoc options in it |
|
953 |
$(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW) |
|
954 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
955 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
956 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
957 |
$(call OptionOnly,-Xdoclint:none) ; \ |
20363 | 958 |
$(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ |
959 |
$(call OptionPair,-encoding,ascii) ; \ |
|
960 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
|
961 |
$(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \ |
|
962 |
$(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \ |
|
13697 | 963 |
$(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
20363 | 964 |
$(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \ |
965 |
$(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 966 |
$(call OptionTrip,-linkoffline,$(MGMT2COREAPI),$(COREAPI_DOCSDIR)/); \ |
20363 | 967 |
) >> $@ |
13697 | 968 |
|
969 |
# Create a file with the package names in it |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
970 |
$(MGMT_PACKAGES_FILE): $(call PackageDependencies,$(MGMT_PKGS)) |
13697 | 971 |
$(prep-target) |
972 |
$(call PackageFilter,$(MGMT_PKGS)) |
|
973 |
||
974 |
############################################################# |
|
975 |
# |
|
976 |
# attachdocs |
|
977 |
# |
|
978 |
||
979 |
ALL_OTHER_TARGETS += attachdocs |
|
980 |
||
20363 | 981 |
ATTACH_DOCDIR := $(JDK_API_DOCSDIR)/attach/spec |
982 |
ATTACH2COREAPI := ../../$(JDKJRE2COREAPI) |
|
983 |
ATTACH_DOCTITLE := Attach API |
|
13697 | 984 |
ATTACH_WINDOWTITLE := Attach API |
20363 | 985 |
ATTACH_HEADER := <strong>Attach API</strong> |
986 |
ATTACH_BOTTOM := $(call CommonBottom,$(ATTACH_FIRST_COPYRIGHT_YEAR)) |
|
13697 | 987 |
# ATTACH_PKGS is located in NON_CORE_PKGS.gmk |
988 |
||
20363 | 989 |
ATTACH_INDEX_HTML = $(ATTACH_DOCDIR)/index.html |
990 |
ATTACH_OPTIONS_FILE = $(DOCSTMPDIR)/attach.options |
|
13697 | 991 |
ATTACH_PACKAGES_FILE = $(DOCSTMPDIR)/attach.packages |
992 |
||
993 |
attachdocs: $(ATTACH_INDEX_HTML) |
|
994 |
||
995 |
# Set relative location to core api document root |
|
996 |
$(ATTACH_INDEX_HTML): GET2DOCSDIR=$(ATTACH2COREAPI)/.. |
|
997 |
||
998 |
# Run javadoc if the index file is out of date or missing |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
999 |
$(ATTACH_INDEX_HTML): $(ATTACH_OPTIONS_FILE) $(ATTACH_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 1000 |
$(prep-javadoc) |
1001 |
$(call JavadocSummary,$(ATTACH_OPTIONS_FILE),$(ATTACH_PACKAGES_FILE)) |
|
1002 |
$(JAVADOC_CMD) -d $(@D) \ |
|
20363 | 1003 |
@$(ATTACH_OPTIONS_FILE) @$(ATTACH_PACKAGES_FILE) |
13697 | 1004 |
|
1005 |
# Create file with javadoc options in it |
|
1006 |
$(ATTACH_OPTIONS_FILE): |
|
1007 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1008 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1009 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
1010 |
$(call OptionOnly,-Xdoclint:none) ; \ |
20363 | 1011 |
$(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ |
1012 |
$(call OptionPair,-encoding,ascii) ; \ |
|
1013 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
|
1014 |
$(call OptionPair,-doctitle,$(ATTACH_DOCTITLE)) ; \ |
|
1015 |
$(call OptionPair,-windowtitle,$(ATTACH_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
|
1016 |
$(call OptionPair,-header,$(ATTACH_HEADER)$(DRAFT_HEADER)) ; \ |
|
1017 |
$(call OptionPair,-bottom,$(ATTACH_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 1018 |
$(call OptionTrip,-linkoffline,$(ATTACH2COREAPI),$(COREAPI_DOCSDIR)/); \ |
20363 | 1019 |
) >> $@ |
13697 | 1020 |
|
1021 |
# Create a file with the package names in it |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
1022 |
$(ATTACH_PACKAGES_FILE): $(call PackageDependencies,$(ATTACH_PKGS)) |
13697 | 1023 |
$(prep-target) |
1024 |
$(call PackageFilter,$(ATTACH_PKGS)) |
|
1025 |
||
1026 |
############################################################# |
|
1027 |
# |
|
1028 |
# jconsoledocs |
|
1029 |
# |
|
1030 |
||
1031 |
ALL_OTHER_TARGETS += jconsoledocs |
|
1032 |
||
20363 | 1033 |
JCONSOLE_DOCDIR := $(JDK_API_DOCSDIR)/jconsole/spec |
1034 |
JCONSOLE2COREAPI := ../../$(JDKJRE2COREAPI) |
|
1035 |
JCONSOLE_DOCTITLE := JConsole API |
|
13697 | 1036 |
JCONSOLE_WINDOWTITLE := JConsole API |
20363 | 1037 |
JCONSOLE_HEADER := <strong>JConsole API</strong> |
1038 |
JCONSOLE_BOTTOM := $(call CommonBottom,$(JCONSOLE_FIRST_COPYRIGHT_YEAR)) |
|
13697 | 1039 |
# JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk |
1040 |
||
20363 | 1041 |
JCONSOLE_INDEX_HTML = $(JCONSOLE_DOCDIR)/index.html |
1042 |
JCONSOLE_OPTIONS_FILE = $(DOCSTMPDIR)/jconsole.options |
|
13697 | 1043 |
JCONSOLE_PACKAGES_FILE = $(DOCSTMPDIR)/jconsole.packages |
1044 |
||
1045 |
jconsoledocs: $(JCONSOLE_INDEX_HTML) |
|
1046 |
||
1047 |
# Set relative location to core api document root |
|
1048 |
$(JCONSOLE_INDEX_HTML): GET2DOCSDIR=$(JCONSOLE2COREAPI)/.. |
|
1049 |
||
1050 |
# Run javadoc if the index file is out of date or missing |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
1051 |
$(JCONSOLE_INDEX_HTML): $(JCONSOLE_OPTIONS_FILE) $(JCONSOLE_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 1052 |
$(prep-javadoc) |
1053 |
$(call JavadocSummary,$(JCONSOLE_OPTIONS_FILE),$(JCONSOLE_PACKAGES_FILE)) |
|
1054 |
$(JAVADOC_CMD) -d $(@D) \ |
|
20363 | 1055 |
@$(JCONSOLE_OPTIONS_FILE) @$(JCONSOLE_PACKAGES_FILE) |
13697 | 1056 |
|
1057 |
# Create file with javadoc options in it |
|
1058 |
$(JCONSOLE_OPTIONS_FILE): |
|
1059 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1060 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1061 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
1062 |
$(call OptionOnly,-Xdoclint:none) ; \ |
20363 | 1063 |
$(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ |
1064 |
$(call OptionPair,-encoding,ascii) ; \ |
|
1065 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
|
1066 |
$(call OptionPair,-doctitle,$(JCONSOLE_DOCTITLE)) ; \ |
|
1067 |
$(call OptionPair,-windowtitle,$(JCONSOLE_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
|
1068 |
$(call OptionPair,-header,$(JCONSOLE_HEADER)$(DRAFT_HEADER)) ; \ |
|
1069 |
$(call OptionPair,-bottom,$(JCONSOLE_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 1070 |
$(call OptionTrip,-linkoffline,$(JCONSOLE2COREAPI),$(COREAPI_DOCSDIR)/); \ |
20363 | 1071 |
) >> $@ |
13697 | 1072 |
|
1073 |
# Create a file with the package names in it |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
1074 |
$(JCONSOLE_PACKAGES_FILE): $(call PackageDependencies,$(JCONSOLE_PKGS)) |
13697 | 1075 |
$(prep-target) |
1076 |
$(call PackageFilter,$(JCONSOLE_PKGS)) |
|
1077 |
||
1078 |
############################################################# |
|
1079 |
# |
|
1080 |
# treeapidocs |
|
1081 |
# |
|
1082 |
||
1083 |
ALL_OTHER_TARGETS += treeapidocs |
|
1084 |
||
20363 | 1085 |
TREEAPI_DOCDIR := $(JDK_API_DOCSDIR)/javac/tree |
1086 |
TREEAPI2COREAPI := ../../$(JDKJRE2COREAPI) |
|
1087 |
TREEAPI_DOCTITLE := Compiler Tree API |
|
1088 |
TREEAPI_WINDOWTITLE := Compiler Tree API |
|
1089 |
TREEAPI_HEADER := <strong>Compiler Tree API</strong> |
|
1090 |
TREEAPI_BOTTOM := $(call CommonBottom,$(TREEAPI_FIRST_COPYRIGHT_YEAR)) |
|
1091 |
TREEAPI_GROUPNAME := Packages |
|
1092 |
TREEAPI_REGEXP := com.sun.source.* |
|
13697 | 1093 |
# TREEAPI_PKGS is located in NON_CORE_PKGS.gmk |
1094 |
||
20363 | 1095 |
TREEAPI_INDEX_HTML = $(TREEAPI_DOCDIR)/index.html |
1096 |
TREEAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options |
|
13697 | 1097 |
TREEAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages |
1098 |
||
1099 |
treeapidocs: $(TREEAPI_INDEX_HTML) |
|
1100 |
||
1101 |
# Set relative location to core api document root |
|
1102 |
$(TREEAPI_INDEX_HTML): GET2DOCSDIR=$(TREEAPI2COREAPI)/.. |
|
1103 |
||
1104 |
# Run javadoc if the index file is out of date or missing |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
1105 |
$(TREEAPI_INDEX_HTML): $(TREEAPI_OPTIONS_FILE) $(TREEAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 1106 |
$(prep-javadoc) |
1107 |
$(call JavadocSummary,$(TREEAPI_OPTIONS_FILE),$(TREEAPI_PACKAGES_FILE)) |
|
1108 |
$(JAVADOC_CMD) -d $(@D) \ |
|
20363 | 1109 |
@$(TREEAPI_OPTIONS_FILE) @$(TREEAPI_PACKAGES_FILE) |
13697 | 1110 |
|
1111 |
# Create file with javadoc options in it |
|
1112 |
$(TREEAPI_OPTIONS_FILE): |
|
1113 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1114 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1115 |
$(call COMMON_JAVADOCTAGS) ; \ |
25043
b5598c2ddf6f
8048302: Update bug reporting URL in make/Javadoc.gmk
darcy
parents:
24232
diff
changeset
|
1116 |
$(call OptionOnly,-Xdoclint:all) ; \ |
20363 | 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)) ; \ |
|
13697 | 1123 |
$(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \ |
1124 |
$(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
|
20363 | 1125 |
) >> $@ |
13697 | 1126 |
|
1127 |
# Create a file with the package names in it |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
1128 |
$(TREEAPI_PACKAGES_FILE): $(call PackageDependencies,$(TREEAPI_PKGS)) |
13697 | 1129 |
$(prep-target) |
1130 |
$(call PackageFilter,$(TREEAPI_PKGS)) |
|
1131 |
||
1132 |
############################################################# |
|
1133 |
# |
|
27596
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1134 |
# nashornapidocs |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1135 |
# |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1136 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1137 |
ALL_OTHER_TARGETS += nashornapidocs |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1138 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1139 |
NASHORNAPI_DOCDIR := $(JDK_API_DOCSDIR)/nashorn |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1140 |
NASHORNAPI2COREAPI := ../$(JDKJRE2COREAPI) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1141 |
NASHORNAPI_DOCTITLE := Nashorn API |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1142 |
NASHORNAPI_WINDOWTITLE := Nashorn API |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1143 |
NASHORNAPI_HEADER := <strong>Nashorn API</strong> |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1144 |
NASHORNAPI_BOTTOM := $(call CommonBottom,$(NASHORNAPI_FIRST_COPYRIGHT_YEAR)) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1145 |
NASHORNAPI_GROUPNAME := Packages |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1146 |
NASHORNAPI_REGEXP := jdk.nashorn.api.scripting.* |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1147 |
# NASHORNAPI_PKGS is located in NON_CORE_PKGS.gmk |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1148 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1149 |
NASHORNAPI_INDEX_HTML = $(NASHORNAPI_DOCDIR)/index.html |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1150 |
NASHORNAPI_OPTIONS_FILE = $(DOCSTMPDIR)/nashornapi.options |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1151 |
NASHORNAPI_PACKAGES_FILE = $(DOCSTMPDIR)/nashornapi.packages |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1152 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1153 |
nashornapidocs: $(NASHORNAPI_INDEX_HTML) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1154 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1155 |
# Set relative location to core api document root |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1156 |
$(NASHORNAPI_INDEX_HTML): GET2DOCSDIR=$(NASHORNAPI2COREAPI)/.. |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1157 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1158 |
# Run javadoc if the index file is out of date or missing |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1159 |
$(NASHORNAPI_INDEX_HTML): $(NASHORNAPI_OPTIONS_FILE) $(NASHORNAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1160 |
$(prep-javadoc) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1161 |
$(call JavadocSummary,$(NASHORNAPI_OPTIONS_FILE),$(NASHORNAPI_PACKAGES_FILE)) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1162 |
$(JAVADOC_CMD) -d $(@D) \ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1163 |
@$(NASHORNAPI_OPTIONS_FILE) @$(NASHORNAPI_PACKAGES_FILE) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1164 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1165 |
# Create file with javadoc options in it |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1166 |
$(NASHORNAPI_OPTIONS_FILE): |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1167 |
$(prep-target) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1168 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1169 |
$(call COMMON_JAVADOCTAGS) ; \ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1170 |
$(call OptionOnly,-Xdoclint:all) ; \ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1171 |
$(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1172 |
$(call OptionPair,-encoding,ascii) ; \ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1173 |
$(call OptionPair,-doctitle,$(NASHORNAPI_DOCTITLE)) ; \ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1174 |
$(call OptionPair,-windowtitle,$(NASHORNAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1175 |
$(call OptionPair,-header,$(NASHORNAPI_HEADER)$(DRAFT_HEADER)) ; \ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1176 |
$(call OptionPair,-bottom,$(NASHORNAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1177 |
$(call OptionTrip,-group,$(NASHORNAPI_GROUPNAME),$(NASHORNAPI_REGEXP)); \ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1178 |
$(call OptionTrip,-linkoffline,$(NASHORNAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1179 |
) >> $@ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1180 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1181 |
# Create a file with the package names in it |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1182 |
$(NASHORNAPI_PACKAGES_FILE): $(call PackageDependencies,$(NASHORNAPI_PKGS)) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1183 |
$(prep-target) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1184 |
$(call PackageFilter,$(NASHORNAPI_PKGS)) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1185 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1186 |
############################################################# |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1187 |
# |
13697 | 1188 |
# sctpdocs |
1189 |
# |
|
1190 |
||
1191 |
ALL_OTHER_TARGETS += sctpdocs |
|
1192 |
||
20363 | 1193 |
SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec |
1194 |
SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI) |
|
1195 |
SCTPAPI_DOCTITLE := SCTP API |
|
13697 | 1196 |
SCTPAPI_WINDOWTITLE := SCTP API |
20363 | 1197 |
SCTPAPI_HEADER := <strong>SCTP API</strong> |
1198 |
SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR)) |
|
13697 | 1199 |
# SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk |
1200 |
||
20363 | 1201 |
SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html |
1202 |
SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options |
|
13697 | 1203 |
SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages |
1204 |
||
1205 |
sctpdocs: $(SCTPAPI_INDEX_HTML) |
|
1206 |
||
1207 |
# Set relative location to core api document root |
|
1208 |
$(SCTPAPI_INDEX_HTML): GET2DOCSDIR=$(SCTPAPI2COREAPI)/.. |
|
1209 |
||
1210 |
# Run javadoc if the index file is out of date or missing |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
1211 |
$(SCTPAPI_INDEX_HTML): $(SCTPAPI_OPTIONS_FILE) $(SCTPAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 1212 |
$(prep-javadoc) |
1213 |
$(call JavadocSummary,$(SCTPAPI_OPTIONS_FILE),$(SCTPAPI_PACKAGES_FILE)) |
|
1214 |
$(JAVADOC_CMD) -d $(@D) \ |
|
20363 | 1215 |
@$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE) |
13697 | 1216 |
|
1217 |
# Create file with javadoc options in it |
|
1218 |
$(SCTPAPI_OPTIONS_FILE): |
|
1219 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1220 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1221 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
1222 |
$(call OptionOnly,-Xdoclint:none) ; \ |
20363 | 1223 |
$(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ |
1224 |
$(call OptionPair,-encoding,ascii) ; \ |
|
1225 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
|
1226 |
$(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \ |
|
1227 |
$(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
|
1228 |
$(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \ |
|
1229 |
$(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 1230 |
$(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
20363 | 1231 |
) >> $@ |
13697 | 1232 |
|
1233 |
# Create a file with the package names in it |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
1234 |
$(SCTPAPI_PACKAGES_FILE): $(call PackageDependencies,$(SCTPAPI_PKGS)) |
13697 | 1235 |
$(prep-target) |
1236 |
$(call PackageFilter,$(SCTPAPI_PKGS)) |
|
1237 |
||
1238 |
############################################################# |
|
1239 |
# |
|
23836
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1240 |
# jdk.net docs |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1241 |
# |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1242 |
|
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1243 |
ALL_OTHER_TARGETS += jdknetdocs |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1244 |
|
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1245 |
JDKNET_DOCDIR := $(JRE_API_DOCSDIR)/net/socketoptions/spec |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1246 |
JDKNET2COREAPI := ../../../$(JDKJRE2COREAPI) |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1247 |
JDKNET_DOCTITLE := jdk.net API |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1248 |
JDKNET_WINDOWTITLE := jdk.net API |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1249 |
JDKNET_HEADER := <strong>jdk.net API</strong> |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1250 |
JDKNET_BOTTOM := $(call CommonBottom,$(JDKNET_FIRST_COPYRIGHT_YEAR)) |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1251 |
JDKNET_PKGS := jdk.net |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1252 |
|
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1253 |
JDKNET_INDEX_HTML = $(JDKNET_DOCDIR)/index.html |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1254 |
JDKNET_OPTIONS_FILE = $(DOCSTMPDIR)/jdknet.options |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1255 |
JDKNET_PACKAGES_FILE = $(DOCSTMPDIR)/jdknet.packages |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1256 |
|
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1257 |
jdknetdocs: $(JDKNET_INDEX_HTML) |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1258 |
|
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1259 |
# Set relative location to core api document root |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1260 |
$(JDKNET_INDEX_HTML): GET2DOCSDIR=$(JDKNET2COREAPI)/.. |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1261 |
|
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1262 |
# Run javadoc if the index file is out of date or missing |
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
1263 |
$(JDKNET_INDEX_HTML): $(JDKNET_OPTIONS_FILE) $(JDKNET_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
23836
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1264 |
$(prep-javadoc) |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1265 |
$(call JavadocSummary,$(JDKNET_OPTIONS_FILE),$(JDKNET_PACKAGES_FILE)) |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1266 |
$(JAVADOC_CMD) -d $(@D) \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1267 |
@$(JDKNET_OPTIONS_FILE) @$(JDKNET_PACKAGES_FILE) |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1268 |
|
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1269 |
# Create file with javadoc options in it |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1270 |
$(JDKNET_OPTIONS_FILE): |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1271 |
$(prep-target) |
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1272 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1273 |
$(call COMMON_JAVADOCTAGS) ; \ |
23836
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1274 |
$(call OptionOnly,-Xdoclint:none) ; \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1275 |
$(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1276 |
$(call OptionPair,-encoding,ascii) ; \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1277 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1278 |
$(call OptionPair,-doctitle,$(JDKNET_DOCTITLE)) ; \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1279 |
$(call OptionPair,-windowtitle,$(JDKNET_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1280 |
$(call OptionPair,-header,$(JDKNET_HEADER)$(DRAFT_HEADER)); \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1281 |
$(call OptionPair,-bottom,$(JDKNET_BOTTOM)$(DRAFT_BOTTOM)); \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1282 |
$(call OptionTrip,-linkoffline,$(JDKNET2COREAPI),$(COREAPI_DOCSDIR)/); \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1283 |
) >> $@ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1284 |
|
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1285 |
# Create a file with the package names in it |
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
1286 |
$(JDKNET_PACKAGES_FILE): $(call PackageDependencies,$(JDKNET_PKGS)) |
23836
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1287 |
$(prep-target) |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1288 |
$(call PackageFilter,$(JDKNET_PKGS)) |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1289 |
|
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1290 |
############################################################# |
13697 | 1291 |
#release version of core packages ######## |
21759 | 1292 |
|
1293 |
# The rel-coredocs and rel-docs targets were added by Eric Armstrong. rel-coredocs |
|
1294 |
# assumes the kind of large, 32-bit machine used in the javapubs group's docs-release |
|
1295 |
# process. It specifies memory settings accordingly to maximize performance. |
|
1296 |
# |
|
1297 |
# The performance settings, like the sanity check, are most important for the core |
|
1298 |
# docs--the platform APIs. Running javadoc on those APIs takes a significant amount |
|
1299 |
# of time and memory. Setting the initial heap size as large as possible is important |
|
1300 |
# to prevent thrashing as the heap grows. Setting the maximum as large as necessary |
|
1301 |
# is also important to keep the job from failing. |
|
1302 |
# |
|
1303 |
# -J-Xmx512 sets a maximum of 512, which became necessary in 6.0 |
|
1304 |
# -J-Xms256 sets starting size to 256 (default is 8) |
|
1305 |
# |
|
1306 |
# rel-coredocs also includes a sanity check to help ensure that BUILD_NUMBER and |
|
1307 |
# MILESTONE are specified properly when docs are built outside of the normal release |
|
1308 |
# engineering process, with the intention of releasing them on the web or in a downloaded |
|
1309 |
# docs bundle. (When invoked in release engineering's control build, the values are always |
|
1310 |
# set properly. But when the targets are run by themselves, they default to b00 and |
|
1311 |
# "internal"--which silently sabotage the result of a build that can take many hours |
|
1312 |
# to complete. |
|
1313 |
||
13697 | 1314 |
# Maximize performance and ensure that build number & milestone are set. |
1315 |
||
1316 |
rel-coredocs: sanitycheckcoredocs |
|
1317 |
$(MAKE) coredocs |
|
1318 |
||
1319 |
rel-docs: rel-coredocs $(ALL_OTHER_TARGETS) |
|
1320 |
# |
|
1321 |
# end of production targets |
|
1322 |
||
1323 |
otherdocs: $(ALL_OTHER_TARGETS) |
|
1324 |
||
1325 |
clean: |
|
1326 |
$(RM) -r $(DOCSDIR) $(DOCSTMPDIR) |
|
1327 |
||
1328 |
############################################################# |
|
1329 |
# DEBUG TARGET |
|
1330 |
# List the values defined in the makefile hierarchy, to make sure everything |
|
1331 |
# is set properly, and to help identify values we can use instead of making new ones. |
|
1332 |
# (Most of them come from common/shared/Defs.gmk) |
|
1333 |
# |
|
20363 | 1334 |
# Notes: |
1335 |
# * BUILD_NUMBER defaults to b00 if not set on command line with BUILD_NUMBER=<value> |
|
1336 |
# * MILESTONE defaults to internal unless set to beta, rc, or fcs on command line |
|
13697 | 1337 |
# |
1338 |
||
1339 |
############################################################# |
|
1340 |
.PHONY: all docs coredocs rel-docs otherdocs rel-coredocs \ |
|
20363 | 1341 |
sanitycheckcoredocs $(ALL_OTHER_TARGETS) |