author | dpochepk |
Mon, 08 Aug 2016 11:30:46 +0300 | |
changeset 40371 | 98d4822ec8ef |
parent 39935 | 6016bd47edc9 |
child 40241 | 59abac94e4f2 |
permissions | -rw-r--r-- |
36506 | 1 |
# Copyright (c) 1997, 2016, 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 |
||
37972 | 47 |
DOCSDIR := $(DOCS_IMAGE_DIR) |
27560 | 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 |
|
36792
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
77 |
JSHELLAPI_FIRST_COPYRIGHT_YEAR = 2015 |
20363 | 78 |
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
|
79 |
NASHORNAPI_FIRST_COPYRIGHT_YEAR = 2014 |
35369
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
80 |
DYNALINKAPI_FIRST_COPYRIGHT_YEAR = 2015 |
20363 | 81 |
JNLP_FIRST_COPYRIGHT_YEAR = 1998 |
82 |
PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007 |
|
23836
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
83 |
JDKNET_FIRST_COPYRIGHT_YEAR = 2014 |
29851
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
84 |
JACCESSAPI_FIRST_COPYRIGHT_YEAR = 2002 |
39932
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
85 |
JSOBJECT_FIRST_COPYRIGHT_YEAR = 1993 |
13697 | 86 |
|
87 |
# Oracle name |
|
88 |
FULL_COMPANY_NAME = Oracle and/or its affiliates |
|
89 |
||
90 |
# Copyright address |
|
91 |
COMPANY_ADDRESS = 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA. |
|
92 |
||
93 |
# The trademark symbol |
|
94 |
TRADEMARK = ™ |
|
95 |
||
96 |
# Common copyright lines used |
|
20363 | 97 |
# The word "Copyright" might optionally be a link to the file cpyr.html. |
98 |
# The first year of copyright may vary or not be available. |
|
99 |
# The address to the company might be optional. |
|
13697 | 100 |
COMMA:= , |
101 |
EMPTY:= |
|
102 |
SPACE:=$(EMPTY) $(EMPTY) |
|
103 |
COPYRIGHT_SYMBOL = &\#x00a9; |
|
104 |
# Macro to construct the copyright line |
|
20363 | 105 |
# (The GNU make 3.78.1 "if" conditional is broken, fixed in GNU make 3.81) |
13697 | 106 |
define CopyrightLine # optionalurl optionalfirstyear optionaladdress |
107 |
$(if $(strip $1),<a href="$(strip $1)">Copyright</a>,Copyright) \ |
|
108 |
$(COPYRIGHT_SYMBOL) $(if $2,$2${COMMA},) $(COPYRIGHT_YEAR),\ |
|
109 |
$(FULL_COMPANY_NAME). $3 All rights reserved. |
|
110 |
endef |
|
111 |
||
112 |
# Url to root of documents |
|
113 |
DOCSDIR_URL = {@docroot}/$(GET2DOCSDIR) |
|
114 |
||
115 |
# Url to copyright html file |
|
24232
ddfae175a8d2
8042348: Copyright link in Javadoc page for Java SE 8
erikj
parents:
23986
diff
changeset
|
116 |
COPYRIGHT_URL = $(DOCSDIR_URL)/legal/cpyr.html |
13697 | 117 |
|
118 |
# Url to bug filing site |
|
25043
b5598c2ddf6f
8048302: Update bug reporting URL in make/Javadoc.gmk
darcy
parents:
24232
diff
changeset
|
119 |
BUG_SUBMIT_URL = http://bugreport.java.com/bugreport/ |
13697 | 120 |
|
121 |
# Common line for how to submit a bug or rfe |
|
122 |
BUG_SUBMIT_LINE = <a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a> |
|
123 |
||
124 |
# Url to devdocs page |
|
33926
3a19edba4808
8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents:
30416
diff
changeset
|
125 |
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
|
126 |
DEV_DOCS_URL = $(DOCS_BASE_URL)/index.html |
13697 | 127 |
|
128 |
# Common Java trademark line |
|
129 |
JAVA_TRADEMARK_LINE = Java is a trademark or registered trademark of \ |
|
130 |
$(FULL_COMPANY_NAME) in the US and other countries. |
|
131 |
||
132 |
################################################################# |
|
133 |
# Macros: |
|
134 |
||
135 |
||
136 |
# List of all possible directories for javadoc to look for sources |
|
20363 | 137 |
# NOTE: Quotes are required around sourcepath argument only on Windows. |
138 |
# Otherwise, you get "No packages or classes specified." due |
|
139 |
# to $(PATH_SEP) being interpreted as an end of |
|
140 |
# command (newline or shell ; character) |
|
25854 | 141 |
ALL_SOURCE_DIRS := $(wildcard \ |
36506 | 142 |
$(SUPPORT_OUTPUTDIR)/gensrc/j* \ |
143 |
$(if $(IMPORT_MODULES_SRC), $(IMPORT_MODULES_SRC)/*) \ |
|
27586
e7cfdc266a70
8058631: Rename posix to unix in build system to match file name changes
ihse
parents:
27328
diff
changeset
|
144 |
$(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
|
145 |
$(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS_TYPE)/classes \ |
36506 | 146 |
$(JDK_TOPDIR)/src/*/share/classes \ |
147 |
$(HOTSPOT_TOPDIR)/src/*/share/classes \ |
|
25854 | 148 |
$(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
|
149 |
$(NASHORN_TOPDIR)/src/*/share/classes \ |
25854 | 150 |
$(CORBA_TOPDIR)/src/*/share/classes \ |
151 |
$(JAXP_TOPDIR)/src/*/share/classes \ |
|
152 |
$(JAXWS_TOPDIR)/src/*/share/classes \ |
|
27560 | 153 |
$(SUPPORT_OUTPUTDIR)/rmic/j* \ |
25854 | 154 |
$(JDK_TOPDIR)/src/*/share/doc/stub \ |
155 |
) \ |
|
156 |
# |
|
13697 | 157 |
|
36506 | 158 |
ALL_MODULE_SOURCE_DIRS := \ |
159 |
$(SUPPORT_OUTPUTDIR)/gensrc/* \ |
|
160 |
$(if $(IMPORT_MODULES_SRC), $(IMPORT_MODULES_SRC)/*) \ |
|
161 |
$(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS)/classes \ |
|
162 |
$(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS_TYPE)/classes \ |
|
163 |
$(JDK_TOPDIR)/src/*/share/classes \ |
|
164 |
$(HOTSPOT_TOPDIR)/src/*/share/classes \ |
|
165 |
$(LANGTOOLS_TOPDIR)/src/*/share/classes \ |
|
166 |
$(NASHORN_TOPDIR)/src/*/share/classes \ |
|
167 |
$(CORBA_TOPDIR)/src/*/share/classes \ |
|
168 |
$(JAXP_TOPDIR)/src/*/share/classes \ |
|
169 |
$(JAXWS_TOPDIR)/src/*/share/classes \ |
|
170 |
$(SUPPORT_OUTPUTDIR)/rmic/* \ |
|
171 |
$(JDK_TOPDIR)/src/*/share/doc/stub \ |
|
172 |
# |
|
173 |
||
174 |
||
13697 | 175 |
# List with classpath separator between them |
176 |
EMPTY:= |
|
177 |
SPACE:= $(EMPTY) $(EMPTY) |
|
178 |
RELEASEDOCS_SOURCEPATH = \ |
|
15052 | 179 |
$(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_SOURCE_DIRS))) |
13697 | 180 |
|
36506 | 181 |
RELEASEDOCS_MODULESOURCEPATH = \ |
182 |
$(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_MODULE_SOURCE_DIRS))) |
|
183 |
||
13697 | 184 |
define prep-target |
20363 | 185 |
$(MKDIR) -p $(@D) |
186 |
$(RM) $@ |
|
13697 | 187 |
endef |
188 |
||
189 |
# Prep for javadoc creation, assumes $@ is an index.html file |
|
190 |
define prep-javadoc |
|
20363 | 191 |
@if [ -f "$@" -a "$?" != "" ] ; then \ |
192 |
$(ECHO) "# Dependencies have changed: $?"; \ |
|
193 |
fi |
|
194 |
$(RM) -r $(@D) |
|
195 |
$(MKDIR) -p $(@D) |
|
13697 | 196 |
endef |
197 |
||
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
198 |
$(eval $(call FillCacheFind, $(ALL_SOURCE_DIRS))) |
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
199 |
define PackageDependencies |
25854 | 200 |
$(call CacheFind, $(wildcard $(foreach p, $(subst .,/,$1), $(addsuffix /$p, $(ALL_SOURCE_DIRS))))) |
13697 | 201 |
endef |
202 |
||
203 |
# Given a list of packages, add packages that exist to $@, print summary |
|
204 |
define PackageFilter # packages |
|
20363 | 205 |
@if [ "$1" != "" ] ; then \ |
206 |
for p in $1 ; do \ |
|
207 |
pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \ |
|
208 |
found="false"; \ |
|
209 |
for cp in $(ALL_SOURCE_DIRS) ; do \ |
|
210 |
if [ -d $${cp}/$${pd} ] ; then \ |
|
211 |
$(ECHO) "$${p}" >> $@; \ |
|
212 |
found="true"; \ |
|
213 |
break; \ |
|
214 |
fi; \ |
|
215 |
done; \ |
|
216 |
if [ "$${found}" = "false" ] ; then \ |
|
217 |
$(ECHO) "WARNING: Package not found: $${p}"; \ |
|
218 |
fi; \ |
|
219 |
done; \ |
|
220 |
fi |
|
13697 | 221 |
endef |
222 |
||
223 |
# Print out a summary of the javadoc command about to be run |
|
224 |
define JavadocSummary # optionsfile packagesfile |
|
23986
1809fb8266cb
8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents:
23836
diff
changeset
|
225 |
@$(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
|
226 |
@($(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
|
227 |
@($(ECHO) "# Packages (`$(BASENAME) $2`):";$(SED) -e 's@^@# @' $2) $(LOG_DEBUG) |
13697 | 228 |
endef |
229 |
||
230 |
# |
|
231 |
# Different api directories created from root directory |
|
232 |
# |
|
20363 | 233 |
COREAPI_DOCSDIR = $(DOCSDIR)/api |
234 |
JDK_API_DOCSDIR = $(DOCSDIR)/jdk/api |
|
235 |
JRE_API_DOCSDIR = $(DOCSDIR)/jre/api |
|
236 |
PLATFORM_DOCSDIR = $(DOCSDIR)/platform |
|
13697 | 237 |
|
37034
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
238 |
JAVADOC_ARCHIVE_NAME := jdk-$(VERSION_STRING)-docs.zip |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
239 |
JAVADOC_ARCHIVE_ASSEMBLY_DIR := $(DOCSTMPDIR)/zip-docs |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
240 |
JAVADOC_ARCHIVE_DIR := $(OUTPUT_ROOT)/bundles |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
241 |
JAVADOC_ARCHIVE := $(JAVADOC_ARCHIVE_DIR)/$(JAVADOC_ARCHIVE_NAME) |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
242 |
|
35817 | 243 |
# The core api index file is the target for the core api javadocs rule |
244 |
# and needs to be defined early so that all other javadoc rules may |
|
245 |
# depend on it. |
|
246 |
COREAPI_INDEX_FILE = $(COREAPI_DOCSDIR)/index.html |
|
247 |
||
13697 | 248 |
# The non-core api javadocs need to be able to access the root of the core |
20363 | 249 |
# api directory, so for jdk/api or jre/api to get to the core api/ |
250 |
# directory we would use this: |
|
251 |
JDKJRE2COREAPI = ../../api |
|
13697 | 252 |
|
253 |
# Common bottom argument |
|
254 |
define CommonBottom # year |
|
255 |
<font size="-1"><br> $(call CopyrightLine,,$1,)</font> |
|
256 |
endef |
|
257 |
||
258 |
# Common trademark bottom argument (Not sure why this is used sometimes) |
|
259 |
define CommonTrademarkBottom # year |
|
260 |
<font size="-1">\ |
|
261 |
$(BUG_SUBMIT_LINE)<br>$(JAVA_TRADEMARK_LINE)<br>\ |
|
262 |
$(call CopyrightLine,,$1,$(COMPANY_ADDRESS))\ |
|
263 |
</font> |
|
264 |
endef |
|
265 |
||
266 |
# Common echo of option |
|
267 |
define OptionOnly # opt |
|
28007
877ab0d032b8
8066138: Trailing whitespace in title of javadoc: Overview (Java Platform SE 7 )
alundblad
parents:
27602
diff
changeset
|
268 |
if [ "$(strip $1)" != "" ] ; then \ |
877ab0d032b8
8066138: Trailing whitespace in title of javadoc: Overview (Java Platform SE 7 )
alundblad
parents:
27602
diff
changeset
|
269 |
$(PRINTF) "%s\n" "$(strip $1)"; \ |
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
270 |
fi |
13697 | 271 |
endef |
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
272 |
|
13697 | 273 |
define OptionPair # opt arg |
28007
877ab0d032b8
8066138: Trailing whitespace in title of javadoc: Overview (Java Platform SE 7 )
alundblad
parents:
27602
diff
changeset
|
274 |
$(PRINTF) "%s '%s'\n" "$(strip $1)" '$(strip $2)' |
13697 | 275 |
endef |
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
276 |
|
13697 | 277 |
define OptionTrip # opt arg arg |
28007
877ab0d032b8
8066138: Trailing whitespace in title of javadoc: Overview (Java Platform SE 7 )
alundblad
parents:
27602
diff
changeset
|
278 |
$(PRINTF) "%s '%s' '%s'\n" "$(strip $1)" '$(strip $2)' '$(strip $3)' |
13697 | 279 |
endef |
280 |
||
281 |
# Core api bottom argument (with special sauce) |
|
282 |
COREAPI_BOTTOM = <font size="-1"> $(BUG_SUBMIT_LINE)\ |
|
283 |
<br>For further API reference and developer documentation, \ |
|
284 |
see <a href="$(DEV_DOCS_URL)" target="_blank">Java SE Documentation</a>. \ |
|
285 |
That documentation contains more detailed, developer-targeted descriptions, \ |
|
286 |
with conceptual overviews, definitions of terms, workarounds, \ |
|
287 |
and working code examples.<br>\ |
|
288 |
$(call CopyrightLine,$(COPYRIGHT_URL),$(FIRST_COPYRIGHT_YEAR),)\ |
|
289 |
</font> |
|
290 |
||
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
291 |
# Common javadoc options used by all bundles |
13697 | 292 |
|
39384
adde8cb7d01b
8003593: build-infra: Paths to optional platform-specific files should not be hardwired to src/closed
erikj
parents:
39381
diff
changeset
|
293 |
# This flag may be overridden from a custom makefile |
adde8cb7d01b
8003593: build-infra: Paths to optional platform-specific files should not be hardwired to src/closed
erikj
parents:
39381
diff
changeset
|
294 |
DOCROOTPARENT_FLAG = -Xdocrootparent $(DOCS_BASE_URL) |
13697 | 295 |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
296 |
define COMMON_JAVADOCFLAGS |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
297 |
$(call OptionOnly,-XDignore.symbol.file=true) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
298 |
$(call OptionOnly,-quiet) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
299 |
$(call OptionOnly,-use) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
300 |
$(call OptionOnly,-keywords) ; \ |
39384
adde8cb7d01b
8003593: build-infra: Paths to optional platform-specific files should not be hardwired to src/closed
erikj
parents:
39381
diff
changeset
|
301 |
$(call OptionOnly,$(DOCROOTPARENT_FLAG)) |
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
302 |
endef |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
303 |
|
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
304 |
# Common javadoc tags used by all bundles |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
305 |
|
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
306 |
# Java language specification cite |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
307 |
TAG_JLS = jls:a:See <cite> \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
308 |
The Java™ Language Specification</cite>: |
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 |
# Java virtual machine specification cite |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
311 |
TAG_JVMS = jvms:a:See <cite> \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
312 |
The Java™ Virtual Machine Specification</cite>: |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
313 |
|
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
314 |
# 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
|
315 |
# 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
|
316 |
define COMMON_JAVADOCTAGS |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
317 |
$(call OptionPair,-tag,beaninfo:X) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
318 |
$(call OptionPair,-tag,revised:X) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
319 |
$(call OptionPair,-tag,since.unbundled:X) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
320 |
$(call OptionPair,-tag,spec:X) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
321 |
$(call OptionPair,-tag,specdefault:X) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
322 |
$(call OptionPair,-tag,Note:X) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
323 |
$(call OptionPair,-tag,ToDo:X) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
324 |
$(call OptionPair,-tag,apiNote:a:API Note:) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
325 |
$(call OptionPair,-tag,implSpec:a:Implementation Requirements:) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
326 |
$(call OptionPair,-tag,implNote:a:Implementation Note:) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
327 |
$(call OptionPair,-tag,param) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
328 |
$(call OptionPair,-tag,return) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
329 |
$(call OptionPair,-tag,throws) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
330 |
$(call OptionPair,-tag,since) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
331 |
$(call OptionPair,-tag,version) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
332 |
$(call OptionPair,-tag,serialData) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
333 |
$(call OptionPair,-tag,factory) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
334 |
$(call OptionPair,-tag,see) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
335 |
$(call OptionPair,-tag,$(TAG_JVMS)) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
336 |
$(call OptionPair,-tag,$(TAG_JLS)) |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
337 |
endef |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
338 |
|
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
339 |
|
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
340 |
|
33929 | 341 |
# Assume we need a draft format when the version string is not a GA version. |
342 |
ifeq ($(VERSION_IS_GA), false) |
|
33926
3a19edba4808
8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents:
30416
diff
changeset
|
343 |
DRAFT_HEADER := <br><strong>DRAFT $(VERSION_STRING)</strong> |
3a19edba4808
8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents:
30416
diff
changeset
|
344 |
DRAFT_BOTTOM := <br><strong>DRAFT $(VERSION_STRING)</strong> |
3a19edba4808
8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents:
30416
diff
changeset
|
345 |
DRAFT_WINTITLE := $(VERSION_BUILD) |
20363 | 346 |
# 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
|
347 |
COREAPI_TOP_EARLYACCESS := \ |
13697 | 348 |
<div style="background-color: \#EEEEEE"> \ |
349 |
<div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; \ |
|
350 |
margin-left: 6px; margin-right: 6px; text-align: justify; \ |
|
351 |
font-size: 80%; font-family: Helvetica, Arial, sans-serif; \ |
|
352 |
font-weight: normal;"> \ |
|
353 |
Please note that the specifications and other information \ |
|
354 |
contained herein are not final and are subject to change. \ |
|
355 |
The information is being made available to you solely for purpose of \ |
|
356 |
evaluation. \ |
|
357 |
</div> </div> |
|
33926
3a19edba4808
8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents:
30416
diff
changeset
|
358 |
else |
3a19edba4808
8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents:
30416
diff
changeset
|
359 |
DRAFT_HEADER := |
3a19edba4808
8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents:
30416
diff
changeset
|
360 |
DRAFT_BOTTOM := |
3a19edba4808
8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents:
30416
diff
changeset
|
361 |
DRAFT_WINTITLE := |
3a19edba4808
8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents:
30416
diff
changeset
|
362 |
COREAPI_TOP_EARLYACCESS := |
13697 | 363 |
endif |
364 |
||
365 |
################################################################# |
|
366 |
||
367 |
# |
|
27328 | 368 |
# Load custom Javadoc rules |
369 |
# |
|
370 |
||
371 |
$(eval $(call IncludeCustomExtension, , Javadoc.gmk)) |
|
372 |
||
373 |
################################################################# |
|
374 |
||
375 |
# |
|
13697 | 376 |
# Default target is same as docs target, create core api and all others it can |
377 |
# |
|
378 |
||
379 |
all: docs |
|
380 |
docs: coredocs otherdocs |
|
381 |
||
37034
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
382 |
# |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
383 |
# Optional target which bundles all generated javadocs into a zip archive. |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
384 |
# The dependency on docs is handled in Main.gmk. |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
385 |
# |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
386 |
|
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
387 |
zip-docs: $(JAVADOC_ARCHIVE) |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
388 |
|
13697 | 389 |
############################################################# |
390 |
# |
|
391 |
# coredocs |
|
392 |
# |
|
20363 | 393 |
COREAPI_DOCTITLE = Java$(TRADEMARK) Platform, Standard Edition \ |
33926
3a19edba4808
8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents:
30416
diff
changeset
|
394 |
$(VERSION_SPECIFICATION)<br>API Specification |
3a19edba4808
8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents:
30416
diff
changeset
|
395 |
COREAPI_WINDOWTITLE = Java Platform SE $(VERSION_SPECIFICATION) |
13697 | 396 |
COREAPI_HEADER = \ |
33926
3a19edba4808
8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents:
30416
diff
changeset
|
397 |
<strong>Java$(TRADEMARK) Platform<br>Standard Ed. $(VERSION_SPECIFICATION)</strong> |
13697 | 398 |
|
399 |
# Overview file for core apis |
|
25854 | 400 |
COREAPI_OVERVIEW = $(JDK_TOPDIR)/src/java.base/share/classes/overview-core.html |
13697 | 401 |
|
35817 | 402 |
# The options and packages files |
20363 | 403 |
COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options |
13697 | 404 |
COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages |
405 |
||
36506 | 406 |
# The modules required to be documented |
407 |
COREAPI_MODULES = java.se.ee |
|
408 |
||
13697 | 409 |
coredocs: $(COREAPI_INDEX_FILE) |
410 |
||
411 |
# Set relative location to core api document root |
|
412 |
$(COREAPI_INDEX_FILE): GET2DOCSDIR=.. |
|
413 |
||
414 |
# Run javadoc if the index file is out of date or missing |
|
415 |
$(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE) |
|
416 |
$(prep-javadoc) |
|
417 |
$(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE)) |
|
418 |
$(JAVADOC_CMD) -d $(@D) \ |
|
20363 | 419 |
@$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE) |
13697 | 420 |
|
421 |
# Create file with javadoc options in it |
|
422 |
$(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW) |
|
423 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
424 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
425 |
$(call COMMON_JAVADOCTAGS) ; \ |
31567
626eeea487f8
8080722: Revisit how to check for doclint reference warning during the build
darcy
parents:
30416
diff
changeset
|
426 |
$(call OptionOnly,-Xdoclint:reference) ; \ |
39609
59f6b3bda1b6
8161255: jdk build "all" (docs) fails on all platforms, error from DefaultLoggerFinder.java
bpatel
parents:
39384
diff
changeset
|
427 |
$(call OptionOnly,-Xdoclint/package:-org.omg.*$(COMMA)jdk.internal.logging.*) ; \ |
36506 | 428 |
$(call OptionPair,-system,none) ; \ |
429 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
430 |
$(call OptionPair,-addmods,$(COREAPI_MODULES)) ; \ |
|
20363 | 431 |
$(call OptionPair,-encoding,ISO-8859-1) ; \ |
432 |
$(call OptionOnly,-splitIndex) ; \ |
|
433 |
$(call OptionPair,-overview,$(COREAPI_OVERVIEW)) ; \ |
|
434 |
$(call OptionPair,-doctitle,$(COREAPI_DOCTITLE)) ; \ |
|
435 |
$(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ; \ |
|
436 |
$(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER)) ; \ |
|
437 |
$(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
438 |
) >> $@ |
|
439 |
ifdef COREAPI_TOP_EARLYACCESS |
|
440 |
@$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@ |
|
441 |
endif |
|
13697 | 442 |
|
443 |
# 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
|
444 |
$(COREAPI_PACKAGES_FILE): $(call PackageDependencies,$(CORE_PKGS)) |
13697 | 445 |
$(prep-target) |
446 |
$(call PackageFilter,$(CORE_PKGS)) |
|
447 |
||
448 |
############################################################# |
|
449 |
# |
|
450 |
# docletapidocs |
|
451 |
# |
|
452 |
||
453 |
ALL_OTHER_TARGETS += docletapidocs |
|
454 |
||
20363 | 455 |
DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet |
456 |
DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI) |
|
457 |
DOCLETAPI_DOCTITLE := Doclet API |
|
458 |
DOCLETAPI_WINDOWTITLE := Doclet API |
|
459 |
DOCLETAPI_HEADER := <strong>Doclet API</strong> |
|
460 |
DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR)) |
|
461 |
DOCLETAPI_GROUPNAME := Packages |
|
39113
6fd54814d221
8154399: Need replacement for jdk.javadoc/com.sun.tools.doclets.standard.Standard
jjg
parents:
37972
diff
changeset
|
462 |
DOCLETAPI_REGEXP := jdk.javadoc.doclet* |
13697 | 463 |
# DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk |
464 |
||
465 |
# The index.html, options, and packages files |
|
20363 | 466 |
DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html |
467 |
DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options |
|
13697 | 468 |
DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages |
469 |
||
36506 | 470 |
# The modules required to be documented |
471 |
DOCLETAPI_MODULES = jdk.javadoc |
|
472 |
||
13697 | 473 |
docletapidocs: $(DOCLETAPI_INDEX_FILE) |
474 |
||
475 |
# Set relative location to core api document root |
|
476 |
$(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/.. |
|
477 |
||
478 |
# 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
|
479 |
$(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 480 |
$(prep-javadoc) |
481 |
$(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE)) |
|
29176
45baf3cdc876
8074395: Random build failures in javadoc on Solaris
erikj
parents:
28010
diff
changeset
|
482 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
20363 | 483 |
@$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE) |
13697 | 484 |
|
485 |
# Create file with javadoc options in it |
|
486 |
$(DOCLETAPI_OPTIONS_FILE): |
|
487 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
488 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
489 |
$(call COMMON_JAVADOCTAGS) ; \ |
25043
b5598c2ddf6f
8048302: Update bug reporting URL in make/Javadoc.gmk
darcy
parents:
24232
diff
changeset
|
490 |
$(call OptionOnly,-Xdoclint:all) ; \ |
36506 | 491 |
$(call OptionPair,-system,none) ; \ |
492 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
493 |
$(call OptionPair,-addmods,$(DOCLETAPI_MODULES)) ; \ |
|
20363 | 494 |
$(call OptionPair,-encoding,ascii) ; \ |
495 |
$(call OptionOnly,-breakiterator) ; \ |
|
496 |
$(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \ |
|
497 |
$(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
|
498 |
$(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \ |
|
499 |
$(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 500 |
$(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \ |
501 |
$(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
|
20363 | 502 |
) >> $@ |
13697 | 503 |
|
504 |
# Create a file with the package names in it |
|
27595
cff167b3bfa2
8065914: Various improvements and cleanup of build system
ihse
parents:
27586
diff
changeset
|
505 |
$(DOCLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(DOCLETAPI_PKGS)) |
13697 | 506 |
$(prep-target) |
507 |
$(call PackageFilter,$(DOCLETAPI_PKGS)) |
|
508 |
||
509 |
############################################################# |
|
510 |
# |
|
35367
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
511 |
# old docletapidocs |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
512 |
# |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
513 |
|
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
514 |
ALL_OTHER_TARGETS += olddocletapidocs |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
515 |
|
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
516 |
OLD_DOCLET_DIR := $(JDK_API_DOCSDIR)/javadoc/old |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
517 |
OLD_DOCLETAPI_DOCDIR := $(OLD_DOCLET_DIR)/doclet |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
518 |
OLD_DOCLETAPI2COREAPI := ../../../$(JDKJRE2COREAPI) |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
519 |
OLD_DOCLETAPI_DOCTITLE := Doclet API |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
520 |
OLD_DOCLETAPI_WINDOWTITLE := Doclet API |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
521 |
OLD_DOCLETAPI_HEADER := <strong>Doclet API</strong> |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
522 |
OLD_DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR)) |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
523 |
OLD_DOCLETAPI_GROUPNAME := Packages |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
524 |
OLD_DOCLETAPI_REGEXP := com.sun.javadoc |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
525 |
# OLD_DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
526 |
|
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
527 |
# The index.html, options, and packages files |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
528 |
OLD_DOCLETAPI_INDEX_FILE = $(OLD_DOCLETAPI_DOCDIR)/index.html |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
529 |
OLD_DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/old-docletapi.options |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
530 |
OLD_DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/old-docletapi.packages |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
531 |
|
36506 | 532 |
# The modules required to be documented |
533 |
OLD_DOCLETAPI_MODULES = jdk.javadoc |
|
534 |
||
35367
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
535 |
olddocletapidocs: $(OLD_DOCLETAPI_INDEX_FILE) |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
536 |
|
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
537 |
# Set relative location to core api document root |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
538 |
$(OLD_DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(OLD_DOCLETAPI2COREAPI)/.. |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
539 |
|
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
540 |
# Run javadoc if the index file is out of date or missing |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
541 |
$(OLD_DOCLETAPI_INDEX_FILE): $(OLD_DOCLETAPI_OPTIONS_FILE) $(OLD_DOCLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
542 |
$(prep-javadoc) |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
543 |
$(call JavadocSummary,$(OLD_DOCLETAPI_OPTIONS_FILE),$(OLD_DOCLETAPI_PACKAGES_FILE)) |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
544 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
545 |
@$(OLD_DOCLETAPI_OPTIONS_FILE) @$(OLD_DOCLETAPI_PACKAGES_FILE) |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
546 |
|
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
547 |
# Create file with javadoc options in it |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
548 |
$(OLD_DOCLETAPI_OPTIONS_FILE): |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
549 |
$(prep-target) |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
550 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
551 |
$(call COMMON_JAVADOCTAGS) ; \ |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
552 |
$(call OptionOnly,-Xdoclint:all) ; \ |
36506 | 553 |
$(call OptionPair,-system,none) ; \ |
554 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
555 |
$(call OptionPair,-addmods,$(OLD_DOCLETAPI_MODULES)) ; \ |
|
35367
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
556 |
$(call OptionPair,-encoding,ascii) ; \ |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
557 |
$(call OptionOnly,-breakiterator) ; \ |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
558 |
$(call OptionPair,-doctitle,$(OLD_DOCLETAPI_DOCTITLE)) ; \ |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
559 |
$(call OptionPair,-windowtitle,$(OLD_DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
560 |
$(call OptionPair,-header,$(OLD_DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \ |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
561 |
$(call OptionPair,-bottom,$(OLD_DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
562 |
$(call OptionTrip,-group,$(OLD_DOCLETAPI_GROUPNAME),$(OLD_DOCLETAPI_REGEXP)); \ |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
563 |
$(call OptionTrip,-linkoffline,$(OLD_DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
564 |
) >> $@ |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
565 |
|
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
566 |
# Create a file with the package names in it |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
567 |
$(OLD_DOCLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(OLD_DOCLETAPI_PKGS)) |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
568 |
$(prep-target) |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
569 |
$(call PackageFilter,$(OLD_DOCLETAPI_PKGS)) |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
570 |
|
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
571 |
############################################################# |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
572 |
# |
13697 | 573 |
# tagletapidocs |
574 |
# |
|
575 |
||
576 |
ALL_OTHER_TARGETS += tagletapidocs |
|
35367
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
577 |
TAGLETAPI_DOCDIR := $(OLD_DOCLET_DIR)/taglet |
48968f91bab4
8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents:
33934
diff
changeset
|
578 |
TAGLETAPI2COREAPI := ../../../$(JDKJRE2COREAPI) |
39930
c35da27e81c2
8039305: [javadoc] broken link in jdk/api/javadoc/taglet/com/sun/tools/doclets/Taglet.html
ksrini
parents:
39609
diff
changeset
|
579 |
TAGLETAPI_DOCTITLE := Taglet API |
c35da27e81c2
8039305: [javadoc] broken link in jdk/api/javadoc/taglet/com/sun/tools/doclets/Taglet.html
ksrini
parents:
39609
diff
changeset
|
580 |
TAGLETAPI_WINDOWTITLE := Taglet API |
c35da27e81c2
8039305: [javadoc] broken link in jdk/api/javadoc/taglet/com/sun/tools/doclets/Taglet.html
ksrini
parents:
39609
diff
changeset
|
581 |
TAGLETAPI_HEADER := <strong>Taglet API</strong> |
20363 | 582 |
TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR)) |
13697 | 583 |
# TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk |
584 |
||
585 |
# The index.html, options, and packages files |
|
39930
c35da27e81c2
8039305: [javadoc] broken link in jdk/api/javadoc/taglet/com/sun/tools/doclets/Taglet.html
ksrini
parents:
39609
diff
changeset
|
586 |
TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/index.html |
20363 | 587 |
TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options |
13697 | 588 |
TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages |
589 |
||
36506 | 590 |
# The modules required to be documented |
591 |
TAGLETAPI_MODULES = jdk.javadoc |
|
592 |
||
13697 | 593 |
tagletapidocs: $(TAGLETAPI_INDEX_FILE) |
594 |
||
595 |
# 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
|
596 |
$(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 597 |
$(prep-javadoc) |
598 |
$(call JavadocSummary,$(TAGLETAPI_OPTIONS_FILE),$(TAGLETAPI_PACKAGES_FILE)) |
|
39930
c35da27e81c2
8039305: [javadoc] broken link in jdk/api/javadoc/taglet/com/sun/tools/doclets/Taglet.html
ksrini
parents:
39609
diff
changeset
|
599 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
20363 | 600 |
@$(TAGLETAPI_OPTIONS_FILE) @$(TAGLETAPI_PACKAGES_FILE) |
13697 | 601 |
|
602 |
# Create file with javadoc options in it |
|
603 |
$(TAGLETAPI_OPTIONS_FILE): |
|
604 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
605 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
606 |
$(call COMMON_JAVADOCTAGS) ; \ |
25043
b5598c2ddf6f
8048302: Update bug reporting URL in make/Javadoc.gmk
darcy
parents:
24232
diff
changeset
|
607 |
$(call OptionOnly,-Xdoclint:all) ; \ |
36506 | 608 |
$(call OptionPair,-system,none) ; \ |
609 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
610 |
$(call OptionPair,-addmods,$(TAGLETAPI_MODULES)) ; \ |
|
20363 | 611 |
$(call OptionPair,-encoding,ascii) ; \ |
39930
c35da27e81c2
8039305: [javadoc] broken link in jdk/api/javadoc/taglet/com/sun/tools/doclets/Taglet.html
ksrini
parents:
39609
diff
changeset
|
612 |
$(call OptionOnly,-breakiterator) ; \ |
c35da27e81c2
8039305: [javadoc] broken link in jdk/api/javadoc/taglet/com/sun/tools/doclets/Taglet.html
ksrini
parents:
39609
diff
changeset
|
613 |
$(call OptionPair,-doctitle,$(TAGLETAPI_DOCTITLE)) ; \ |
c35da27e81c2
8039305: [javadoc] broken link in jdk/api/javadoc/taglet/com/sun/tools/doclets/Taglet.html
ksrini
parents:
39609
diff
changeset
|
614 |
$(call OptionPair,-windowtitle,$(TAGLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
c35da27e81c2
8039305: [javadoc] broken link in jdk/api/javadoc/taglet/com/sun/tools/doclets/Taglet.html
ksrini
parents:
39609
diff
changeset
|
615 |
$(call OptionPair,-header,$(TAGLETAPI_HEADER)$(DRAFT_HEADER)) ; \ |
20363 | 616 |
$(call OptionOnly,-nonavbar) ; \ |
617 |
$(call OptionOnly,-noindex) ; \ |
|
618 |
$(call OptionPair,-bottom,$(TAGLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 619 |
$(call OptionTrip,-linkoffline,$(TAGLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
20363 | 620 |
) >> $@ |
13697 | 621 |
|
622 |
# 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
|
623 |
$(TAGLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(TAGLETAPI_PKGS)) |
13697 | 624 |
$(prep-target) |
25854 | 625 |
@($(ECHO) "$(LANGTOOLS_TOPDIR)/src/jdk.javadoc/share/classes/$(TAGLETAPI_FILE)" ) > $@ |
13697 | 626 |
|
627 |
############################################################# |
|
628 |
# |
|
629 |
# domapidocs |
|
630 |
# |
|
631 |
||
632 |
ALL_OTHER_TARGETS += domapidocs |
|
633 |
||
20363 | 634 |
DOMAPI_DOCDIR := $(JRE_API_DOCSDIR)/plugin/dom |
635 |
DOMAPI2COREAPI := ../../$(JDKJRE2COREAPI) |
|
636 |
DOMAPI_DOCTITLE := Common DOM API |
|
637 |
DOMAPI_WINDOWTITLE := Common DOM API |
|
638 |
DOMAPI_HEADER := <strong>Common DOM API</strong> |
|
639 |
DOMAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOMAPI_FIRST_COPYRIGHT_YEAR)) |
|
640 |
DOMAPI_GROUPNAME := Packages |
|
25045
7b8a6a85baa4
8044063: Remove com.sun.java.browser.* from jdk repo
mchung
parents:
24232
diff
changeset
|
641 |
DOMAPI_REGEXP := org.w3c.dom* |
13697 | 642 |
# DOMAPI_PKGS is located in NON_CORE_PKGS.gmk |
643 |
||
644 |
# The index.html, options, and packages files |
|
20363 | 645 |
DOMAPI_INDEX_FILE = $(DOMAPI_DOCDIR)/index.html |
646 |
DOMAPI_OPTIONS_FILE = $(DOCSTMPDIR)/domapi.options |
|
13697 | 647 |
DOMAPI_PACKAGES_FILE = $(DOCSTMPDIR)/domapi.packages |
648 |
||
36506 | 649 |
# The modules required to be documented |
650 |
DOMAPI_MODULES = java.xml,jdk.xml.dom |
|
651 |
||
13697 | 652 |
domapidocs: $(DOMAPI_INDEX_FILE) |
653 |
||
654 |
# Set relative location to core api document root |
|
655 |
$(DOMAPI_INDEX_FILE): GET2DOCSDIR=$(DOMAPI2COREAPI)/.. |
|
656 |
||
657 |
# 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
|
658 |
$(DOMAPI_INDEX_FILE): $(DOMAPI_OPTIONS_FILE) $(DOMAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 659 |
$(prep-javadoc) |
660 |
$(call JavadocSummary,$(DOMAPI_OPTIONS_FILE),$(DOMAPI_PACKAGES_FILE)) |
|
29176
45baf3cdc876
8074395: Random build failures in javadoc on Solaris
erikj
parents:
28010
diff
changeset
|
661 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
20363 | 662 |
@$(DOMAPI_OPTIONS_FILE) @$(DOMAPI_PACKAGES_FILE) |
13697 | 663 |
|
664 |
# Create file with javadoc options in it |
|
665 |
$(DOMAPI_OPTIONS_FILE): |
|
666 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
667 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
668 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
669 |
$(call OptionOnly,-Xdoclint:none) ; \ |
36506 | 670 |
$(call OptionPair,-system,none) ; \ |
671 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
672 |
$(call OptionPair,-addmods,$(DOMAPI_MODULES)) ; \ |
|
20363 | 673 |
$(call OptionPair,-encoding,ascii) ; \ |
674 |
$(call OptionOnly,-splitIndex) ; \ |
|
675 |
$(call OptionPair,-doctitle,$(DOMAPI_DOCTITLE)) ; \ |
|
676 |
$(call OptionPair,-windowtitle,$(DOMAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
|
677 |
$(call OptionPair,-header,$(DOMAPI_HEADER)$(DRAFT_HEADER)) ; \ |
|
678 |
$(call OptionPair,-bottom,$(DOMAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 679 |
$(call OptionTrip,-group,$(DOMAPI_GROUPNAME),$(DOMAPI_REGEXP)); \ |
680 |
$(call OptionTrip,-linkoffline,$(DOMAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
|
20363 | 681 |
) >> $@ |
13697 | 682 |
|
683 |
# 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
|
684 |
$(DOMAPI_PACKAGES_FILE): $(call PackageDependencies,$(DOMAPI_PKGS)) |
13697 | 685 |
$(prep-target) |
686 |
$(call PackageFilter,$(DOMAPI_PKGS)) |
|
687 |
||
688 |
############################################################# |
|
689 |
# |
|
690 |
# jpdadocs |
|
691 |
# |
|
692 |
||
693 |
ALL_OTHER_TARGETS += jpdadocs |
|
694 |
||
695 |
jpdadocs: jdidocs jdwpdocs jvmtidocs |
|
696 |
||
697 |
############################################################# |
|
698 |
# |
|
699 |
# jdidocs |
|
700 |
# |
|
701 |
||
702 |
ALL_OTHER_TARGETS += jdidocs |
|
703 |
||
20363 | 704 |
JDI_DOCDIR := $(JDK_API_DOCSDIR)/jpda/jdi |
705 |
JDI2COREAPI := ../../$(JDKJRE2COREAPI) |
|
706 |
JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface |
|
13697 | 707 |
JDI_WINDOWTITLE := Java Debug Interface |
20363 | 708 |
JDI_HEADER := <strong>Java Debug Interface</strong> |
709 |
JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR)) |
|
25854 | 710 |
JDI_OVERVIEW := $(JDK_TOPDIR)/src/jdk.jdi/share/classes/jdi-overview.html |
13697 | 711 |
# JDI_PKGS is located in NON_CORE_PKGS.gmk |
712 |
||
713 |
# The index.html, options, and packages files |
|
20363 | 714 |
JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html |
715 |
JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options |
|
13697 | 716 |
JDI_PACKAGES_FILE = $(DOCSTMPDIR)/jdi.packages |
717 |
||
36506 | 718 |
# The modules required to be documented |
719 |
JDI_MODULES = jdk.jdi |
|
720 |
||
13697 | 721 |
jdidocs: $(JDI_INDEX_FILE) |
722 |
||
723 |
# Set relative location to core api document root |
|
724 |
$(JDI_INDEX_FILE): GET2DOCSDIR=$(JDI2COREAPI)/.. |
|
725 |
||
726 |
# 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
|
727 |
$(JDI_INDEX_FILE): $(JDI_OPTIONS_FILE) $(JDI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 728 |
$(prep-javadoc) |
729 |
$(call JavadocSummary,$(JDI_OPTIONS_FILE),$(JDI_PACKAGES_FILE)) |
|
29176
45baf3cdc876
8074395: Random build failures in javadoc on Solaris
erikj
parents:
28010
diff
changeset
|
730 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
20363 | 731 |
@$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE) |
13697 | 732 |
|
733 |
# Create file with javadoc options in it |
|
734 |
$(JDI_OPTIONS_FILE): $(JDI_OVERVIEW) |
|
735 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
736 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
737 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
738 |
$(call OptionOnly,-Xdoclint:none) ; \ |
36506 | 739 |
$(call OptionPair,-system,none) ; \ |
740 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
741 |
$(call OptionPair,-addmods,$(JDI_MODULES)) ; \ |
|
20363 | 742 |
$(call OptionPair,-encoding,ascii) ; \ |
743 |
$(call OptionPair,-overview,$(JDI_OVERVIEW)) ; \ |
|
744 |
$(call OptionPair,-doctitle,$(JDI_DOCTITLE)) ; \ |
|
13697 | 745 |
$(call OptionPair,-windowtitle,$(JDI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
20363 | 746 |
$(call OptionPair,-header,$(JDI_HEADER)$(DRAFT_HEADER)) ; \ |
747 |
$(call OptionPair,-bottom,$(JDI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 748 |
$(call OptionTrip,-linkoffline,$(JDI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
20363 | 749 |
) >> $@ |
13697 | 750 |
|
751 |
# 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
|
752 |
$(JDI_PACKAGES_FILE): $(call PackageDependencies,$(JDI_PKGS)) |
13697 | 753 |
$(prep-target) |
754 |
$(call PackageFilter,$(JDI_PKGS)) |
|
755 |
||
756 |
############################################################# |
|
757 |
# |
|
758 |
# jdwpdocs |
|
759 |
# |
|
760 |
||
761 |
ALL_OTHER_TARGETS += jdwpdocs |
|
762 |
||
20363 | 763 |
JDWP_DOCDIR = $(PLATFORM_DOCSDIR)/jpda/jdwp |
13697 | 764 |
|
765 |
jdwpdocs: $(JDWP_DOCDIR)/jdwp-protocol.html |
|
27560 | 766 |
$(JDWP_DOCDIR)/jdwp-protocol.html : $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html |
13697 | 767 |
$(MKDIR) -p $(@D) |
768 |
$(RM) $@ |
|
769 |
$(CP) $< $@ |
|
770 |
||
771 |
############################################################# |
|
772 |
# |
|
773 |
# jvmtidocs |
|
774 |
# |
|
775 |
||
776 |
ALL_OTHER_TARGETS += jvmtidocs |
|
777 |
||
20363 | 778 |
JVMTI_DOCDIR = $(PLATFORM_DOCSDIR)/jvmti |
779 |
JVMTI_HTML = $(HOTSPOT_DIST)/docs/platform/jvmti/jvmti.html |
|
13697 | 780 |
|
20363 | 781 |
jvmtidocs: $(JVMTI_DOCDIR)/jvmti.html |
13697 | 782 |
$(JVMTI_DOCDIR)/jvmti.html: |
783 |
@$(prep-javadoc) |
|
20363 | 784 |
@if [ -f $(JVMTI_HTML) ] ; then \ |
785 |
$(CP) $(JVMTI_HTML) $@; \ |
|
786 |
else \ |
|
13697 | 787 |
$(ECHO) "WARNING: Generated file does not exist: $(JVMTI_HTML)"; \ |
788 |
fi |
|
789 |
||
790 |
############################################################# |
|
791 |
# |
|
792 |
# jaasdocs |
|
793 |
# |
|
794 |
||
795 |
ALL_OTHER_TARGETS += jaasdocs |
|
796 |
||
20363 | 797 |
JAAS_DOCDIR := $(JRE_API_DOCSDIR)/security/jaas/spec |
798 |
JAAS2COREAPI := ../../../$(JDKJRE2COREAPI) |
|
799 |
JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service |
|
13697 | 800 |
JAAS_WINDOWTITLE := Java Authentication and Authorization Service |
20363 | 801 |
JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong> |
802 |
JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR)) |
|
13697 | 803 |
# JAAS_PKGS is located in NON_CORE_PKGS.gmk |
25854 | 804 |
JAAS_OVERVIEW := $(JDK_TOPDIR)/src/jdk.security.auth/share/classes/jaas-overview.html |
13697 | 805 |
|
806 |
# The index.html, options, and packages files |
|
20363 | 807 |
JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html |
808 |
JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options |
|
13697 | 809 |
JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages |
810 |
||
36506 | 811 |
# The modules required to be documented |
812 |
JAAS_MODULES = jdk.security.auth |
|
813 |
||
13697 | 814 |
jaasdocs: $(JAAS_INDEX_FILE) |
815 |
||
816 |
# Set relative location to core api document root |
|
817 |
$(JAAS_INDEX_FILE): GET2DOCSDIR=$(JAAS2COREAPI)/.. |
|
818 |
||
819 |
# 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
|
820 |
$(JAAS_INDEX_FILE): $(JAAS_OPTIONS_FILE) $(JAAS_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 821 |
$(prep-javadoc) |
822 |
$(call JavadocSummary,$(JAAS_OPTIONS_FILE),$(JAAS_PACKAGES_FILE)) |
|
29176
45baf3cdc876
8074395: Random build failures in javadoc on Solaris
erikj
parents:
28010
diff
changeset
|
823 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
20363 | 824 |
@$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE) |
13697 | 825 |
|
826 |
# Create file with javadoc options in it |
|
827 |
$(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW) |
|
828 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
829 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
830 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
831 |
$(call OptionOnly,-Xdoclint:none) ; \ |
36506 | 832 |
$(call OptionPair,-system,none) ; \ |
833 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
834 |
$(call OptionPair,-addmods,$(JAAS_MODULES)) ; \ |
|
20363 | 835 |
$(call OptionPair,-encoding,ascii) ; \ |
836 |
$(call OptionPair,-overview,$(JAAS_OVERVIEW)) ; \ |
|
837 |
$(call OptionPair,-doctitle,$(JAAS_DOCTITLE)) ; \ |
|
13697 | 838 |
$(call OptionPair,-windowtitle,$(JAAS_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
20363 | 839 |
$(call OptionPair,-header,$(JAAS_HEADER)$(DRAFT_HEADER)) ; \ |
840 |
$(call OptionPair,-bottom,$(JAAS_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 841 |
$(call OptionTrip,-linkoffline,$(JAAS2COREAPI),$(COREAPI_DOCSDIR)/); \ |
20363 | 842 |
) >> $@ |
13697 | 843 |
|
844 |
# 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
|
845 |
$(JAAS_PACKAGES_FILE): $(call PackageDependencies,$(JAAS_PKGS)) |
13697 | 846 |
$(prep-target) |
847 |
$(call PackageFilter,$(JAAS_PKGS)) |
|
848 |
||
849 |
############################################################# |
|
850 |
# |
|
851 |
# jgssdocs |
|
852 |
# |
|
853 |
||
854 |
ALL_OTHER_TARGETS += jgssdocs |
|
855 |
||
20363 | 856 |
JGSS_DOCDIR := $(JRE_API_DOCSDIR)/security/jgss/spec |
857 |
JGSS2COREAPI := ../../../$(JDKJRE2COREAPI) |
|
858 |
JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities |
|
13697 | 859 |
JGSS_WINDOWTITLE := Java GSS-API Utilities |
20363 | 860 |
JGSS_HEADER := <strong>Java GSS-API Utilities</strong> |
861 |
JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR)) |
|
25854 | 862 |
JGSS_OVERVIEW := $(JDK_TOPDIR)/src/java.security.jgss/share/classes/jgss-overview.html |
13697 | 863 |
# JGSS_PKGS is located in NON_CORE_PKGS.gmk |
864 |
||
865 |
# The index.html, options, and packages files |
|
20363 | 866 |
JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html |
867 |
JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options |
|
13697 | 868 |
JGSS_PACKAGES_FILE = $(DOCSTMPDIR)/jgss.packages |
869 |
||
36506 | 870 |
# The modules required to be documented |
871 |
JGSS_MODULES = jdk.security.jgss |
|
872 |
||
13697 | 873 |
jgssdocs: $(JGSS_INDEX_FILE) |
874 |
||
875 |
# Set relative location to core api document root |
|
876 |
$(JGSS_INDEX_FILE): GET2DOCSDIR=$(JGSS2COREAPI)/.. |
|
877 |
||
878 |
# 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
|
879 |
$(JGSS_INDEX_FILE): $(JGSS_OPTIONS_FILE) $(JGSS_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 880 |
$(prep-javadoc) |
881 |
$(call JavadocSummary,$(JGSS_OPTIONS_FILE),$(JGSS_PACKAGES_FILE)) |
|
29176
45baf3cdc876
8074395: Random build failures in javadoc on Solaris
erikj
parents:
28010
diff
changeset
|
882 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
20363 | 883 |
@$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE) |
13697 | 884 |
|
885 |
# Create file with javadoc options in it |
|
886 |
$(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW) |
|
887 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
888 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
889 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
890 |
$(call OptionOnly,-Xdoclint:none) ; \ |
36506 | 891 |
$(call OptionPair,-system,none) ; \ |
892 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
893 |
$(call OptionPair,-addmods,$(JGSS_MODULES)) ; \ |
|
20363 | 894 |
$(call OptionPair,-encoding,ascii) ; \ |
895 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
|
896 |
$(call OptionPair,-overview,$(JGSS_OVERVIEW)) ; \ |
|
897 |
$(call OptionPair,-doctitle,$(JGSS_DOCTITLE)) ; \ |
|
13697 | 898 |
$(call OptionPair,-windowtitle,$(JGSS_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
20363 | 899 |
$(call OptionPair,-header,$(JGSS_HEADER)$(DRAFT_HEADER)) ; \ |
900 |
$(call OptionPair,-bottom,$(JGSS_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 901 |
$(call OptionTrip,-linkoffline,$(JGSS2COREAPI),$(COREAPI_DOCSDIR)/); \ |
20363 | 902 |
) >> $@ |
13697 | 903 |
|
904 |
# 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
|
905 |
$(JGSS_PACKAGES_FILE): $(call PackageDependencies,$(JGSS_PKGS)) |
13697 | 906 |
$(prep-target) |
907 |
$(call PackageFilter,$(JGSS_PKGS)) |
|
908 |
||
909 |
############################################################# |
|
910 |
# |
|
911 |
# smartcardiodocs |
|
912 |
# |
|
913 |
||
914 |
ALL_OTHER_TARGETS += smartcardiodocs |
|
915 |
||
20363 | 916 |
SMARTCARDIO_DOCDIR := $(JRE_API_DOCSDIR)/security/smartcardio/spec |
917 |
SMARTCARDIO2COREAPI := ../../../$(JDKJRE2COREAPI) |
|
918 |
SMARTCARDIO_DOCTITLE := Java$(TRADEMARK) Smart Card I/O |
|
13697 | 919 |
SMARTCARDIO_WINDOWTITLE := Java Smart Card I/O |
20363 | 920 |
SMARTCARDIO_HEADER := <strong>Java Smart Card I/O</strong> |
921 |
SMARTCARDIO_BOTTOM := $(call CommonBottom,$(SMARTCARDIO_FIRST_COPYRIGHT_YEAR)) |
|
13697 | 922 |
# SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk |
923 |
||
924 |
# The index.html, options, and packages files |
|
20363 | 925 |
SMARTCARDIO_INDEX_FILE = $(SMARTCARDIO_DOCDIR)/index.html |
926 |
SMARTCARDIO_OPTIONS_FILE = $(DOCSTMPDIR)/smartcardio.options |
|
13697 | 927 |
SMARTCARDIO_PACKAGES_FILE = $(DOCSTMPDIR)/smartcardio.packages |
928 |
||
36506 | 929 |
# The modules required to be documented |
930 |
SMARTCARDIO_MODULES = java.smartcardio |
|
931 |
||
13697 | 932 |
smartcardiodocs: $(SMARTCARDIO_INDEX_FILE) |
933 |
||
934 |
# Set relative location to core api document root |
|
935 |
$(SMARTCARDIO_INDEX_FILE): GET2DOCSDIR=$(SMARTCARDIO2COREAPI)/.. |
|
936 |
||
937 |
# 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
|
938 |
$(SMARTCARDIO_INDEX_FILE): $(SMARTCARDIO_OPTIONS_FILE) $(SMARTCARDIO_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 939 |
$(prep-javadoc) |
940 |
$(call JavadocSummary,$(SMARTCARDIO_OPTIONS_FILE),$(SMARTCARDIO_PACKAGES_FILE)) |
|
29176
45baf3cdc876
8074395: Random build failures in javadoc on Solaris
erikj
parents:
28010
diff
changeset
|
941 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
20363 | 942 |
@$(SMARTCARDIO_OPTIONS_FILE) @$(SMARTCARDIO_PACKAGES_FILE) |
13697 | 943 |
|
944 |
# Create file with javadoc options in it |
|
945 |
$(SMARTCARDIO_OPTIONS_FILE): |
|
946 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
947 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
948 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
949 |
$(call OptionOnly,-Xdoclint:none) ; \ |
36506 | 950 |
$(call OptionPair,-system,none) ; \ |
951 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
952 |
$(call OptionPair,-addmods,$(SMARTCARDIO_MODULES)) ; \ |
|
20363 | 953 |
$(call OptionPair,-encoding,ascii) ; \ |
954 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
|
955 |
$(call OptionPair,-doctitle,$(SMARTCARDIO_DOCTITLE)) ; \ |
|
956 |
$(call OptionPair,-windowtitle,$(SMARTCARDIO_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
|
13697 | 957 |
$(call OptionPair,-header,$(SMARTCARDIO_HEADER)$(DRAFT_HEADER)); \ |
958 |
$(call OptionPair,-bottom,$(SMARTCARDIO_BOTTOM)$(DRAFT_BOTTOM)); \ |
|
959 |
$(call OptionTrip,-linkoffline,$(SMARTCARDIO2COREAPI),$(COREAPI_DOCSDIR)/); \ |
|
20363 | 960 |
) >> $@ |
13697 | 961 |
|
962 |
# 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
|
963 |
$(SMARTCARDIO_PACKAGES_FILE): $(call PackageDependencies,$(SMARTCARDIO_PKGS)) |
13697 | 964 |
$(prep-target) |
965 |
$(call PackageFilter,$(SMARTCARDIO_PKGS)) |
|
966 |
||
967 |
############################################################# |
|
968 |
# |
|
969 |
# httpserverdocs |
|
970 |
# |
|
971 |
||
972 |
ALL_OTHER_TARGETS += httpserverdocs |
|
973 |
||
20363 | 974 |
HTTPSERVER_DOCDIR := $(JRE_API_DOCSDIR)/net/httpserver/spec |
975 |
HTTPSERVER2COREAPI := ../../../$(JDKJRE2COREAPI) |
|
976 |
HTTPSERVER_DOCTITLE := Java$(TRADEMARK) HTTP Server |
|
13697 | 977 |
HTTPSERVER_WINDOWTITLE := Java HTTP Server |
20363 | 978 |
HTTPSERVER_HEADER := <strong>Java HTTP Server</strong> |
979 |
HTTPSERVER_BOTTOM := $(call CommonBottom,$(HTTPSERVER_FIRST_COPYRIGHT_YEAR)) |
|
13697 | 980 |
# HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk |
981 |
||
20363 | 982 |
HTTPSERVER_INDEX_HTML = $(HTTPSERVER_DOCDIR)/index.html |
983 |
HTTPSERVER_OPTIONS_FILE = $(DOCSTMPDIR)/httpserver.options |
|
13697 | 984 |
HTTPSERVER_PACKAGES_FILE = $(DOCSTMPDIR)/httpserver.packages |
985 |
||
36506 | 986 |
# The modules required to be documented |
987 |
HTTPSERVER_MODULES = jdk.httpserver |
|
988 |
||
13697 | 989 |
httpserverdocs: $(HTTPSERVER_INDEX_HTML) |
990 |
||
991 |
# Set relative location to core api document root |
|
992 |
$(HTTPSERVER_INDEX_HTML): GET2DOCSDIR=$(HTTPSERVER2COREAPI)/.. |
|
993 |
||
994 |
# 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
|
995 |
$(HTTPSERVER_INDEX_HTML): $(HTTPSERVER_OPTIONS_FILE) $(HTTPSERVER_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 996 |
$(prep-javadoc) |
997 |
$(call JavadocSummary,$(HTTPSERVER_OPTIONS_FILE),$(HTTPSERVER_PACKAGES_FILE)) |
|
29176
45baf3cdc876
8074395: Random build failures in javadoc on Solaris
erikj
parents:
28010
diff
changeset
|
998 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
20363 | 999 |
@$(HTTPSERVER_OPTIONS_FILE) @$(HTTPSERVER_PACKAGES_FILE) |
13697 | 1000 |
|
1001 |
# Create file with javadoc options in it |
|
1002 |
$(HTTPSERVER_OPTIONS_FILE): |
|
1003 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1004 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1005 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
1006 |
$(call OptionOnly,-Xdoclint:none) ; \ |
36506 | 1007 |
$(call OptionPair,-system,none) ; \ |
1008 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
1009 |
$(call OptionPair,-addmods,$(HTTPSERVER_MODULES)) ; \ |
|
20363 | 1010 |
$(call OptionPair,-encoding,ascii) ; \ |
1011 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
|
1012 |
$(call OptionPair,-doctitle,$(HTTPSERVER_DOCTITLE)) ; \ |
|
1013 |
$(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
|
13697 | 1014 |
$(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \ |
1015 |
$(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \ |
|
1016 |
$(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \ |
|
20363 | 1017 |
) >> $@ |
13697 | 1018 |
|
1019 |
# 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
|
1020 |
$(HTTPSERVER_PACKAGES_FILE): $(call PackageDependencies,$(HTTPSERVER_PKGS)) |
13697 | 1021 |
$(prep-target) |
1022 |
$(call PackageFilter,$(HTTPSERVER_PKGS)) |
|
1023 |
||
1024 |
############################################################# |
|
1025 |
# |
|
39932
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1026 |
# jsobjectdocs |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1027 |
# |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1028 |
|
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1029 |
ALL_OTHER_TARGETS += jsobjectdocs |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1030 |
|
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1031 |
JSOBJECT_DOCDIR := $(JRE_API_DOCSDIR)/plugin/jsobject |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1032 |
JSOBJECT2COREAPI := ../../$(JDKJRE2COREAPI) |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1033 |
JSOBJECT_DOCTITLE := Java$(TRADEMARK) JSObject Doc |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1034 |
JSOBJECT_WINDOWTITLE := Java JSObject Doc |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1035 |
JSOBJECT_HEADER := <strong>Java JSObject Doc</strong> |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1036 |
JSOBJECT_BOTTOM := $(call CommonBottom,$(JSOBJECT_FIRST_COPYRIGHT_YEAR)) |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1037 |
# JSOBJECT_PKGS is located in NON_CORE_PKGS.gmk |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1038 |
|
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1039 |
JSOBJECT_INDEX_HTML = $(JSOBJECT_DOCDIR)/index.html |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1040 |
JSOBJECT_OPTIONS_FILE = $(DOCSTMPDIR)/jsobject.options |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1041 |
JSOBJECT_PACKAGES_FILE = $(DOCSTMPDIR)/jsobject.packages |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1042 |
|
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1043 |
# The modules required to be documented |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1044 |
JSOBJECT_MODULES = jdk.jsobject |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1045 |
|
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1046 |
jsobjectdocs: $(JSOBJECT_INDEX_HTML) |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1047 |
|
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1048 |
# Set relative location to core api document root |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1049 |
$(JSOBJECT_INDEX_HTML): GET2DOCSDIR=$(JSOBJECT2COREAPI)/.. |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1050 |
|
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1051 |
# Run javadoc if the index file is out of date or missing |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1052 |
$(JSOBJECT_INDEX_HTML): $(JSOBJECT_OPTIONS_FILE) $(JSOBJECT_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1053 |
$(prep-javadoc) |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1054 |
$(call JavadocSummary,$(JSOBJECT_OPTIONS_FILE),$(JSOBJECT_PACKAGES_FILE)) |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1055 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1056 |
@$(JSOBJECT_OPTIONS_FILE) @$(JSOBJECT_PACKAGES_FILE) |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1057 |
|
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1058 |
# Create file with javadoc options in it |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1059 |
$(JSOBJECT_OPTIONS_FILE): |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1060 |
$(prep-target) |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1061 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1062 |
$(call COMMON_JAVADOCTAGS) ; \ |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1063 |
$(call OptionOnly,-Xdoclint:none) ; \ |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1064 |
$(call OptionPair,-system,none) ; \ |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1065 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1066 |
$(call OptionPair,-addmods,$(JSOBJECT_MODULES)) ; \ |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1067 |
$(call OptionPair,-encoding,ascii) ; \ |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1068 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1069 |
$(call OptionPair,-doctitle,$(JSOBJECT_DOCTITLE)) ; \ |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1070 |
$(call OptionPair,-windowtitle,$(JSOBJECT_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1071 |
$(call OptionPair,-header,$(JSOBJECT_HEADER)$(DRAFT_HEADER)); \ |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1072 |
$(call OptionPair,-bottom,$(JSOBJECT_BOTTOM)$(DRAFT_BOTTOM)); \ |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1073 |
$(call OptionTrip,-linkoffline,$(JSOBJECT2COREAPI),$(COREAPI_DOCSDIR)/); \ |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1074 |
) >> $@ |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1075 |
|
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1076 |
# Create a file with the package names in it |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1077 |
$(JSOBJECT_PACKAGES_FILE): $(call PackageDependencies,$(JSOBJECT_PKGS)) |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1078 |
$(prep-target) |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1079 |
$(call PackageFilter,$(JSOBJECT_PKGS)) |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1080 |
|
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1081 |
|
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1082 |
############################################################# |
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1083 |
# |
13697 | 1084 |
# mgmtdocs |
1085 |
# |
|
1086 |
||
1087 |
ALL_OTHER_TARGETS += mgmtdocs |
|
1088 |
||
20363 | 1089 |
MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension |
1090 |
MGMT2COREAPI := ../../$(JDKJRE2COREAPI) |
|
1091 |
MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform |
|
13697 | 1092 |
MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform |
20363 | 1093 |
MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong> |
1094 |
MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR)) |
|
25854 | 1095 |
MGMT_OVERVIEW := $(JDK_TOPDIR)/src/java.management/share/classes/mgmt-overview.html |
13697 | 1096 |
# MGMT_PKGS is located in NON_CORE_PKGS.gmk |
1097 |
||
1098 |
# The index.html, options, and packages files |
|
20363 | 1099 |
MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html |
1100 |
MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options |
|
13697 | 1101 |
MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages |
1102 |
||
36506 | 1103 |
# The modules required to be documented |
1104 |
MGMT_MODULES = jdk.management |
|
1105 |
||
13697 | 1106 |
mgmtdocs: $(MGMT_INDEX_FILE) |
1107 |
||
1108 |
# Set relative location to core api document root |
|
1109 |
$(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/.. |
|
1110 |
||
1111 |
# 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
|
1112 |
$(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 1113 |
$(prep-javadoc) |
1114 |
$(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE)) |
|
29176
45baf3cdc876
8074395: Random build failures in javadoc on Solaris
erikj
parents:
28010
diff
changeset
|
1115 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
20363 | 1116 |
@$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE) |
13697 | 1117 |
|
1118 |
# Create file with javadoc options in it |
|
1119 |
$(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW) |
|
1120 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1121 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1122 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
1123 |
$(call OptionOnly,-Xdoclint:none) ; \ |
36506 | 1124 |
$(call OptionPair,-system,none) ; \ |
1125 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
1126 |
$(call OptionPair,-addmods,$(MGMT_MODULES)) ; \ |
|
20363 | 1127 |
$(call OptionPair,-encoding,ascii) ; \ |
1128 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
|
1129 |
$(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \ |
|
1130 |
$(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \ |
|
13697 | 1131 |
$(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
20363 | 1132 |
$(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \ |
1133 |
$(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 1134 |
$(call OptionTrip,-linkoffline,$(MGMT2COREAPI),$(COREAPI_DOCSDIR)/); \ |
20363 | 1135 |
) >> $@ |
13697 | 1136 |
|
1137 |
# 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
|
1138 |
$(MGMT_PACKAGES_FILE): $(call PackageDependencies,$(MGMT_PKGS)) |
13697 | 1139 |
$(prep-target) |
1140 |
$(call PackageFilter,$(MGMT_PKGS)) |
|
1141 |
||
1142 |
############################################################# |
|
1143 |
# |
|
1144 |
# attachdocs |
|
1145 |
# |
|
1146 |
||
1147 |
ALL_OTHER_TARGETS += attachdocs |
|
1148 |
||
20363 | 1149 |
ATTACH_DOCDIR := $(JDK_API_DOCSDIR)/attach/spec |
1150 |
ATTACH2COREAPI := ../../$(JDKJRE2COREAPI) |
|
1151 |
ATTACH_DOCTITLE := Attach API |
|
13697 | 1152 |
ATTACH_WINDOWTITLE := Attach API |
20363 | 1153 |
ATTACH_HEADER := <strong>Attach API</strong> |
1154 |
ATTACH_BOTTOM := $(call CommonBottom,$(ATTACH_FIRST_COPYRIGHT_YEAR)) |
|
13697 | 1155 |
# ATTACH_PKGS is located in NON_CORE_PKGS.gmk |
1156 |
||
20363 | 1157 |
ATTACH_INDEX_HTML = $(ATTACH_DOCDIR)/index.html |
1158 |
ATTACH_OPTIONS_FILE = $(DOCSTMPDIR)/attach.options |
|
13697 | 1159 |
ATTACH_PACKAGES_FILE = $(DOCSTMPDIR)/attach.packages |
1160 |
||
36506 | 1161 |
# The modules required to be documented |
1162 |
ATTACH_MODULES = jdk.attach |
|
1163 |
||
13697 | 1164 |
attachdocs: $(ATTACH_INDEX_HTML) |
1165 |
||
1166 |
# Set relative location to core api document root |
|
1167 |
$(ATTACH_INDEX_HTML): GET2DOCSDIR=$(ATTACH2COREAPI)/.. |
|
1168 |
||
1169 |
# 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
|
1170 |
$(ATTACH_INDEX_HTML): $(ATTACH_OPTIONS_FILE) $(ATTACH_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 1171 |
$(prep-javadoc) |
1172 |
$(call JavadocSummary,$(ATTACH_OPTIONS_FILE),$(ATTACH_PACKAGES_FILE)) |
|
29176
45baf3cdc876
8074395: Random build failures in javadoc on Solaris
erikj
parents:
28010
diff
changeset
|
1173 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
20363 | 1174 |
@$(ATTACH_OPTIONS_FILE) @$(ATTACH_PACKAGES_FILE) |
13697 | 1175 |
|
1176 |
# Create file with javadoc options in it |
|
1177 |
$(ATTACH_OPTIONS_FILE): |
|
1178 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1179 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1180 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
1181 |
$(call OptionOnly,-Xdoclint:none) ; \ |
36506 | 1182 |
$(call OptionPair,-system,none) ; \ |
1183 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
1184 |
$(call OptionPair,-addmods,$(ATTACH_MODULES)) ; \ |
|
20363 | 1185 |
$(call OptionPair,-encoding,ascii) ; \ |
1186 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
|
1187 |
$(call OptionPair,-doctitle,$(ATTACH_DOCTITLE)) ; \ |
|
1188 |
$(call OptionPair,-windowtitle,$(ATTACH_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
|
1189 |
$(call OptionPair,-header,$(ATTACH_HEADER)$(DRAFT_HEADER)) ; \ |
|
1190 |
$(call OptionPair,-bottom,$(ATTACH_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 1191 |
$(call OptionTrip,-linkoffline,$(ATTACH2COREAPI),$(COREAPI_DOCSDIR)/); \ |
20363 | 1192 |
) >> $@ |
13697 | 1193 |
|
1194 |
# 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
|
1195 |
$(ATTACH_PACKAGES_FILE): $(call PackageDependencies,$(ATTACH_PKGS)) |
13697 | 1196 |
$(prep-target) |
1197 |
$(call PackageFilter,$(ATTACH_PKGS)) |
|
1198 |
||
1199 |
############################################################# |
|
1200 |
# |
|
1201 |
# jconsoledocs |
|
1202 |
# |
|
1203 |
||
1204 |
ALL_OTHER_TARGETS += jconsoledocs |
|
1205 |
||
20363 | 1206 |
JCONSOLE_DOCDIR := $(JDK_API_DOCSDIR)/jconsole/spec |
1207 |
JCONSOLE2COREAPI := ../../$(JDKJRE2COREAPI) |
|
1208 |
JCONSOLE_DOCTITLE := JConsole API |
|
13697 | 1209 |
JCONSOLE_WINDOWTITLE := JConsole API |
20363 | 1210 |
JCONSOLE_HEADER := <strong>JConsole API</strong> |
1211 |
JCONSOLE_BOTTOM := $(call CommonBottom,$(JCONSOLE_FIRST_COPYRIGHT_YEAR)) |
|
13697 | 1212 |
# JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk |
1213 |
||
20363 | 1214 |
JCONSOLE_INDEX_HTML = $(JCONSOLE_DOCDIR)/index.html |
1215 |
JCONSOLE_OPTIONS_FILE = $(DOCSTMPDIR)/jconsole.options |
|
13697 | 1216 |
JCONSOLE_PACKAGES_FILE = $(DOCSTMPDIR)/jconsole.packages |
1217 |
||
36506 | 1218 |
# The modules required to be documented |
1219 |
JCONSOLE_MODULES = jdk.jconsole |
|
1220 |
||
13697 | 1221 |
jconsoledocs: $(JCONSOLE_INDEX_HTML) |
1222 |
||
1223 |
# Set relative location to core api document root |
|
1224 |
$(JCONSOLE_INDEX_HTML): GET2DOCSDIR=$(JCONSOLE2COREAPI)/.. |
|
1225 |
||
1226 |
# 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
|
1227 |
$(JCONSOLE_INDEX_HTML): $(JCONSOLE_OPTIONS_FILE) $(JCONSOLE_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 1228 |
$(prep-javadoc) |
1229 |
$(call JavadocSummary,$(JCONSOLE_OPTIONS_FILE),$(JCONSOLE_PACKAGES_FILE)) |
|
29176
45baf3cdc876
8074395: Random build failures in javadoc on Solaris
erikj
parents:
28010
diff
changeset
|
1230 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
20363 | 1231 |
@$(JCONSOLE_OPTIONS_FILE) @$(JCONSOLE_PACKAGES_FILE) |
13697 | 1232 |
|
1233 |
# Create file with javadoc options in it |
|
1234 |
$(JCONSOLE_OPTIONS_FILE): |
|
1235 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1236 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1237 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
1238 |
$(call OptionOnly,-Xdoclint:none) ; \ |
36506 | 1239 |
$(call OptionPair,-system,none) ; \ |
1240 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
1241 |
$(call OptionPair,-addmods,$(JCONSOLE_MODULES)) ; \ |
|
20363 | 1242 |
$(call OptionPair,-encoding,ascii) ; \ |
1243 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
|
1244 |
$(call OptionPair,-doctitle,$(JCONSOLE_DOCTITLE)) ; \ |
|
1245 |
$(call OptionPair,-windowtitle,$(JCONSOLE_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
|
1246 |
$(call OptionPair,-header,$(JCONSOLE_HEADER)$(DRAFT_HEADER)) ; \ |
|
1247 |
$(call OptionPair,-bottom,$(JCONSOLE_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 1248 |
$(call OptionTrip,-linkoffline,$(JCONSOLE2COREAPI),$(COREAPI_DOCSDIR)/); \ |
20363 | 1249 |
) >> $@ |
13697 | 1250 |
|
1251 |
# 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
|
1252 |
$(JCONSOLE_PACKAGES_FILE): $(call PackageDependencies,$(JCONSOLE_PKGS)) |
13697 | 1253 |
$(prep-target) |
1254 |
$(call PackageFilter,$(JCONSOLE_PKGS)) |
|
1255 |
||
1256 |
############################################################# |
|
1257 |
# |
|
36792
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1258 |
# jshellapidocs |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1259 |
# |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1260 |
|
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1261 |
ALL_OTHER_TARGETS += jshellapidocs |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1262 |
|
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1263 |
JSHELLAPI_DOCDIR := $(JDK_API_DOCSDIR)/jshell |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1264 |
JSHELLAPI2COREAPI := ../../$(JDKJRE2COREAPI) |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1265 |
JSHELLAPI_DOCTITLE := JShell API |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1266 |
JSHELLAPI_WINDOWTITLE := JShell API |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1267 |
JSHELLAPI_HEADER := <strong>JSHELL API</strong> |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1268 |
JSHELLAPI_BOTTOM := $(call CommonBottom,$(JSHELLAPI_FIRST_COPYRIGHT_YEAR)) |
39381
e323aa93ee46
8160009: JShell: Add SPI and execution to generated JShell javadoc (root ws)
rfield
parents:
39113
diff
changeset
|
1269 |
JSHELLAPI_OVERVIEW := $(LANGTOOLS_TOPDIR)/src/jdk.jshell/share/classes/jdk/jshell/overview.html |
36792
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1270 |
# JSHELLAPI_PKGS is located in NON_CORE_PKGS.gmk |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1271 |
|
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1272 |
JSHELLAPI_INDEX_HTML = $(JSHELLAPI_DOCDIR)/index.html |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1273 |
JSHELLAPI_OPTIONS_FILE = $(DOCSTMPDIR)/jshellapi.options |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1274 |
JSHELLAPI_PACKAGES_FILE = $(DOCSTMPDIR)/jshellapi.packages |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1275 |
|
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1276 |
# The modules required to be documented |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1277 |
JSHELLAPI_MODULES = jdk.jshell |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1278 |
|
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1279 |
jshellapidocs: $(JSHELLAPI_INDEX_HTML) |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1280 |
|
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1281 |
# Set relative location to core api document root |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1282 |
$(JSHELLAPI_INDEX_HTML): GET2DOCSDIR=$(JSHELLAPI2COREAPI)/.. |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1283 |
|
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1284 |
# Run javadoc if the index file is out of date or missing |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1285 |
$(JSHELLAPI_INDEX_HTML): $(JSHELLAPI_OPTIONS_FILE) $(JSHELLAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1286 |
$(prep-javadoc) |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1287 |
$(call JavadocSummary,$(JSHELLAPI_OPTIONS_FILE),$(JSHELLAPI_PACKAGES_FILE)) |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1288 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1289 |
@$(JSHELLAPI_OPTIONS_FILE) @$(JSHELLAPI_PACKAGES_FILE) |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1290 |
|
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1291 |
# Create file with javadoc options in it |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1292 |
$(JSHELLAPI_OPTIONS_FILE): |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1293 |
$(prep-target) |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1294 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1295 |
$(call COMMON_JAVADOCTAGS) ; \ |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1296 |
$(call OptionOnly,-Xdoclint:all) ; \ |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1297 |
$(call OptionPair,-system,none) ; \ |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1298 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1299 |
$(call OptionPair,-addmods,$(JSHELLAPI_MODULES)) ; \ |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1300 |
$(call OptionPair,-encoding,ascii) ; \ |
39381
e323aa93ee46
8160009: JShell: Add SPI and execution to generated JShell javadoc (root ws)
rfield
parents:
39113
diff
changeset
|
1301 |
$(call OptionPair,-overview,$(JSHELLAPI_OVERVIEW)) ; \ |
36792
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1302 |
$(call OptionPair,-doctitle,$(JSHELLAPI_DOCTITLE)) ; \ |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1303 |
$(call OptionPair,-windowtitle,$(JSHELLAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1304 |
$(call OptionPair,-header,$(JSHELLAPI_HEADER)$(DRAFT_HEADER)) ; \ |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1305 |
$(call OptionPair,-bottom,$(JSHELLAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1306 |
$(call OptionTrip,-linkoffline,$(JSHELLAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1307 |
) >> $@ |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1308 |
|
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1309 |
# Create a file with the package names in it |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1310 |
$(JSHELLAPI_PACKAGES_FILE): $(call PackageDependencies,$(JSHELLAPI_PKGS)) |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1311 |
$(prep-target) |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1312 |
$(call PackageFilter,$(JSHELLAPI_PKGS)) |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1313 |
|
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1314 |
############################################################# |
09d2e1165981
8153243: make docs should generate JShell API docs
jlahoda
parents:
36506
diff
changeset
|
1315 |
# |
13697 | 1316 |
# treeapidocs |
1317 |
# |
|
1318 |
||
1319 |
ALL_OTHER_TARGETS += treeapidocs |
|
1320 |
||
20363 | 1321 |
TREEAPI_DOCDIR := $(JDK_API_DOCSDIR)/javac/tree |
1322 |
TREEAPI2COREAPI := ../../$(JDKJRE2COREAPI) |
|
1323 |
TREEAPI_DOCTITLE := Compiler Tree API |
|
1324 |
TREEAPI_WINDOWTITLE := Compiler Tree API |
|
1325 |
TREEAPI_HEADER := <strong>Compiler Tree API</strong> |
|
1326 |
TREEAPI_BOTTOM := $(call CommonBottom,$(TREEAPI_FIRST_COPYRIGHT_YEAR)) |
|
1327 |
TREEAPI_GROUPNAME := Packages |
|
1328 |
TREEAPI_REGEXP := com.sun.source.* |
|
13697 | 1329 |
# TREEAPI_PKGS is located in NON_CORE_PKGS.gmk |
1330 |
||
20363 | 1331 |
TREEAPI_INDEX_HTML = $(TREEAPI_DOCDIR)/index.html |
1332 |
TREEAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options |
|
13697 | 1333 |
TREEAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages |
1334 |
||
36506 | 1335 |
# The modules required to be documented |
1336 |
TREEAPI_MODULES = jdk.compiler |
|
1337 |
||
13697 | 1338 |
treeapidocs: $(TREEAPI_INDEX_HTML) |
1339 |
||
1340 |
# Set relative location to core api document root |
|
1341 |
$(TREEAPI_INDEX_HTML): GET2DOCSDIR=$(TREEAPI2COREAPI)/.. |
|
1342 |
||
1343 |
# 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
|
1344 |
$(TREEAPI_INDEX_HTML): $(TREEAPI_OPTIONS_FILE) $(TREEAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 1345 |
$(prep-javadoc) |
1346 |
$(call JavadocSummary,$(TREEAPI_OPTIONS_FILE),$(TREEAPI_PACKAGES_FILE)) |
|
29176
45baf3cdc876
8074395: Random build failures in javadoc on Solaris
erikj
parents:
28010
diff
changeset
|
1347 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
20363 | 1348 |
@$(TREEAPI_OPTIONS_FILE) @$(TREEAPI_PACKAGES_FILE) |
13697 | 1349 |
|
1350 |
# Create file with javadoc options in it |
|
1351 |
$(TREEAPI_OPTIONS_FILE): |
|
1352 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1353 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1354 |
$(call COMMON_JAVADOCTAGS) ; \ |
25043
b5598c2ddf6f
8048302: Update bug reporting URL in make/Javadoc.gmk
darcy
parents:
24232
diff
changeset
|
1355 |
$(call OptionOnly,-Xdoclint:all) ; \ |
36506 | 1356 |
$(call OptionPair,-system,none) ; \ |
1357 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
1358 |
$(call OptionPair,-addmods,$(TREEAPI_MODULES)) ; \ |
|
20363 | 1359 |
$(call OptionPair,-encoding,ascii) ; \ |
1360 |
$(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \ |
|
1361 |
$(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
|
1362 |
$(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \ |
|
1363 |
$(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 1364 |
$(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \ |
1365 |
$(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
|
20363 | 1366 |
) >> $@ |
13697 | 1367 |
|
1368 |
# 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
|
1369 |
$(TREEAPI_PACKAGES_FILE): $(call PackageDependencies,$(TREEAPI_PKGS)) |
13697 | 1370 |
$(prep-target) |
1371 |
$(call PackageFilter,$(TREEAPI_PKGS)) |
|
1372 |
||
1373 |
############################################################# |
|
1374 |
# |
|
27596
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1375 |
# nashornapidocs |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1376 |
# |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1377 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1378 |
ALL_OTHER_TARGETS += nashornapidocs |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1379 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1380 |
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
|
1381 |
NASHORNAPI2COREAPI := ../$(JDKJRE2COREAPI) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1382 |
NASHORNAPI_DOCTITLE := Nashorn API |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1383 |
NASHORNAPI_WINDOWTITLE := Nashorn API |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1384 |
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
|
1385 |
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
|
1386 |
NASHORNAPI_GROUPNAME := Packages |
30416
6216eb71e929
8079900: javadoc is missing for jdk.nashorn.api.tree package
sundar
parents:
29851
diff
changeset
|
1387 |
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
|
1388 |
# 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
|
1389 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1390 |
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
|
1391 |
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
|
1392 |
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
|
1393 |
|
36506 | 1394 |
# The modules required to be documented |
1395 |
NASHORNAPI_MODULES = jdk.scripting.nashorn |
|
1396 |
||
27596
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1397 |
nashornapidocs: $(NASHORNAPI_INDEX_HTML) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1398 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1399 |
# 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
|
1400 |
$(NASHORNAPI_INDEX_HTML): GET2DOCSDIR=$(NASHORNAPI2COREAPI)/.. |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1401 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1402 |
# 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
|
1403 |
$(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
|
1404 |
$(prep-javadoc) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1405 |
$(call JavadocSummary,$(NASHORNAPI_OPTIONS_FILE),$(NASHORNAPI_PACKAGES_FILE)) |
29176
45baf3cdc876
8074395: Random build failures in javadoc on Solaris
erikj
parents:
28010
diff
changeset
|
1406 |
$(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
|
1407 |
@$(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
|
1408 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1409 |
# 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
|
1410 |
$(NASHORNAPI_OPTIONS_FILE): |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1411 |
$(prep-target) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1412 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1413 |
$(call COMMON_JAVADOCTAGS) ; \ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1414 |
$(call OptionOnly,-Xdoclint:all) ; \ |
36506 | 1415 |
$(call OptionPair,-system,none) ; \ |
1416 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
1417 |
$(call OptionPair,-addmods,$(NASHORNAPI_MODULES)) ; \ |
|
27596
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1418 |
$(call OptionPair,-encoding,ascii) ; \ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1419 |
$(call OptionPair,-doctitle,$(NASHORNAPI_DOCTITLE)) ; \ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1420 |
$(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
|
1421 |
$(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
|
1422 |
$(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
|
1423 |
$(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
|
1424 |
$(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
|
1425 |
) >> $@ |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1426 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1427 |
# 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
|
1428 |
$(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
|
1429 |
$(prep-target) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1430 |
$(call PackageFilter,$(NASHORNAPI_PKGS)) |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1431 |
|
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1432 |
############################################################# |
da40665398a4
8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents:
27595
diff
changeset
|
1433 |
# |
35369
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1434 |
# dynalinkapidocs |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1435 |
# |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1436 |
|
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1437 |
ALL_OTHER_TARGETS += dynalinkapidocs |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1438 |
|
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1439 |
DYNALINKAPI_DOCDIR := $(JDK_API_DOCSDIR)/dynalink |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1440 |
DYNALINKAPI2COREAPI := ../$(JDKJRE2COREAPI) |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1441 |
DYNALINKAPI_DOCTITLE := Dynalink API |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1442 |
DYNALINKAPI_WINDOWTITLE := Dynalink API |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1443 |
DYNALINKAPI_HEADER := <strong>Dynalink API</strong> |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1444 |
DYNALINKAPI_BOTTOM := $(call CommonBottom,$(DYNALINKAPI_FIRST_COPYRIGHT_YEAR)) |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1445 |
DYNALINKAPI_GROUPNAME := Packages |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1446 |
DYNALINKAPI_REGEXP := jdk.dynalink.* |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1447 |
# DYNALINKAPI_PKGS is located in NON_CORE_PKGS.gmk |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1448 |
|
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1449 |
DYNALINKAPI_INDEX_HTML = $(DYNALINKAPI_DOCDIR)/index.html |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1450 |
DYNALINKAPI_OPTIONS_FILE = $(DOCSTMPDIR)/dynalinkapi.options |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1451 |
DYNALINKAPI_PACKAGES_FILE = $(DOCSTMPDIR)/dynalinkapi.packages |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1452 |
|
36506 | 1453 |
# The modules required to be documented |
1454 |
DYNALINKAPI_MODULES = jdk.dynalink |
|
1455 |
||
35369
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1456 |
dynalinkapidocs: $(DYNALINKAPI_INDEX_HTML) |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1457 |
|
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1458 |
# Set relative location to core api document root |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1459 |
$(DYNALINKAPI_INDEX_HTML): GET2DOCSDIR=$(DYNALINKAPI2COREAPI)/.. |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1460 |
|
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1461 |
# Run javadoc if the index file is out of date or missing |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1462 |
$(DYNALINKAPI_INDEX_HTML): $(DYNALINKAPI_OPTIONS_FILE) $(DYNALINKAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1463 |
$(prep-javadoc) |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1464 |
$(call JavadocSummary,$(DYNALINKAPI_OPTIONS_FILE),$(DYNALINKAPI_PACKAGES_FILE)) |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1465 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1466 |
@$(DYNALINKAPI_OPTIONS_FILE) @$(DYNALINKAPI_PACKAGES_FILE) |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1467 |
|
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1468 |
# Create file with javadoc options in it |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1469 |
$(DYNALINKAPI_OPTIONS_FILE): |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1470 |
$(prep-target) |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1471 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1472 |
$(call COMMON_JAVADOCTAGS) ; \ |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1473 |
$(call OptionOnly,-Xdoclint:all) ; \ |
36506 | 1474 |
$(call OptionPair,-system,none) ; \ |
1475 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
1476 |
$(call OptionPair,-addmods,$(DYNALINKAPI_MODULES)) ; \ |
|
35369
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1477 |
$(call OptionPair,-encoding,ascii) ; \ |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1478 |
$(call OptionPair,-doctitle,$(DYNALINKAPI_DOCTITLE)) ; \ |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1479 |
$(call OptionPair,-windowtitle,$(DYNALINKAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1480 |
$(call OptionPair,-header,$(DYNALINKAPI_HEADER)$(DRAFT_HEADER)) ; \ |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1481 |
$(call OptionPair,-bottom,$(DYNALINKAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1482 |
$(call OptionTrip,-linkoffline,$(DYNALINKAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1483 |
) >> $@ |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1484 |
|
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1485 |
# Create a file with the package names in it |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1486 |
$(DYNALINKAPI_PACKAGES_FILE): $(call PackageDependencies,$(DYNALINKAPI_PKGS)) |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1487 |
$(prep-target) |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1488 |
$(call PackageFilter,$(DYNALINKAPI_PKGS)) |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1489 |
|
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1490 |
############################################################# |
a68e46d94261
8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents:
35367
diff
changeset
|
1491 |
# |
13697 | 1492 |
# sctpdocs |
1493 |
# |
|
1494 |
||
1495 |
ALL_OTHER_TARGETS += sctpdocs |
|
1496 |
||
20363 | 1497 |
SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec |
1498 |
SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI) |
|
1499 |
SCTPAPI_DOCTITLE := SCTP API |
|
13697 | 1500 |
SCTPAPI_WINDOWTITLE := SCTP API |
20363 | 1501 |
SCTPAPI_HEADER := <strong>SCTP API</strong> |
1502 |
SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR)) |
|
13697 | 1503 |
# SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk |
1504 |
||
20363 | 1505 |
SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html |
1506 |
SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options |
|
13697 | 1507 |
SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages |
1508 |
||
36506 | 1509 |
# The modules required to be documented |
1510 |
SCTPAPI_MODULES = jdk.sctp |
|
1511 |
||
13697 | 1512 |
sctpdocs: $(SCTPAPI_INDEX_HTML) |
1513 |
||
1514 |
# Set relative location to core api document root |
|
1515 |
$(SCTPAPI_INDEX_HTML): GET2DOCSDIR=$(SCTPAPI2COREAPI)/.. |
|
1516 |
||
1517 |
# 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
|
1518 |
$(SCTPAPI_INDEX_HTML): $(SCTPAPI_OPTIONS_FILE) $(SCTPAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
13697 | 1519 |
$(prep-javadoc) |
1520 |
$(call JavadocSummary,$(SCTPAPI_OPTIONS_FILE),$(SCTPAPI_PACKAGES_FILE)) |
|
29176
45baf3cdc876
8074395: Random build failures in javadoc on Solaris
erikj
parents:
28010
diff
changeset
|
1521 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
20363 | 1522 |
@$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE) |
13697 | 1523 |
|
1524 |
# Create file with javadoc options in it |
|
1525 |
$(SCTPAPI_OPTIONS_FILE): |
|
1526 |
$(prep-target) |
|
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1527 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1528 |
$(call COMMON_JAVADOCTAGS) ; \ |
22033
c323078abaf4
8031081: Use separate doclint flags for different doc bundles
darcy
parents:
21759
diff
changeset
|
1529 |
$(call OptionOnly,-Xdoclint:none) ; \ |
36506 | 1530 |
$(call OptionPair,-system,none) ; \ |
1531 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
1532 |
$(call OptionPair,-addmods,$(SCTPAPI_MODULES)) ; \ |
|
20363 | 1533 |
$(call OptionPair,-encoding,ascii) ; \ |
1534 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
|
1535 |
$(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \ |
|
1536 |
$(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
|
1537 |
$(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \ |
|
1538 |
$(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \ |
|
13697 | 1539 |
$(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
20363 | 1540 |
) >> $@ |
13697 | 1541 |
|
1542 |
# 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
|
1543 |
$(SCTPAPI_PACKAGES_FILE): $(call PackageDependencies,$(SCTPAPI_PKGS)) |
13697 | 1544 |
$(prep-target) |
1545 |
$(call PackageFilter,$(SCTPAPI_PKGS)) |
|
1546 |
||
1547 |
############################################################# |
|
1548 |
# |
|
29851
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1549 |
# jaccessdocs - Java Accessibility Utilities |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1550 |
# |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1551 |
|
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1552 |
ALL_OTHER_TARGETS += jaccessdocs |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1553 |
|
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1554 |
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
|
1555 |
JACCESSAPI2COREAPI := ../../../$(JDKJRE2COREAPI) |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1556 |
JACCESSAPI_DOCTITLE := JACCESS API |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1557 |
JACCESSAPI_WINDOWTITLE := JACCESS API |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1558 |
JACCESSAPI_HEADER := <strong>JACCESS API</strong> |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1559 |
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
|
1560 |
# 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
|
1561 |
|
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1562 |
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
|
1563 |
JACCESSAPI_OPTIONS_FILE = $(DOCSTMPDIR)/jaccess.options |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1564 |
JACCESSAPI_PACKAGES_FILE = $(DOCSTMPDIR)/jaccess.packages |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1565 |
|
36506 | 1566 |
# The modules required to be documented |
1567 |
JACCESSAPI_MODULES = jdk.accessibility |
|
1568 |
||
29851
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1569 |
jaccessdocs: $(JACCESSAPI_INDEX_HTML) |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1570 |
|
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1571 |
# 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
|
1572 |
$(JACCESSAPI_INDEX_HTML): GET2DOCSDIR=$(JACCESSAPI2COREAPI)/.. |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1573 |
|
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1574 |
# 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
|
1575 |
$(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
|
1576 |
$(prep-javadoc) |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1577 |
$(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
|
1578 |
$(JAVADOC_CMD) -d $(@D) \ |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1579 |
@$(JACCESSAPI_OPTIONS_FILE) @$(JACCESSAPI_PACKAGES_FILE) |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1580 |
|
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1581 |
# 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
|
1582 |
$(JACCESSAPI_OPTIONS_FILE): |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1583 |
$(prep-target) |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1584 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1585 |
$(call COMMON_JAVADOCTAGS) ; \ |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1586 |
$(call OptionOnly,-Xdoclint:all) ; \ |
36506 | 1587 |
$(call OptionPair,-system,none) ; \ |
1588 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
1589 |
$(call OptionPair,-addmods,$(JACCESSAPI_MODULES)) ; \ |
|
29851
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1590 |
$(call OptionPair,-encoding,ascii) ; \ |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1591 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1592 |
$(call OptionPair,-doctitle,$(JACCESSAPI_DOCTITLE)) ; \ |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1593 |
$(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
|
1594 |
$(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
|
1595 |
$(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
|
1596 |
$(call OptionTrip,-linkoffline,$(JACCESSAPI2COREAPI),$(COREAPI_DOCSDIR)/); \ |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1597 |
) >> $@ |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1598 |
|
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1599 |
# 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
|
1600 |
$(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
|
1601 |
$(prep-target) |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1602 |
$(call PackageFilter,$(JACCESSAPI_PKGS)) |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1603 |
|
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1604 |
############################################################# |
81a61a04e2fe
8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents:
29176
diff
changeset
|
1605 |
# |
23836
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1606 |
# jdk.net docs |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1607 |
# |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1608 |
|
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1609 |
ALL_OTHER_TARGETS += jdknetdocs |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1610 |
|
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1611 |
JDKNET_DOCDIR := $(JRE_API_DOCSDIR)/net/socketoptions/spec |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1612 |
JDKNET2COREAPI := ../../../$(JDKJRE2COREAPI) |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1613 |
JDKNET_DOCTITLE := jdk.net API |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1614 |
JDKNET_WINDOWTITLE := jdk.net API |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1615 |
JDKNET_HEADER := <strong>jdk.net API</strong> |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1616 |
JDKNET_BOTTOM := $(call CommonBottom,$(JDKNET_FIRST_COPYRIGHT_YEAR)) |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1617 |
JDKNET_PKGS := jdk.net |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1618 |
|
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1619 |
JDKNET_INDEX_HTML = $(JDKNET_DOCDIR)/index.html |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1620 |
JDKNET_OPTIONS_FILE = $(DOCSTMPDIR)/jdknet.options |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1621 |
JDKNET_PACKAGES_FILE = $(DOCSTMPDIR)/jdknet.packages |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1622 |
|
36506 | 1623 |
# The modules required to be documented |
37650
ef6c24163cb2
8044773: Refactor jdk.net API so that it can be moved out of the base module
chegar
parents:
37034
diff
changeset
|
1624 |
JDKNET_MODULES = jdk.net |
36506 | 1625 |
|
23836
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1626 |
jdknetdocs: $(JDKNET_INDEX_HTML) |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1627 |
|
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1628 |
# Set relative location to core api document root |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1629 |
$(JDKNET_INDEX_HTML): GET2DOCSDIR=$(JDKNET2COREAPI)/.. |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1630 |
|
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1631 |
# 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
|
1632 |
$(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
|
1633 |
$(prep-javadoc) |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1634 |
$(call JavadocSummary,$(JDKNET_OPTIONS_FILE),$(JDKNET_PACKAGES_FILE)) |
29176
45baf3cdc876
8074395: Random build failures in javadoc on Solaris
erikj
parents:
28010
diff
changeset
|
1635 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
23836
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1636 |
@$(JDKNET_OPTIONS_FILE) @$(JDKNET_PACKAGES_FILE) |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1637 |
|
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1638 |
# Create file with javadoc options in it |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1639 |
$(JDKNET_OPTIONS_FILE): |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1640 |
$(prep-target) |
25614
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1641 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
0d18591d71d8
8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents:
25046
diff
changeset
|
1642 |
$(call COMMON_JAVADOCTAGS) ; \ |
23836
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1643 |
$(call OptionOnly,-Xdoclint:none) ; \ |
36506 | 1644 |
$(call OptionPair,-system,none) ; \ |
1645 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
1646 |
$(call OptionPair,-addmods,$(JDKNET_MODULES)) ; \ |
|
23836
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1647 |
$(call OptionPair,-encoding,ascii) ; \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1648 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1649 |
$(call OptionPair,-doctitle,$(JDKNET_DOCTITLE)) ; \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1650 |
$(call OptionPair,-windowtitle,$(JDKNET_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1651 |
$(call OptionPair,-header,$(JDKNET_HEADER)$(DRAFT_HEADER)); \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1652 |
$(call OptionPair,-bottom,$(JDKNET_BOTTOM)$(DRAFT_BOTTOM)); \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1653 |
$(call OptionTrip,-linkoffline,$(JDKNET2COREAPI),$(COREAPI_DOCSDIR)/); \ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1654 |
) >> $@ |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1655 |
|
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1656 |
# 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
|
1657 |
$(JDKNET_PACKAGES_FILE): $(call PackageDependencies,$(JDKNET_PKGS)) |
23836
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1658 |
$(prep-target) |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1659 |
$(call PackageFilter,$(JDKNET_PKGS)) |
a199f7dbfbc6
8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents:
22033
diff
changeset
|
1660 |
|
36506 | 1661 |
############################################################# |
1662 |
# |
|
1663 |
# jlink plugin API docs |
|
1664 |
# |
|
1665 |
# TODO: Need to decide when the plugin API is ready to publish as experimental API. |
|
1666 |
# This target is temporarily added for internal use for now. |
|
39932
a0794ee00a5b
8156960: Deprecate JSObject.getWindow(Applet) method
dtitov
parents:
39609
diff
changeset
|
1667 |
# |
36506 | 1668 |
|
1669 |
ALL_OTHER_TARGETS += jlinkdocs |
|
1670 |
||
1671 |
JLINK_PLUGIN_FIRST_COPYRIGHT_YEAR = 2015 |
|
1672 |
JLINK_PLUGIN_DOCDIR := $(JDK_API_DOCSDIR)/jlink |
|
1673 |
JLINK_PLUGIN2COREAPI := ../$(JDKJRE2COREAPI) |
|
1674 |
JLINK_PLUGIN_DOCTITLE := JLink Plugin API - EXPERIMENTAL |
|
1675 |
JLINK_PLUGIN_WINDOWTITLE := JLink Plugin API - EXPERIMENTAL |
|
1676 |
JLINK_PLUGIN_HEADER := <strong>JLink Plugin API - EXPERIMENTAL</strong> |
|
1677 |
JLINK_PLUGIN_BOTTOM := $(call CommonBottom,$(JLINK_PLUGIN_FIRST_COPYRIGHT_YEAR)) |
|
37951 | 1678 |
JLINK_PLUGIN_PKGS = jdk.tools.jlink.plugin |
36506 | 1679 |
|
1680 |
JLINK_PLUGIN_INDEX_HTML = $(JLINK_PLUGIN_DOCDIR)/index.html |
|
1681 |
JLINK_PLUGIN_OPTIONS_FILE = $(DOCSTMPDIR)/jlinkplugins.options |
|
1682 |
JLINK_PLUGIN_PACKAGES_FILE = $(DOCSTMPDIR)/jlinkplugins.packages |
|
1683 |
||
1684 |
# The modules required to be documented |
|
1685 |
JLINK_PLUGIN_MODULES = jdk.jlink |
|
1686 |
||
1687 |
jlinkdocs: $(JLINK_PLUGIN_INDEX_HTML) |
|
1688 |
||
1689 |
# Set relative location to core api document root |
|
1690 |
$(JLINK_PLUGIN_INDEX_HTML): GET2DOCSDIR=$(JLINK_PLUGIN2COREAPI)/.. |
|
1691 |
||
1692 |
# Run javadoc if the index file is out of date or missing |
|
1693 |
$(JLINK_PLUGIN_INDEX_HTML): $(JLINK_PLUGIN_OPTIONS_FILE) $(JLINK_PLUGIN_PACKAGES_FILE) $(COREAPI_INDEX_FILE) |
|
1694 |
$(prep-javadoc) |
|
1695 |
$(call JavadocSummary,$(JLINK_PLUGIN_OPTIONS_FILE),$(JLINK_PLUGIN_PACKAGES_FILE)) |
|
1696 |
$(JAVADOC_CMD_SMALL) -d $(@D) \ |
|
1697 |
@$(JLINK_PLUGIN_OPTIONS_FILE) @$(JLINK_PLUGIN_PACKAGES_FILE) |
|
1698 |
||
1699 |
# Create file with javadoc options in it |
|
1700 |
$(JLINK_PLUGIN_OPTIONS_FILE): |
|
1701 |
$(prep-target) |
|
1702 |
@($(call COMMON_JAVADOCFLAGS) ; \ |
|
1703 |
$(call COMMON_JAVADOCTAGS) ; \ |
|
1704 |
$(call OptionOnly,-Xdoclint:none) ; \ |
|
1705 |
$(call OptionPair,-system,none) ; \ |
|
1706 |
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \ |
|
1707 |
$(call OptionPair,-addmods,$(JLINK_PLUGIN_MODULES)) ; \ |
|
1708 |
$(call OptionPair,-encoding,ascii) ; \ |
|
1709 |
$(call OptionOnly,-nodeprecatedlist) ; \ |
|
1710 |
$(call OptionPair,-doctitle,$(JLINK_PLUGIN_DOCTITLE)) ; \ |
|
1711 |
$(call OptionPair,-windowtitle,$(JLINK_PLUGIN_WINDOWTITLE) $(DRAFT_WINTITLE)); \ |
|
1712 |
$(call OptionPair,-header,$(JLINK_PLUGIN_HEADER)$(DRAFT_HEADER)); \ |
|
1713 |
$(call OptionPair,-bottom,$(JLINK_PLUGIN_BOTTOM)$(DRAFT_BOTTOM)); \ |
|
1714 |
$(call OptionTrip,-linkoffline,$(JLINK_PLUGIN2COREAPI),$(COREAPI_DOCSDIR)/); \ |
|
1715 |
) >> $@ |
|
1716 |
||
1717 |
# Create a file with the package names in it |
|
1718 |
$(JLINK_PLUGIN_PACKAGES_FILE): $(call PackageDependencies,$(JLINK_PLUGIN_PKGS)) |
|
1719 |
$(prep-target) |
|
1720 |
$(call PackageFilter,$(JLINK_PLUGIN_PKGS)) |
|
1721 |
||
13697 | 1722 |
|
1723 |
otherdocs: $(ALL_OTHER_TARGETS) |
|
1724 |
||
37034
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1725 |
# |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1726 |
# Add the core docs as prerequisite to the archive to trigger a rebuild |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1727 |
# if the core docs were rebuilt. Ideally any doc rebuild should trigger |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1728 |
# this, but the way prerequisites are currently setup in this file, that |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1729 |
# is hard to achieve. |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1730 |
# |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1731 |
|
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1732 |
$(JAVADOC_ARCHIVE): $(COREAPI_INDEX_FILE) |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1733 |
$(call LogInfo, Compressing javadoc to single $(JAVADOC_ARCHIVE_NAME)) |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1734 |
$(MKDIR) -p $(JAVADOC_ARCHIVE_DIR) |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1735 |
$(RM) -r $(JAVADOC_ARCHIVE_ASSEMBLY_DIR) |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1736 |
$(MKDIR) -p $(JAVADOC_ARCHIVE_ASSEMBLY_DIR) |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1737 |
all_roots=`$(FIND) $(DOCSDIR) | $(GREP) index.html | grep -v old/doclet`; \ |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1738 |
pushd $(JAVADOC_ARCHIVE_ASSEMBLY_DIR); \ |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1739 |
for index_file in $${all_roots} ; do \ |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1740 |
target_dir=`dirname $${index_file}`; \ |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1741 |
name=`$(ECHO) $${target_dir} | $(SED) "s;/spec;;" | $(SED) "s;.*/;;"`; \ |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1742 |
$(LN) -s $${target_dir} $${name}; \ |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1743 |
done; \ |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1744 |
$(ZIP) -q -r $(JAVADOC_ARCHIVE) * ; \ |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1745 |
popd ; |
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1746 |
|
13697 | 1747 |
############################################################# |
33926
3a19edba4808
8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents:
30416
diff
changeset
|
1748 |
.PHONY: all docs coredocs otherdocs \ |
37034
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
1749 |
$(ALL_OTHER_TARGETS) zip-docs |
39384
adde8cb7d01b
8003593: build-infra: Paths to optional platform-specific files should not be hardwired to src/closed
erikj
parents:
39381
diff
changeset
|
1750 |
|
adde8cb7d01b
8003593: build-infra: Paths to optional platform-specific files should not be hardwired to src/closed
erikj
parents:
39381
diff
changeset
|
1751 |
################################################################################ |
adde8cb7d01b
8003593: build-infra: Paths to optional platform-specific files should not be hardwired to src/closed
erikj
parents:
39381
diff
changeset
|
1752 |
|
adde8cb7d01b
8003593: build-infra: Paths to optional platform-specific files should not be hardwired to src/closed
erikj
parents:
39381
diff
changeset
|
1753 |
$(eval $(call IncludeCustomExtension, , Javadoc-post.gmk)) |