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