1 # Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved.
2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 #
4 # This code is free software; you can redistribute it and/or modify it
5 # under the terms of the GNU General Public License version 2 only, as
6 # published by the Free Software Foundation. Oracle designates this
7 # particular file as subject to the "Classpath" exception as provided
8 # by Oracle in the LICENSE file that accompanied this code.
9 #
10 # This code is distributed in the hope that it will be useful, but WITHOUT
11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 # version 2 for more details (a copy is included in the LICENSE file that
14 # accompanied this code).
15 #
16 # You should have received a copy of the GNU General Public License version
17 # 2 along with this work; if not, write to the Free Software Foundation,
18 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 #
20 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 # or visit www.oracle.com if you need additional information or have any
22 # questions.
23 #
24
25 include $(SPEC)
26 include MakeBase.gmk
27
28 #################################################################
29 #
30 # CORE_PKGS environment variable has been moved to the following file
31 #
32 include CORE_PKGS.gmk
33 #
34 # Load environment variables for API package names that are not part of
35 # the Java SE platform
36 #
37 include NON_CORE_PKGS.gmk
38
39
40 .SUFFIXES: # Delete the default suffixes
41 .SUFFIXES: .java
42
43 #
44 # Definitions for directories
45 #
46
47 DOCSDIR := $(DOCS_IMAGE_DIR)
48 DOCSTMPDIR = $(SUPPORT_OUTPUTDIR)/docs
49
50 HOTSPOT_DOCS_IMPORT_PATH=$(HOTSPOT_OUTPUTDIR)/docs
51
52 JAVADOC_CMD = $(JAVA) \
53 -Djava.awt.headless=true \
54 $(NEW_JAVADOC)
55
56 JAVADOC_CMD_SMALL = $(JAVA_SMALL) \
57 -Djava.awt.headless=true \
58 $(NEW_JAVADOC)
59
60 # Copyright year for beginning of Java and some of the apis
61 # (Needed when creating the javadocs)
62 FIRST_COPYRIGHT_YEAR = 1993
63 DOMAPI_FIRST_COPYRIGHT_YEAR = 2005
64 MIRROR_FIRST_COPYRIGHT_YEAR = 2004
65 DOCLETAPI_FIRST_COPYRIGHT_YEAR = 1993
66 TAGLETAPI_FIRST_COPYRIGHT_YEAR = 1993
67 JDI_FIRST_COPYRIGHT_YEAR = 1999
68 JAAS_FIRST_COPYRIGHT_YEAR = 1998
69 JGSS_FIRST_COPYRIGHT_YEAR = 2000
70 SMARTCARDIO_FIRST_COPYRIGHT_YEAR = 2005
71 HTTPSERVER_FIRST_COPYRIGHT_YEAR = 2005
72 MGMT_FIRST_COPYRIGHT_YEAR = 2003
73 ATTACH_FIRST_COPYRIGHT_YEAR = 2005
74 JCONSOLE_FIRST_COPYRIGHT_YEAR = 2006
75 SCTPAPI_FIRST_COPYRIGHT_YEAR = 2009
76 TRACING_FIRST_COPYRIGHT_YEAR = 2008
77 JSHELLAPI_FIRST_COPYRIGHT_YEAR = 2015
78 TREEAPI_FIRST_COPYRIGHT_YEAR = 2005
79 NASHORNAPI_FIRST_COPYRIGHT_YEAR = 2014
80 DYNALINKAPI_FIRST_COPYRIGHT_YEAR = 2015
81 JNLP_FIRST_COPYRIGHT_YEAR = 1998
82 PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007
83 JDKNET_FIRST_COPYRIGHT_YEAR = 2014
84 JACCESSAPI_FIRST_COPYRIGHT_YEAR = 2002
85 JSOBJECT_FIRST_COPYRIGHT_YEAR = 1993
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
97 # The word "Copyright" might optionally be a link to the file cpyr.html.
98 # The first year of copyright may vary or not be available.
99 # The address to the company might be optional.
100 COMMA:= ,
101 EMPTY:=
102 SPACE:=$(EMPTY) $(EMPTY)
103 COPYRIGHT_SYMBOL = &\#x00a9;
104 # Macro to construct the copyright line
105 # (The GNU make 3.78.1 "if" conditional is broken, fixed in GNU make 3.81)
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
116 COPYRIGHT_URL = $(DOCSDIR_URL)/legal/cpyr.html
117
118 # Url to bug filing site
119 BUG_SUBMIT_URL = http://bugreport.java.com/bugreport/
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
125 DOCS_BASE_URL = http://docs.oracle.com/javase/$(VERSION_SPECIFICATION)/docs
126 DEV_DOCS_URL = $(DOCS_BASE_URL)/index.html
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
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)
141 ALL_SOURCE_DIRS := $(wildcard \
142 $(SUPPORT_OUTPUTDIR)/gensrc/j* \
143 $(if $(IMPORT_MODULES_SRC), $(IMPORT_MODULES_SRC)/*) \
144 $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS)/classes \
145 $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS_TYPE)/classes \
146 $(JDK_TOPDIR)/src/*/share/classes \
147 $(HOTSPOT_TOPDIR)/src/*/share/classes \
148 $(LANGTOOLS_TOPDIR)/src/*/share/classes \
149 $(NASHORN_TOPDIR)/src/*/share/classes \
150 $(CORBA_TOPDIR)/src/*/share/classes \
151 $(JAXP_TOPDIR)/src/*/share/classes \
152 $(JAXWS_TOPDIR)/src/*/share/classes \
153 $(SUPPORT_OUTPUTDIR)/rmic/j* \
154 $(JDK_TOPDIR)/src/*/share/doc/stub \
155 ) \
156 #
157
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
175 # List with classpath separator between them
176 EMPTY:=
177 SPACE:= $(EMPTY) $(EMPTY)
178 RELEASEDOCS_SOURCEPATH = \
179 $(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_SOURCE_DIRS)))
180
181 RELEASEDOCS_MODULESOURCEPATH = \
182 $(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_MODULE_SOURCE_DIRS)))
183
184 define prep-target
185 $(MKDIR) -p $(@D)
186 $(RM) $@
187 endef
188
189 # Prep for javadoc creation, assumes $@ is an index.html file
190 define prep-javadoc
191 @if [ -f "$@" -a "$?" != "" ] ; then \
192 $(ECHO) "# Dependencies have changed: $?"; \
193 fi
194 $(RM) -r $(@D)
195 $(MKDIR) -p $(@D)
196 endef
197
198 $(eval $(call FillCacheFind, $(ALL_SOURCE_DIRS)))
199 define PackageDependencies
200 $(call CacheFind, $(wildcard $(foreach p, $(subst .,/,$1), $(addsuffix /$p, $(ALL_SOURCE_DIRS)))))
201 endef
202
203 # Given a list of packages, add packages that exist to $@, print summary
204 define PackageFilter # packages
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
221 endef
222
223 # Print out a summary of the javadoc command about to be run
224 define JavadocSummary # optionsfile packagesfile
225 @$(ECHO) "# Running javadoc for $(patsubst $(OUTPUT_ROOT)/%,%,$@)" $(LOG_WARN)
226 @($(ECHO) "# Options (`$(BASENAME) $1`):"; $(SED) -e 's@^@# @' $1) $(LOG_DEBUG)
227 @($(ECHO) "# Packages (`$(BASENAME) $2`):";$(SED) -e 's@^@# @' $2) $(LOG_DEBUG)
228 endef
229
230 #
231 # Different api directories created from root directory
232 #
233 COREAPI_DOCSDIR = $(DOCSDIR)/api
234 JDK_API_DOCSDIR = $(DOCSDIR)/jdk/api
235 JRE_API_DOCSDIR = $(DOCSDIR)/jre/api
236 PLATFORM_DOCSDIR = $(DOCSDIR)/platform
237
238 JAVADOC_ARCHIVE_NAME := jdk-$(VERSION_STRING)-docs.zip
239 JAVADOC_ARCHIVE_ASSEMBLY_DIR := $(DOCSTMPDIR)/zip-docs
240 JAVADOC_ARCHIVE_DIR := $(OUTPUT_ROOT)/bundles
241 JAVADOC_ARCHIVE := $(JAVADOC_ARCHIVE_DIR)/$(JAVADOC_ARCHIVE_NAME)
242
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
248 # The non-core api javadocs need to be able to access the root of the core
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
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
268 if [ "$(strip $1)" != "" ] ; then \
269 $(PRINTF) "%s\n" "$(strip $1)"; \
270 fi
271 endef
272
273 define OptionPair # opt arg
274 $(PRINTF) "%s '%s'\n" "$(strip $1)" '$(strip $2)'
275 endef
276
277 define OptionTrip # opt arg arg
278 $(PRINTF) "%s '%s' '%s'\n" "$(strip $1)" '$(strip $2)' '$(strip $3)'
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
291 # Common javadoc options used by all bundles
292
293 ifdef OPENJDK
294 ADDITIONAL_JAVADOCFLAGS = \
295 -Xdocrootparent $(DOCS_BASE_URL)
296 else
297 ADDITIONAL_JAVADOCFLAGS =
298 endif
299
300 define COMMON_JAVADOCFLAGS
301 $(call OptionOnly,-XDignore.symbol.file=true) ; \
302 $(call OptionOnly,-quiet) ; \
303 $(call OptionOnly,-use) ; \
304 $(call OptionOnly,-keywords) ; \
305 $(call OptionOnly,$(ADDITIONAL_JAVADOCFLAGS))
306 endef
307
308 # Common javadoc tags used by all bundles
309
310 # Java language specification cite
311 TAG_JLS = jls:a:See <cite> \
312 The Java™ Language Specification</cite>:
313
314 # Java virtual machine specification cite
315 TAG_JVMS = jvms:a:See <cite> \
316 The Java™ Virtual Machine Specification</cite>:
317
318 # In order to get a specific ordering it's necessary to specify the total
319 # ordering of tags as the tags are otherwise ordered in order of definition.
320 define COMMON_JAVADOCTAGS
321 $(call OptionPair,-tag,beaninfo:X) ; \
322 $(call OptionPair,-tag,revised:X) ; \
323 $(call OptionPair,-tag,since.unbundled:X) ; \
324 $(call OptionPair,-tag,spec:X) ; \
325 $(call OptionPair,-tag,specdefault:X) ; \
326 $(call OptionPair,-tag,Note:X) ; \
327 $(call OptionPair,-tag,ToDo:X) ; \
328 $(call OptionPair,-tag,apiNote:a:API Note:) ; \
329 $(call OptionPair,-tag,implSpec:a:Implementation Requirements:) ; \
330 $(call OptionPair,-tag,implNote:a:Implementation Note:) ; \
331 $(call OptionPair,-tag,param) ; \
332 $(call OptionPair,-tag,return) ; \
333 $(call OptionPair,-tag,throws) ; \
334 $(call OptionPair,-tag,since) ; \
335 $(call OptionPair,-tag,version) ; \
336 $(call OptionPair,-tag,serialData) ; \
337 $(call OptionPair,-tag,factory) ; \
338 $(call OptionPair,-tag,see) ; \
339 $(call OptionPair,-tag,$(TAG_JVMS)) ; \
340 $(call OptionPair,-tag,$(TAG_JLS))
341 endef
342
343
344
345 # Assume we need a draft format when the version string is not a GA version.
346 ifeq ($(VERSION_IS_GA), false)
347 DRAFT_HEADER := <br><strong>DRAFT $(VERSION_STRING)</strong>
348 DRAFT_BOTTOM := <br><strong>DRAFT $(VERSION_STRING)</strong>
349 DRAFT_WINTITLE := $(VERSION_BUILD)
350 # Early access top text (not used in FCS releases)
351 COREAPI_TOP_EARLYACCESS := \
352 <div style="background-color: \#EEEEEE"> \
353 <div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; \
354 margin-left: 6px; margin-right: 6px; text-align: justify; \
355 font-size: 80%; font-family: Helvetica, Arial, sans-serif; \
356 font-weight: normal;"> \
357 Please note that the specifications and other information \
358 contained herein are not final and are subject to change. \
359 The information is being made available to you solely for purpose of \
360 evaluation. \
361 </div> </div>
362 else
363 DRAFT_HEADER :=
364 DRAFT_BOTTOM :=
365 DRAFT_WINTITLE :=
366 COREAPI_TOP_EARLYACCESS :=
367 endif
368
369 #################################################################
370
371 #
372 # Load custom Javadoc rules
373 #
374
375 $(eval $(call IncludeCustomExtension, , Javadoc.gmk))
376
377 #################################################################
378
379 #
380 # Default target is same as docs target, create core api and all others it can
381 #
382
383 all: docs
384 docs: coredocs otherdocs
385
386 #
387 # Optional target which bundles all generated javadocs into a zip archive.
388 # The dependency on docs is handled in Main.gmk.
389 #
390
391 zip-docs: $(JAVADOC_ARCHIVE)
392
393 #############################################################
394 #
395 # coredocs
396 #
397 COREAPI_DOCTITLE = Java$(TRADEMARK) Platform, Standard Edition \
398 $(VERSION_SPECIFICATION)<br>API Specification
399 COREAPI_WINDOWTITLE = Java Platform SE $(VERSION_SPECIFICATION)
400 COREAPI_HEADER = \
401 <strong>Java$(TRADEMARK) Platform<br>Standard Ed. $(VERSION_SPECIFICATION)</strong>
402
403 # Overview file for core apis
404 COREAPI_OVERVIEW = $(JDK_TOPDIR)/src/java.base/share/classes/overview-core.html
405
406 # The options and packages files
407 COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options
408 COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages
409
410 # The modules required to be documented
411 COREAPI_MODULES = java.se.ee
412
413 coredocs: $(COREAPI_INDEX_FILE)
414
415 # Set relative location to core api document root
416 $(COREAPI_INDEX_FILE): GET2DOCSDIR=..
417
418 # Run javadoc if the index file is out of date or missing
419 $(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE)
420 $(prep-javadoc)
421 $(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE))
422 $(JAVADOC_CMD) -d $(@D) \
423 @$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE)
424
425 # Create file with javadoc options in it
426 $(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW)
427 $(prep-target)
428 @($(call COMMON_JAVADOCFLAGS) ; \
429 $(call COMMON_JAVADOCTAGS) ; \
430 $(call OptionOnly,-Xdoclint:reference) ; \
431 $(call OptionOnly,-Xdoclint/package:-org.omg.*) ; \
432 $(call OptionPair,-system,none) ; \
433 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
434 $(call OptionPair,-addmods,$(COREAPI_MODULES)) ; \
435 $(call OptionPair,-encoding,ISO-8859-1) ; \
436 $(call OptionOnly,-splitIndex) ; \
437 $(call OptionPair,-overview,$(COREAPI_OVERVIEW)) ; \
438 $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE)) ; \
439 $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ; \
440 $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER)) ; \
441 $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
442 ) >> $@
443 ifdef COREAPI_TOP_EARLYACCESS
444 @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@
445 endif
446
447 # Create a file with the package names in it
448 $(COREAPI_PACKAGES_FILE): $(call PackageDependencies,$(CORE_PKGS))
449 $(prep-target)
450 $(call PackageFilter,$(CORE_PKGS))
451
452 #############################################################
453 #
454 # docletapidocs
455 #
456
457 ALL_OTHER_TARGETS += docletapidocs
458
459 DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet
460 DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
461 DOCLETAPI_DOCTITLE := Doclet API
462 DOCLETAPI_WINDOWTITLE := Doclet API
463 DOCLETAPI_HEADER := <strong>Doclet API</strong>
464 DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
465 DOCLETAPI_GROUPNAME := Packages
466 DOCLETAPI_REGEXP := jdk.javadoc.doclet.*
467 # DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
468
469 # The index.html, options, and packages files
470 DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html
471 DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options
472 DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages
473
474 # The modules required to be documented
475 DOCLETAPI_MODULES = jdk.javadoc
476
477 docletapidocs: $(DOCLETAPI_INDEX_FILE)
478
479 # Set relative location to core api document root
480 $(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/..
481
482 # Run javadoc if the index file is out of date or missing
483 $(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
484 $(prep-javadoc)
485 $(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE))
486 $(JAVADOC_CMD_SMALL) -d $(@D) \
487 @$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE)
488
489 # Create file with javadoc options in it
490 $(DOCLETAPI_OPTIONS_FILE):
491 $(prep-target)
492 @($(call COMMON_JAVADOCFLAGS) ; \
493 $(call COMMON_JAVADOCTAGS) ; \
494 $(call OptionOnly,-Xdoclint:all) ; \
495 $(call OptionPair,-system,none) ; \
496 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
497 $(call OptionPair,-addmods,$(DOCLETAPI_MODULES)) ; \
498 $(call OptionPair,-encoding,ascii) ; \
499 $(call OptionOnly,-breakiterator) ; \
500 $(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \
501 $(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
502 $(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \
503 $(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
504 $(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \
505 $(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
506 ) >> $@
507
508 # Create a file with the package names in it
509 $(DOCLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(DOCLETAPI_PKGS))
510 $(prep-target)
511 $(call PackageFilter,$(DOCLETAPI_PKGS))
512
513 #############################################################
514 #
515 # old docletapidocs
516 #
517
518 ALL_OTHER_TARGETS += olddocletapidocs
519
520 OLD_DOCLET_DIR := $(JDK_API_DOCSDIR)/javadoc/old
521 OLD_DOCLETAPI_DOCDIR := $(OLD_DOCLET_DIR)/doclet
522 OLD_DOCLETAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
523 OLD_DOCLETAPI_DOCTITLE := Doclet API
524 OLD_DOCLETAPI_WINDOWTITLE := Doclet API
525 OLD_DOCLETAPI_HEADER := <strong>Doclet API</strong>
526 OLD_DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
527 OLD_DOCLETAPI_GROUPNAME := Packages
528 OLD_DOCLETAPI_REGEXP := com.sun.javadoc
529 # OLD_DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
530
531 # The index.html, options, and packages files
532 OLD_DOCLETAPI_INDEX_FILE = $(OLD_DOCLETAPI_DOCDIR)/index.html
533 OLD_DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/old-docletapi.options
534 OLD_DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/old-docletapi.packages
535
536 # The modules required to be documented
537 OLD_DOCLETAPI_MODULES = jdk.javadoc
538
539 olddocletapidocs: $(OLD_DOCLETAPI_INDEX_FILE)
540
541 # Set relative location to core api document root
542 $(OLD_DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(OLD_DOCLETAPI2COREAPI)/..
543
544 # Run javadoc if the index file is out of date or missing
545 $(OLD_DOCLETAPI_INDEX_FILE): $(OLD_DOCLETAPI_OPTIONS_FILE) $(OLD_DOCLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
546 $(prep-javadoc)
547 $(call JavadocSummary,$(OLD_DOCLETAPI_OPTIONS_FILE),$(OLD_DOCLETAPI_PACKAGES_FILE))
548 $(JAVADOC_CMD_SMALL) -d $(@D) \
549 @$(OLD_DOCLETAPI_OPTIONS_FILE) @$(OLD_DOCLETAPI_PACKAGES_FILE)
550
551 # Create file with javadoc options in it
552 $(OLD_DOCLETAPI_OPTIONS_FILE):
553 $(prep-target)
554 @($(call COMMON_JAVADOCFLAGS) ; \
555 $(call COMMON_JAVADOCTAGS) ; \
556 $(call OptionOnly,-Xdoclint:all) ; \
557 $(call OptionPair,-system,none) ; \
558 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
559 $(call OptionPair,-addmods,$(OLD_DOCLETAPI_MODULES)) ; \
560 $(call OptionPair,-encoding,ascii) ; \
561 $(call OptionOnly,-breakiterator) ; \
562 $(call OptionPair,-doctitle,$(OLD_DOCLETAPI_DOCTITLE)) ; \
563 $(call OptionPair,-windowtitle,$(OLD_DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
564 $(call OptionPair,-header,$(OLD_DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \
565 $(call OptionPair,-bottom,$(OLD_DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
566 $(call OptionTrip,-group,$(OLD_DOCLETAPI_GROUPNAME),$(OLD_DOCLETAPI_REGEXP)); \
567 $(call OptionTrip,-linkoffline,$(OLD_DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
568 ) >> $@
569
570 # Create a file with the package names in it
571 $(OLD_DOCLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(OLD_DOCLETAPI_PKGS))
572 $(prep-target)
573 $(call PackageFilter,$(OLD_DOCLETAPI_PKGS))
574
575 #############################################################
576 #
577 # tagletapidocs
578 #
579
580 ALL_OTHER_TARGETS += tagletapidocs
581 TAGLETAPI_DOCDIR := $(OLD_DOCLET_DIR)/taglet
582 TAGLETAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
583 TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR))
584 # TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk
585
586 # Temporary directory (special generation rules)
587 TAGLETAPI_TEMPDIR = $(DOCSTMPDIR)/taglets_temp
588
589 # The index.html, options, and packages files
590 TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/com/sun/tools/doclets/Taglet.html
591 TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options
592 TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages
593
594 # The modules required to be documented
595 TAGLETAPI_MODULES = jdk.javadoc
596
597 tagletapidocs: $(TAGLETAPI_INDEX_FILE)
598
599 # Set relative location to core api document root
600 $(TAGLETAPI_INDEX_FILE): GET2DOCSDIR=$(TAGLETAPI2COREAPI)/..
601
602 # Run javadoc if the index file is out of date or missing
603 $(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
604 $(prep-javadoc)
605 $(RM) -r $(TAGLETAPI_TEMPDIR)
606 $(MKDIR) -p $(TAGLETAPI_TEMPDIR)
607 $(call JavadocSummary,$(TAGLETAPI_OPTIONS_FILE),$(TAGLETAPI_PACKAGES_FILE))
608 $(JAVADOC_CMD_SMALL) -d $(TAGLETAPI_TEMPDIR) \
609 @$(TAGLETAPI_OPTIONS_FILE) @$(TAGLETAPI_PACKAGES_FILE)
610 cp -r $(TAGLETAPI_TEMPDIR)/com $(TAGLETAPI_DOCDIR)
611 cp $(TAGLETAPI_TEMPDIR)/stylesheet.css $(TAGLETAPI_DOCDIR)
612 $(RM) -r $(TAGLETAPI_TEMPDIR)
613
614 # Create file with javadoc options in it
615 $(TAGLETAPI_OPTIONS_FILE):
616 $(prep-target)
617 @($(call COMMON_JAVADOCFLAGS) ; \
618 $(call COMMON_JAVADOCTAGS) ; \
619 $(call OptionOnly,-Xdoclint:all) ; \
620 $(call OptionPair,-system,none) ; \
621 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
622 $(call OptionPair,-addmods,$(TAGLETAPI_MODULES)) ; \
623 $(call OptionPair,-encoding,ascii) ; \
624 $(call OptionOnly,-nonavbar) ; \
625 $(call OptionOnly,-noindex) ; \
626 $(call OptionPair,-bottom,$(TAGLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
627 $(call OptionTrip,-linkoffline,$(TAGLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
628 ) >> $@
629
630 # Create a file with the package names in it
631 $(TAGLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(TAGLETAPI_PKGS))
632 $(prep-target)
633 @($(ECHO) "$(LANGTOOLS_TOPDIR)/src/jdk.javadoc/share/classes/$(TAGLETAPI_FILE)" ) > $@
634
635 #############################################################
636 #
637 # domapidocs
638 #
639
640 ALL_OTHER_TARGETS += domapidocs
641
642 DOMAPI_DOCDIR := $(JRE_API_DOCSDIR)/plugin/dom
643 DOMAPI2COREAPI := ../../$(JDKJRE2COREAPI)
644 DOMAPI_DOCTITLE := Common DOM API
645 DOMAPI_WINDOWTITLE := Common DOM API
646 DOMAPI_HEADER := <strong>Common DOM API</strong>
647 DOMAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOMAPI_FIRST_COPYRIGHT_YEAR))
648 DOMAPI_GROUPNAME := Packages
649 DOMAPI_REGEXP := org.w3c.dom*
650 # DOMAPI_PKGS is located in NON_CORE_PKGS.gmk
651
652 # The index.html, options, and packages files
653 DOMAPI_INDEX_FILE = $(DOMAPI_DOCDIR)/index.html
654 DOMAPI_OPTIONS_FILE = $(DOCSTMPDIR)/domapi.options
655 DOMAPI_PACKAGES_FILE = $(DOCSTMPDIR)/domapi.packages
656
657 # The modules required to be documented
658 DOMAPI_MODULES = java.xml,jdk.xml.dom
659
660 domapidocs: $(DOMAPI_INDEX_FILE)
661
662 # Set relative location to core api document root
663 $(DOMAPI_INDEX_FILE): GET2DOCSDIR=$(DOMAPI2COREAPI)/..
664
665 # Run javadoc if the index file is out of date or missing
666 $(DOMAPI_INDEX_FILE): $(DOMAPI_OPTIONS_FILE) $(DOMAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
667 $(prep-javadoc)
668 $(call JavadocSummary,$(DOMAPI_OPTIONS_FILE),$(DOMAPI_PACKAGES_FILE))
669 $(JAVADOC_CMD_SMALL) -d $(@D) \
670 @$(DOMAPI_OPTIONS_FILE) @$(DOMAPI_PACKAGES_FILE)
671
672 # Create file with javadoc options in it
673 $(DOMAPI_OPTIONS_FILE):
674 $(prep-target)
675 @($(call COMMON_JAVADOCFLAGS) ; \
676 $(call COMMON_JAVADOCTAGS) ; \
677 $(call OptionOnly,-Xdoclint:none) ; \
678 $(call OptionPair,-system,none) ; \
679 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
680 $(call OptionPair,-addmods,$(DOMAPI_MODULES)) ; \
681 $(call OptionPair,-encoding,ascii) ; \
682 $(call OptionOnly,-splitIndex) ; \
683 $(call OptionPair,-doctitle,$(DOMAPI_DOCTITLE)) ; \
684 $(call OptionPair,-windowtitle,$(DOMAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
685 $(call OptionPair,-header,$(DOMAPI_HEADER)$(DRAFT_HEADER)) ; \
686 $(call OptionPair,-bottom,$(DOMAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
687 $(call OptionTrip,-group,$(DOMAPI_GROUPNAME),$(DOMAPI_REGEXP)); \
688 $(call OptionTrip,-linkoffline,$(DOMAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
689 ) >> $@
690
691 # Create a file with the package names in it
692 $(DOMAPI_PACKAGES_FILE): $(call PackageDependencies,$(DOMAPI_PKGS))
693 $(prep-target)
694 $(call PackageFilter,$(DOMAPI_PKGS))
695
696 #############################################################
697 #
698 # jpdadocs
699 #
700
701 ALL_OTHER_TARGETS += jpdadocs
702
703 jpdadocs: jdidocs jdwpdocs jvmtidocs
704
705 #############################################################
706 #
707 # jdidocs
708 #
709
710 ALL_OTHER_TARGETS += jdidocs
711
712 JDI_DOCDIR := $(JDK_API_DOCSDIR)/jpda/jdi
713 JDI2COREAPI := ../../$(JDKJRE2COREAPI)
714 JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface
715 JDI_WINDOWTITLE := Java Debug Interface
716 JDI_HEADER := <strong>Java Debug Interface</strong>
717 JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR))
718 JDI_OVERVIEW := $(JDK_TOPDIR)/src/jdk.jdi/share/classes/jdi-overview.html
719 # JDI_PKGS is located in NON_CORE_PKGS.gmk
720
721 # The index.html, options, and packages files
722 JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html
723 JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options
724 JDI_PACKAGES_FILE = $(DOCSTMPDIR)/jdi.packages
725
726 # The modules required to be documented
727 JDI_MODULES = jdk.jdi
728
729 jdidocs: $(JDI_INDEX_FILE)
730
731 # Set relative location to core api document root
732 $(JDI_INDEX_FILE): GET2DOCSDIR=$(JDI2COREAPI)/..
733
734 # Run javadoc if the index file is out of date or missing
735 $(JDI_INDEX_FILE): $(JDI_OPTIONS_FILE) $(JDI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
736 $(prep-javadoc)
737 $(call JavadocSummary,$(JDI_OPTIONS_FILE),$(JDI_PACKAGES_FILE))
738 $(JAVADOC_CMD_SMALL) -d $(@D) \
739 @$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE)
740
741 # Create file with javadoc options in it
742 $(JDI_OPTIONS_FILE): $(JDI_OVERVIEW)
743 $(prep-target)
744 @($(call COMMON_JAVADOCFLAGS) ; \
745 $(call COMMON_JAVADOCTAGS) ; \
746 $(call OptionOnly,-Xdoclint:none) ; \
747 $(call OptionPair,-system,none) ; \
748 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
749 $(call OptionPair,-addmods,$(JDI_MODULES)) ; \
750 $(call OptionPair,-encoding,ascii) ; \
751 $(call OptionPair,-overview,$(JDI_OVERVIEW)) ; \
752 $(call OptionPair,-doctitle,$(JDI_DOCTITLE)) ; \
753 $(call OptionPair,-windowtitle,$(JDI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
754 $(call OptionPair,-header,$(JDI_HEADER)$(DRAFT_HEADER)) ; \
755 $(call OptionPair,-bottom,$(JDI_BOTTOM)$(DRAFT_BOTTOM)) ; \
756 $(call OptionTrip,-linkoffline,$(JDI2COREAPI),$(COREAPI_DOCSDIR)/); \
757 ) >> $@
758
759 # Create a file with the package names in it
760 $(JDI_PACKAGES_FILE): $(call PackageDependencies,$(JDI_PKGS))
761 $(prep-target)
762 $(call PackageFilter,$(JDI_PKGS))
763
764 #############################################################
765 #
766 # jdwpdocs
767 #
768
769 ALL_OTHER_TARGETS += jdwpdocs
770
771 JDWP_DOCDIR = $(PLATFORM_DOCSDIR)/jpda/jdwp
772
773 jdwpdocs: $(JDWP_DOCDIR)/jdwp-protocol.html
774 $(JDWP_DOCDIR)/jdwp-protocol.html : $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html
775 $(MKDIR) -p $(@D)
776 $(RM) $@
777 $(CP) $< $@
778
779 #############################################################
780 #
781 # jvmtidocs
782 #
783
784 ALL_OTHER_TARGETS += jvmtidocs
785
786 JVMTI_DOCDIR = $(PLATFORM_DOCSDIR)/jvmti
787 JVMTI_HTML = $(HOTSPOT_DIST)/docs/platform/jvmti/jvmti.html
788
789 jvmtidocs: $(JVMTI_DOCDIR)/jvmti.html
790 $(JVMTI_DOCDIR)/jvmti.html:
791 @$(prep-javadoc)
792 @if [ -f $(JVMTI_HTML) ] ; then \
793 $(CP) $(JVMTI_HTML) $@; \
794 else \
795 $(ECHO) "WARNING: Generated file does not exist: $(JVMTI_HTML)"; \
796 fi
797
798 #############################################################
799 #
800 # jaasdocs
801 #
802
803 ALL_OTHER_TARGETS += jaasdocs
804
805 JAAS_DOCDIR := $(JRE_API_DOCSDIR)/security/jaas/spec
806 JAAS2COREAPI := ../../../$(JDKJRE2COREAPI)
807 JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service
808 JAAS_WINDOWTITLE := Java Authentication and Authorization Service
809 JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong>
810 JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR))
811 # JAAS_PKGS is located in NON_CORE_PKGS.gmk
812 JAAS_OVERVIEW := $(JDK_TOPDIR)/src/jdk.security.auth/share/classes/jaas-overview.html
813
814 # The index.html, options, and packages files
815 JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html
816 JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options
817 JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages
818
819 # The modules required to be documented
820 JAAS_MODULES = jdk.security.auth
821
822 jaasdocs: $(JAAS_INDEX_FILE)
823
824 # Set relative location to core api document root
825 $(JAAS_INDEX_FILE): GET2DOCSDIR=$(JAAS2COREAPI)/..
826
827 # Run javadoc if the index file is out of date or missing
828 $(JAAS_INDEX_FILE): $(JAAS_OPTIONS_FILE) $(JAAS_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
829 $(prep-javadoc)
830 $(call JavadocSummary,$(JAAS_OPTIONS_FILE),$(JAAS_PACKAGES_FILE))
831 $(JAVADOC_CMD_SMALL) -d $(@D) \
832 @$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE)
833
834 # Create file with javadoc options in it
835 $(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW)
836 $(prep-target)
837 @($(call COMMON_JAVADOCFLAGS) ; \
838 $(call COMMON_JAVADOCTAGS) ; \
839 $(call OptionOnly,-Xdoclint:none) ; \
840 $(call OptionPair,-system,none) ; \
841 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
842 $(call OptionPair,-addmods,$(JAAS_MODULES)) ; \
843 $(call OptionPair,-encoding,ascii) ; \
844 $(call OptionPair,-overview,$(JAAS_OVERVIEW)) ; \
845 $(call OptionPair,-doctitle,$(JAAS_DOCTITLE)) ; \
846 $(call OptionPair,-windowtitle,$(JAAS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
847 $(call OptionPair,-header,$(JAAS_HEADER)$(DRAFT_HEADER)) ; \
848 $(call OptionPair,-bottom,$(JAAS_BOTTOM)$(DRAFT_BOTTOM)) ; \
849 $(call OptionTrip,-linkoffline,$(JAAS2COREAPI),$(COREAPI_DOCSDIR)/); \
850 ) >> $@
851
852 # Create a file with the package names in it
853 $(JAAS_PACKAGES_FILE): $(call PackageDependencies,$(JAAS_PKGS))
854 $(prep-target)
855 $(call PackageFilter,$(JAAS_PKGS))
856
857 #############################################################
858 #
859 # jgssdocs
860 #
861
862 ALL_OTHER_TARGETS += jgssdocs
863
864 JGSS_DOCDIR := $(JRE_API_DOCSDIR)/security/jgss/spec
865 JGSS2COREAPI := ../../../$(JDKJRE2COREAPI)
866 JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities
867 JGSS_WINDOWTITLE := Java GSS-API Utilities
868 JGSS_HEADER := <strong>Java GSS-API Utilities</strong>
869 JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR))
870 JGSS_OVERVIEW := $(JDK_TOPDIR)/src/java.security.jgss/share/classes/jgss-overview.html
871 # JGSS_PKGS is located in NON_CORE_PKGS.gmk
872
873 # The index.html, options, and packages files
874 JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html
875 JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options
876 JGSS_PACKAGES_FILE = $(DOCSTMPDIR)/jgss.packages
877
878 # The modules required to be documented
879 JGSS_MODULES = jdk.security.jgss
880
881 jgssdocs: $(JGSS_INDEX_FILE)
882
883 # Set relative location to core api document root
884 $(JGSS_INDEX_FILE): GET2DOCSDIR=$(JGSS2COREAPI)/..
885
886 # Run javadoc if the index file is out of date or missing
887 $(JGSS_INDEX_FILE): $(JGSS_OPTIONS_FILE) $(JGSS_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
888 $(prep-javadoc)
889 $(call JavadocSummary,$(JGSS_OPTIONS_FILE),$(JGSS_PACKAGES_FILE))
890 $(JAVADOC_CMD_SMALL) -d $(@D) \
891 @$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE)
892
893 # Create file with javadoc options in it
894 $(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW)
895 $(prep-target)
896 @($(call COMMON_JAVADOCFLAGS) ; \
897 $(call COMMON_JAVADOCTAGS) ; \
898 $(call OptionOnly,-Xdoclint:none) ; \
899 $(call OptionPair,-system,none) ; \
900 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
901 $(call OptionPair,-addmods,$(JGSS_MODULES)) ; \
902 $(call OptionPair,-encoding,ascii) ; \
903 $(call OptionOnly,-nodeprecatedlist) ; \
904 $(call OptionPair,-overview,$(JGSS_OVERVIEW)) ; \
905 $(call OptionPair,-doctitle,$(JGSS_DOCTITLE)) ; \
906 $(call OptionPair,-windowtitle,$(JGSS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
907 $(call OptionPair,-header,$(JGSS_HEADER)$(DRAFT_HEADER)) ; \
908 $(call OptionPair,-bottom,$(JGSS_BOTTOM)$(DRAFT_BOTTOM)) ; \
909 $(call OptionTrip,-linkoffline,$(JGSS2COREAPI),$(COREAPI_DOCSDIR)/); \
910 ) >> $@
911
912 # Create a file with the package names in it
913 $(JGSS_PACKAGES_FILE): $(call PackageDependencies,$(JGSS_PKGS))
914 $(prep-target)
915 $(call PackageFilter,$(JGSS_PKGS))
916
917 #############################################################
918 #
919 # smartcardiodocs
920 #
921
922 ALL_OTHER_TARGETS += smartcardiodocs
923
924 SMARTCARDIO_DOCDIR := $(JRE_API_DOCSDIR)/security/smartcardio/spec
925 SMARTCARDIO2COREAPI := ../../../$(JDKJRE2COREAPI)
926 SMARTCARDIO_DOCTITLE := Java$(TRADEMARK) Smart Card I/O
927 SMARTCARDIO_WINDOWTITLE := Java Smart Card I/O
928 SMARTCARDIO_HEADER := <strong>Java Smart Card I/O</strong>
929 SMARTCARDIO_BOTTOM := $(call CommonBottom,$(SMARTCARDIO_FIRST_COPYRIGHT_YEAR))
930 # SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk
931
932 # The index.html, options, and packages files
933 SMARTCARDIO_INDEX_FILE = $(SMARTCARDIO_DOCDIR)/index.html
934 SMARTCARDIO_OPTIONS_FILE = $(DOCSTMPDIR)/smartcardio.options
935 SMARTCARDIO_PACKAGES_FILE = $(DOCSTMPDIR)/smartcardio.packages
936
937 # The modules required to be documented
938 SMARTCARDIO_MODULES = java.smartcardio
939
940 smartcardiodocs: $(SMARTCARDIO_INDEX_FILE)
941
942 # Set relative location to core api document root
943 $(SMARTCARDIO_INDEX_FILE): GET2DOCSDIR=$(SMARTCARDIO2COREAPI)/..
944
945 # Run javadoc if the index file is out of date or missing
946 $(SMARTCARDIO_INDEX_FILE): $(SMARTCARDIO_OPTIONS_FILE) $(SMARTCARDIO_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
947 $(prep-javadoc)
948 $(call JavadocSummary,$(SMARTCARDIO_OPTIONS_FILE),$(SMARTCARDIO_PACKAGES_FILE))
949 $(JAVADOC_CMD_SMALL) -d $(@D) \
950 @$(SMARTCARDIO_OPTIONS_FILE) @$(SMARTCARDIO_PACKAGES_FILE)
951
952 # Create file with javadoc options in it
953 $(SMARTCARDIO_OPTIONS_FILE):
954 $(prep-target)
955 @($(call COMMON_JAVADOCFLAGS) ; \
956 $(call COMMON_JAVADOCTAGS) ; \
957 $(call OptionOnly,-Xdoclint:none) ; \
958 $(call OptionPair,-system,none) ; \
959 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
960 $(call OptionPair,-addmods,$(SMARTCARDIO_MODULES)) ; \
961 $(call OptionPair,-encoding,ascii) ; \
962 $(call OptionOnly,-nodeprecatedlist) ; \
963 $(call OptionPair,-doctitle,$(SMARTCARDIO_DOCTITLE)) ; \
964 $(call OptionPair,-windowtitle,$(SMARTCARDIO_WINDOWTITLE) $(DRAFT_WINTITLE)); \
965 $(call OptionPair,-header,$(SMARTCARDIO_HEADER)$(DRAFT_HEADER)); \
966 $(call OptionPair,-bottom,$(SMARTCARDIO_BOTTOM)$(DRAFT_BOTTOM)); \
967 $(call OptionTrip,-linkoffline,$(SMARTCARDIO2COREAPI),$(COREAPI_DOCSDIR)/); \
968 ) >> $@
969
970 # Create a file with the package names in it
971 $(SMARTCARDIO_PACKAGES_FILE): $(call PackageDependencies,$(SMARTCARDIO_PKGS))
972 $(prep-target)
973 $(call PackageFilter,$(SMARTCARDIO_PKGS))
974
975 #############################################################
976 #
977 # httpserverdocs
978 #
979
980 ALL_OTHER_TARGETS += httpserverdocs
981
982 HTTPSERVER_DOCDIR := $(JRE_API_DOCSDIR)/net/httpserver/spec
983 HTTPSERVER2COREAPI := ../../../$(JDKJRE2COREAPI)
984 HTTPSERVER_DOCTITLE := Java$(TRADEMARK) HTTP Server
985 HTTPSERVER_WINDOWTITLE := Java HTTP Server
986 HTTPSERVER_HEADER := <strong>Java HTTP Server</strong>
987 HTTPSERVER_BOTTOM := $(call CommonBottom,$(HTTPSERVER_FIRST_COPYRIGHT_YEAR))
988 # HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk
989
990 HTTPSERVER_INDEX_HTML = $(HTTPSERVER_DOCDIR)/index.html
991 HTTPSERVER_OPTIONS_FILE = $(DOCSTMPDIR)/httpserver.options
992 HTTPSERVER_PACKAGES_FILE = $(DOCSTMPDIR)/httpserver.packages
993
994 # The modules required to be documented
995 HTTPSERVER_MODULES = jdk.httpserver
996
997 httpserverdocs: $(HTTPSERVER_INDEX_HTML)
998
999 # Set relative location to core api document root
1000 $(HTTPSERVER_INDEX_HTML): GET2DOCSDIR=$(HTTPSERVER2COREAPI)/..
1001
1002 # Run javadoc if the index file is out of date or missing
1003 $(HTTPSERVER_INDEX_HTML): $(HTTPSERVER_OPTIONS_FILE) $(HTTPSERVER_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1004 $(prep-javadoc)
1005 $(call JavadocSummary,$(HTTPSERVER_OPTIONS_FILE),$(HTTPSERVER_PACKAGES_FILE))
1006 $(JAVADOC_CMD_SMALL) -d $(@D) \
1007 @$(HTTPSERVER_OPTIONS_FILE) @$(HTTPSERVER_PACKAGES_FILE)
1008
1009 # Create file with javadoc options in it
1010 $(HTTPSERVER_OPTIONS_FILE):
1011 $(prep-target)
1012 @($(call COMMON_JAVADOCFLAGS) ; \
1013 $(call COMMON_JAVADOCTAGS) ; \
1014 $(call OptionOnly,-Xdoclint:none) ; \
1015 $(call OptionPair,-system,none) ; \
1016 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
1017 $(call OptionPair,-addmods,$(HTTPSERVER_MODULES)) ; \
1018 $(call OptionPair,-encoding,ascii) ; \
1019 $(call OptionOnly,-nodeprecatedlist) ; \
1020 $(call OptionPair,-doctitle,$(HTTPSERVER_DOCTITLE)) ; \
1021 $(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1022 $(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \
1023 $(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \
1024 $(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \
1025 ) >> $@
1026
1027 # Create a file with the package names in it
1028 $(HTTPSERVER_PACKAGES_FILE): $(call PackageDependencies,$(HTTPSERVER_PKGS))
1029 $(prep-target)
1030 $(call PackageFilter,$(HTTPSERVER_PKGS))
1031
1032 #############################################################
1033 #
1034 # jsobjectdocs
1035 #
1036
1037 ALL_OTHER_TARGETS += jsobjectdocs
1038
1039 JSOBJECT_DOCDIR := $(JRE_API_DOCSDIR)/plugin/jsobject
1040 JSOBJECT2COREAPI := ../../$(JDKJRE2COREAPI)
1041 JSOBJECT_DOCTITLE := Java$(TRADEMARK) JSObject Doc
1042 JSOBJECT_WINDOWTITLE := Java JSObject Doc
1043 JSOBJECT_HEADER := <strong>Java JSObject Doc</strong>
1044 JSOBJECT_BOTTOM := $(call CommonBottom,$(JSOBJECT_FIRST_COPYRIGHT_YEAR))
1045 # JSOBJECT_PKGS is located in NON_CORE_PKGS.gmk
1046
1047 JSOBJECT_INDEX_HTML = $(JSOBJECT_DOCDIR)/index.html
1048 JSOBJECT_OPTIONS_FILE = $(DOCSTMPDIR)/jsobject.options
1049 JSOBJECT_PACKAGES_FILE = $(DOCSTMPDIR)/jsobject.packages
1050
1051 # The modules required to be documented
1052 JSOBJECT_MODULES = jdk.jsobject
1053
1054 jsobjectdocs: $(JSOBJECT_INDEX_HTML)
1055
1056 # Set relative location to core api document root
1057 $(JSOBJECT_INDEX_HTML): GET2DOCSDIR=$(JSOBJECT2COREAPI)/..
1058
1059 # Run javadoc if the index file is out of date or missing
1060 $(JSOBJECT_INDEX_HTML): $(JSOBJECT_OPTIONS_FILE) $(JSOBJECT_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1061 $(prep-javadoc)
1062 $(call JavadocSummary,$(JSOBJECT_OPTIONS_FILE),$(JSOBJECT_PACKAGES_FILE))
1063 $(JAVADOC_CMD_SMALL) -d $(@D) \
1064 @$(JSOBJECT_OPTIONS_FILE) @$(JSOBJECT_PACKAGES_FILE)
1065
1066 # Create file with javadoc options in it
1067 $(JSOBJECT_OPTIONS_FILE):
1068 $(prep-target)
1069 @($(call COMMON_JAVADOCFLAGS) ; \
1070 $(call COMMON_JAVADOCTAGS) ; \
1071 $(call OptionOnly,-Xdoclint:none) ; \
1072 $(call OptionPair,-system,none) ; \
1073 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
1074 $(call OptionPair,-addmods,$(JSOBJECT_MODULES)) ; \
1075 $(call OptionPair,-encoding,ascii) ; \
1076 $(call OptionOnly,-nodeprecatedlist) ; \
1077 $(call OptionPair,-doctitle,$(JSOBJECT_DOCTITLE)) ; \
1078 $(call OptionPair,-windowtitle,$(JSOBJECT_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1079 $(call OptionPair,-header,$(JSOBJECT_HEADER)$(DRAFT_HEADER)); \
1080 $(call OptionPair,-bottom,$(JSOBJECT_BOTTOM)$(DRAFT_BOTTOM)); \
1081 $(call OptionTrip,-linkoffline,$(JSOBJECT2COREAPI),$(COREAPI_DOCSDIR)/); \
1082 ) >> $@
1083
1084 # Create a file with the package names in it
1085 $(JSOBJECT_PACKAGES_FILE): $(call PackageDependencies,$(JSOBJECT_PKGS))
1086 $(prep-target)
1087 $(call PackageFilter,$(JSOBJECT_PKGS))
1088
1089
1090 #############################################################
1091 #
1092 # mgmtdocs
1093 #
1094
1095 ALL_OTHER_TARGETS += mgmtdocs
1096
1097 MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension
1098 MGMT2COREAPI := ../../$(JDKJRE2COREAPI)
1099 JVM_MIB_NAME := JVM-MANAGEMENT-MIB.mib
1100 JVM_MIB_SRC := $(JDK_TOPDIR)/src/closed/jdk.snmp/share/classes/sun/management/snmp/$(JVM_MIB_NAME)
1101 MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform
1102 MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform
1103 MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong>
1104 MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR))
1105 MGMT_OVERVIEW := $(JDK_TOPDIR)/src/java.management/share/classes/mgmt-overview.html
1106 # MGMT_PKGS is located in NON_CORE_PKGS.gmk
1107
1108 # The index.html, options, and packages files
1109 MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html
1110 MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options
1111 MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages
1112
1113 # The modules required to be documented
1114 MGMT_MODULES = jdk.management
1115
1116 mgmtdocs: $(MGMT_INDEX_FILE)
1117
1118 # Set relative location to core api document root
1119 $(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/..
1120
1121 # Run javadoc if the index file is out of date or missing
1122 $(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1123 $(prep-javadoc)
1124 @if [ -f $(JVM_MIB_SRC) ] ; then \
1125 $(CP) $(JVM_MIB_SRC) $(@D)/.. ; \
1126 else \
1127 $(ECHO) "WARNING: File $(JVM_MIB_NAME) not available."; \
1128 fi
1129 $(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE))
1130 $(JAVADOC_CMD_SMALL) -d $(@D) \
1131 @$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE)
1132
1133 # Create file with javadoc options in it
1134 $(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW)
1135 $(prep-target)
1136 @($(call COMMON_JAVADOCFLAGS) ; \
1137 $(call COMMON_JAVADOCTAGS) ; \
1138 $(call OptionOnly,-Xdoclint:none) ; \
1139 $(call OptionPair,-system,none) ; \
1140 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
1141 $(call OptionPair,-addmods,$(MGMT_MODULES)) ; \
1142 $(call OptionPair,-encoding,ascii) ; \
1143 $(call OptionOnly,-nodeprecatedlist) ; \
1144 $(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \
1145 $(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \
1146 $(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1147 $(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \
1148 $(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \
1149 $(call OptionTrip,-linkoffline,$(MGMT2COREAPI),$(COREAPI_DOCSDIR)/); \
1150 ) >> $@
1151
1152 # Create a file with the package names in it
1153 $(MGMT_PACKAGES_FILE): $(call PackageDependencies,$(MGMT_PKGS))
1154 $(prep-target)
1155 $(call PackageFilter,$(MGMT_PKGS))
1156
1157 #############################################################
1158 #
1159 # attachdocs
1160 #
1161
1162 ALL_OTHER_TARGETS += attachdocs
1163
1164 ATTACH_DOCDIR := $(JDK_API_DOCSDIR)/attach/spec
1165 ATTACH2COREAPI := ../../$(JDKJRE2COREAPI)
1166 ATTACH_DOCTITLE := Attach API
1167 ATTACH_WINDOWTITLE := Attach API
1168 ATTACH_HEADER := <strong>Attach API</strong>
1169 ATTACH_BOTTOM := $(call CommonBottom,$(ATTACH_FIRST_COPYRIGHT_YEAR))
1170 # ATTACH_PKGS is located in NON_CORE_PKGS.gmk
1171
1172 ATTACH_INDEX_HTML = $(ATTACH_DOCDIR)/index.html
1173 ATTACH_OPTIONS_FILE = $(DOCSTMPDIR)/attach.options
1174 ATTACH_PACKAGES_FILE = $(DOCSTMPDIR)/attach.packages
1175
1176 # The modules required to be documented
1177 ATTACH_MODULES = jdk.attach
1178
1179 attachdocs: $(ATTACH_INDEX_HTML)
1180
1181 # Set relative location to core api document root
1182 $(ATTACH_INDEX_HTML): GET2DOCSDIR=$(ATTACH2COREAPI)/..
1183
1184 # Run javadoc if the index file is out of date or missing
1185 $(ATTACH_INDEX_HTML): $(ATTACH_OPTIONS_FILE) $(ATTACH_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1186 $(prep-javadoc)
1187 $(call JavadocSummary,$(ATTACH_OPTIONS_FILE),$(ATTACH_PACKAGES_FILE))
1188 $(JAVADOC_CMD_SMALL) -d $(@D) \
1189 @$(ATTACH_OPTIONS_FILE) @$(ATTACH_PACKAGES_FILE)
1190
1191 # Create file with javadoc options in it
1192 $(ATTACH_OPTIONS_FILE):
1193 $(prep-target)
1194 @($(call COMMON_JAVADOCFLAGS) ; \
1195 $(call COMMON_JAVADOCTAGS) ; \
1196 $(call OptionOnly,-Xdoclint:none) ; \
1197 $(call OptionPair,-system,none) ; \
1198 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
1199 $(call OptionPair,-addmods,$(ATTACH_MODULES)) ; \
1200 $(call OptionPair,-encoding,ascii) ; \
1201 $(call OptionOnly,-nodeprecatedlist) ; \
1202 $(call OptionPair,-doctitle,$(ATTACH_DOCTITLE)) ; \
1203 $(call OptionPair,-windowtitle,$(ATTACH_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1204 $(call OptionPair,-header,$(ATTACH_HEADER)$(DRAFT_HEADER)) ; \
1205 $(call OptionPair,-bottom,$(ATTACH_BOTTOM)$(DRAFT_BOTTOM)) ; \
1206 $(call OptionTrip,-linkoffline,$(ATTACH2COREAPI),$(COREAPI_DOCSDIR)/); \
1207 ) >> $@
1208
1209 # Create a file with the package names in it
1210 $(ATTACH_PACKAGES_FILE): $(call PackageDependencies,$(ATTACH_PKGS))
1211 $(prep-target)
1212 $(call PackageFilter,$(ATTACH_PKGS))
1213
1214 #############################################################
1215 #
1216 # jconsoledocs
1217 #
1218
1219 ALL_OTHER_TARGETS += jconsoledocs
1220
1221 JCONSOLE_DOCDIR := $(JDK_API_DOCSDIR)/jconsole/spec
1222 JCONSOLE2COREAPI := ../../$(JDKJRE2COREAPI)
1223 JCONSOLE_DOCTITLE := JConsole API
1224 JCONSOLE_WINDOWTITLE := JConsole API
1225 JCONSOLE_HEADER := <strong>JConsole API</strong>
1226 JCONSOLE_BOTTOM := $(call CommonBottom,$(JCONSOLE_FIRST_COPYRIGHT_YEAR))
1227 # JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk
1228
1229 JCONSOLE_INDEX_HTML = $(JCONSOLE_DOCDIR)/index.html
1230 JCONSOLE_OPTIONS_FILE = $(DOCSTMPDIR)/jconsole.options
1231 JCONSOLE_PACKAGES_FILE = $(DOCSTMPDIR)/jconsole.packages
1232
1233 # The modules required to be documented
1234 JCONSOLE_MODULES = jdk.jconsole
1235
1236 jconsoledocs: $(JCONSOLE_INDEX_HTML)
1237
1238 # Set relative location to core api document root
1239 $(JCONSOLE_INDEX_HTML): GET2DOCSDIR=$(JCONSOLE2COREAPI)/..
1240
1241 # Run javadoc if the index file is out of date or missing
1242 $(JCONSOLE_INDEX_HTML): $(JCONSOLE_OPTIONS_FILE) $(JCONSOLE_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1243 $(prep-javadoc)
1244 $(call JavadocSummary,$(JCONSOLE_OPTIONS_FILE),$(JCONSOLE_PACKAGES_FILE))
1245 $(JAVADOC_CMD_SMALL) -d $(@D) \
1246 @$(JCONSOLE_OPTIONS_FILE) @$(JCONSOLE_PACKAGES_FILE)
1247
1248 # Create file with javadoc options in it
1249 $(JCONSOLE_OPTIONS_FILE):
1250 $(prep-target)
1251 @($(call COMMON_JAVADOCFLAGS) ; \
1252 $(call COMMON_JAVADOCTAGS) ; \
1253 $(call OptionOnly,-Xdoclint:none) ; \
1254 $(call OptionPair,-system,none) ; \
1255 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
1256 $(call OptionPair,-addmods,$(JCONSOLE_MODULES)) ; \
1257 $(call OptionPair,-encoding,ascii) ; \
1258 $(call OptionOnly,-nodeprecatedlist) ; \
1259 $(call OptionPair,-doctitle,$(JCONSOLE_DOCTITLE)) ; \
1260 $(call OptionPair,-windowtitle,$(JCONSOLE_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1261 $(call OptionPair,-header,$(JCONSOLE_HEADER)$(DRAFT_HEADER)) ; \
1262 $(call OptionPair,-bottom,$(JCONSOLE_BOTTOM)$(DRAFT_BOTTOM)) ; \
1263 $(call OptionTrip,-linkoffline,$(JCONSOLE2COREAPI),$(COREAPI_DOCSDIR)/); \
1264 ) >> $@
1265
1266 # Create a file with the package names in it
1267 $(JCONSOLE_PACKAGES_FILE): $(call PackageDependencies,$(JCONSOLE_PKGS))
1268 $(prep-target)
1269 $(call PackageFilter,$(JCONSOLE_PKGS))
1270
1271 #############################################################
1272 #
1273 # jshellapidocs
1274 #
1275
1276 ALL_OTHER_TARGETS += jshellapidocs
1277
1278 JSHELLAPI_DOCDIR := $(JDK_API_DOCSDIR)/jshell
1279 JSHELLAPI2COREAPI := ../../$(JDKJRE2COREAPI)
1280 JSHELLAPI_DOCTITLE := JShell API
1281 JSHELLAPI_WINDOWTITLE := JShell API
1282 JSHELLAPI_HEADER := <strong>JSHELL API</strong>
1283 JSHELLAPI_BOTTOM := $(call CommonBottom,$(JSHELLAPI_FIRST_COPYRIGHT_YEAR))
1284 JSHELLAPI_GROUPNAME := Packages
1285 JSHELLAPI_REGEXP := jdk.jshell.*
1286 # JSHELLAPI_PKGS is located in NON_CORE_PKGS.gmk
1287
1288 JSHELLAPI_INDEX_HTML = $(JSHELLAPI_DOCDIR)/index.html
1289 JSHELLAPI_OPTIONS_FILE = $(DOCSTMPDIR)/jshellapi.options
1290 JSHELLAPI_PACKAGES_FILE = $(DOCSTMPDIR)/jshellapi.packages
1291
1292 # The modules required to be documented
1293 JSHELLAPI_MODULES = jdk.jshell
1294
1295 jshellapidocs: $(JSHELLAPI_INDEX_HTML)
1296
1297 # Set relative location to core api document root
1298 $(JSHELLAPI_INDEX_HTML): GET2DOCSDIR=$(JSHELLAPI2COREAPI)/..
1299
1300 # Run javadoc if the index file is out of date or missing
1301 $(JSHELLAPI_INDEX_HTML): $(JSHELLAPI_OPTIONS_FILE) $(JSHELLAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1302 $(prep-javadoc)
1303 $(call JavadocSummary,$(JSHELLAPI_OPTIONS_FILE),$(JSHELLAPI_PACKAGES_FILE))
1304 $(JAVADOC_CMD_SMALL) -d $(@D) \
1305 @$(JSHELLAPI_OPTIONS_FILE) @$(JSHELLAPI_PACKAGES_FILE)
1306
1307 # Create file with javadoc options in it
1308 $(JSHELLAPI_OPTIONS_FILE):
1309 $(prep-target)
1310 @($(call COMMON_JAVADOCFLAGS) ; \
1311 $(call COMMON_JAVADOCTAGS) ; \
1312 $(call OptionOnly,-Xdoclint:all) ; \
1313 $(call OptionPair,-system,none) ; \
1314 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
1315 $(call OptionPair,-addmods,$(JSHELLAPI_MODULES)) ; \
1316 $(call OptionPair,-encoding,ascii) ; \
1317 $(call OptionPair,-doctitle,$(JSHELLAPI_DOCTITLE)) ; \
1318 $(call OptionPair,-windowtitle,$(JSHELLAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1319 $(call OptionPair,-header,$(JSHELLAPI_HEADER)$(DRAFT_HEADER)) ; \
1320 $(call OptionPair,-bottom,$(JSHELLAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1321 $(call OptionTrip,-group,$(JSHELLAPI_GROUPNAME),$(JSHELLAPI_REGEXP)); \
1322 $(call OptionTrip,-linkoffline,$(JSHELLAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1323 ) >> $@
1324
1325 # Create a file with the package names in it
1326 $(JSHELLAPI_PACKAGES_FILE): $(call PackageDependencies,$(JSHELLAPI_PKGS))
1327 $(prep-target)
1328 $(call PackageFilter,$(JSHELLAPI_PKGS))
1329
1330 #############################################################
1331 #
1332 # treeapidocs
1333 #
1334
1335 ALL_OTHER_TARGETS += treeapidocs
1336
1337 TREEAPI_DOCDIR := $(JDK_API_DOCSDIR)/javac/tree
1338 TREEAPI2COREAPI := ../../$(JDKJRE2COREAPI)
1339 TREEAPI_DOCTITLE := Compiler Tree API
1340 TREEAPI_WINDOWTITLE := Compiler Tree API
1341 TREEAPI_HEADER := <strong>Compiler Tree API</strong>
1342 TREEAPI_BOTTOM := $(call CommonBottom,$(TREEAPI_FIRST_COPYRIGHT_YEAR))
1343 TREEAPI_GROUPNAME := Packages
1344 TREEAPI_REGEXP := com.sun.source.*
1345 # TREEAPI_PKGS is located in NON_CORE_PKGS.gmk
1346
1347 TREEAPI_INDEX_HTML = $(TREEAPI_DOCDIR)/index.html
1348 TREEAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options
1349 TREEAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages
1350
1351 # The modules required to be documented
1352 TREEAPI_MODULES = jdk.compiler
1353
1354 treeapidocs: $(TREEAPI_INDEX_HTML)
1355
1356 # Set relative location to core api document root
1357 $(TREEAPI_INDEX_HTML): GET2DOCSDIR=$(TREEAPI2COREAPI)/..
1358
1359 # Run javadoc if the index file is out of date or missing
1360 $(TREEAPI_INDEX_HTML): $(TREEAPI_OPTIONS_FILE) $(TREEAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1361 $(prep-javadoc)
1362 $(call JavadocSummary,$(TREEAPI_OPTIONS_FILE),$(TREEAPI_PACKAGES_FILE))
1363 $(JAVADOC_CMD_SMALL) -d $(@D) \
1364 @$(TREEAPI_OPTIONS_FILE) @$(TREEAPI_PACKAGES_FILE)
1365
1366 # Create file with javadoc options in it
1367 $(TREEAPI_OPTIONS_FILE):
1368 $(prep-target)
1369 @($(call COMMON_JAVADOCFLAGS) ; \
1370 $(call COMMON_JAVADOCTAGS) ; \
1371 $(call OptionOnly,-Xdoclint:all) ; \
1372 $(call OptionPair,-system,none) ; \
1373 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
1374 $(call OptionPair,-addmods,$(TREEAPI_MODULES)) ; \
1375 $(call OptionPair,-encoding,ascii) ; \
1376 $(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \
1377 $(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1378 $(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \
1379 $(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1380 $(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \
1381 $(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1382 ) >> $@
1383
1384 # Create a file with the package names in it
1385 $(TREEAPI_PACKAGES_FILE): $(call PackageDependencies,$(TREEAPI_PKGS))
1386 $(prep-target)
1387 $(call PackageFilter,$(TREEAPI_PKGS))
1388
1389 #############################################################
1390 #
1391 # nashornapidocs
1392 #
1393
1394 ALL_OTHER_TARGETS += nashornapidocs
1395
1396 NASHORNAPI_DOCDIR := $(JDK_API_DOCSDIR)/nashorn
1397 NASHORNAPI2COREAPI := ../$(JDKJRE2COREAPI)
1398 NASHORNAPI_DOCTITLE := Nashorn API
1399 NASHORNAPI_WINDOWTITLE := Nashorn API
1400 NASHORNAPI_HEADER := <strong>Nashorn API</strong>
1401 NASHORNAPI_BOTTOM := $(call CommonBottom,$(NASHORNAPI_FIRST_COPYRIGHT_YEAR))
1402 NASHORNAPI_GROUPNAME := Packages
1403 NASHORNAPI_REGEXP := jdk.nashorn.api.*
1404 # NASHORNAPI_PKGS is located in NON_CORE_PKGS.gmk
1405
1406 NASHORNAPI_INDEX_HTML = $(NASHORNAPI_DOCDIR)/index.html
1407 NASHORNAPI_OPTIONS_FILE = $(DOCSTMPDIR)/nashornapi.options
1408 NASHORNAPI_PACKAGES_FILE = $(DOCSTMPDIR)/nashornapi.packages
1409
1410 # The modules required to be documented
1411 NASHORNAPI_MODULES = jdk.scripting.nashorn
1412
1413 nashornapidocs: $(NASHORNAPI_INDEX_HTML)
1414
1415 # Set relative location to core api document root
1416 $(NASHORNAPI_INDEX_HTML): GET2DOCSDIR=$(NASHORNAPI2COREAPI)/..
1417
1418 # Run javadoc if the index file is out of date or missing
1419 $(NASHORNAPI_INDEX_HTML): $(NASHORNAPI_OPTIONS_FILE) $(NASHORNAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1420 $(prep-javadoc)
1421 $(call JavadocSummary,$(NASHORNAPI_OPTIONS_FILE),$(NASHORNAPI_PACKAGES_FILE))
1422 $(JAVADOC_CMD_SMALL) -d $(@D) \
1423 @$(NASHORNAPI_OPTIONS_FILE) @$(NASHORNAPI_PACKAGES_FILE)
1424
1425 # Create file with javadoc options in it
1426 $(NASHORNAPI_OPTIONS_FILE):
1427 $(prep-target)
1428 @($(call COMMON_JAVADOCFLAGS) ; \
1429 $(call COMMON_JAVADOCTAGS) ; \
1430 $(call OptionOnly,-Xdoclint:all) ; \
1431 $(call OptionPair,-system,none) ; \
1432 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
1433 $(call OptionPair,-addmods,$(NASHORNAPI_MODULES)) ; \
1434 $(call OptionPair,-encoding,ascii) ; \
1435 $(call OptionPair,-doctitle,$(NASHORNAPI_DOCTITLE)) ; \
1436 $(call OptionPair,-windowtitle,$(NASHORNAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1437 $(call OptionPair,-header,$(NASHORNAPI_HEADER)$(DRAFT_HEADER)) ; \
1438 $(call OptionPair,-bottom,$(NASHORNAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1439 $(call OptionTrip,-group,$(NASHORNAPI_GROUPNAME),$(NASHORNAPI_REGEXP)); \
1440 $(call OptionTrip,-linkoffline,$(NASHORNAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1441 ) >> $@
1442
1443 # Create a file with the package names in it
1444 $(NASHORNAPI_PACKAGES_FILE): $(call PackageDependencies,$(NASHORNAPI_PKGS))
1445 $(prep-target)
1446 $(call PackageFilter,$(NASHORNAPI_PKGS))
1447
1448 #############################################################
1449 #
1450 # dynalinkapidocs
1451 #
1452
1453 ALL_OTHER_TARGETS += dynalinkapidocs
1454
1455 DYNALINKAPI_DOCDIR := $(JDK_API_DOCSDIR)/dynalink
1456 DYNALINKAPI2COREAPI := ../$(JDKJRE2COREAPI)
1457 DYNALINKAPI_DOCTITLE := Dynalink API
1458 DYNALINKAPI_WINDOWTITLE := Dynalink API
1459 DYNALINKAPI_HEADER := <strong>Dynalink API</strong>
1460 DYNALINKAPI_BOTTOM := $(call CommonBottom,$(DYNALINKAPI_FIRST_COPYRIGHT_YEAR))
1461 DYNALINKAPI_GROUPNAME := Packages
1462 DYNALINKAPI_REGEXP := jdk.dynalink.*
1463 # DYNALINKAPI_PKGS is located in NON_CORE_PKGS.gmk
1464
1465 DYNALINKAPI_INDEX_HTML = $(DYNALINKAPI_DOCDIR)/index.html
1466 DYNALINKAPI_OPTIONS_FILE = $(DOCSTMPDIR)/dynalinkapi.options
1467 DYNALINKAPI_PACKAGES_FILE = $(DOCSTMPDIR)/dynalinkapi.packages
1468
1469 # The modules required to be documented
1470 DYNALINKAPI_MODULES = jdk.dynalink
1471
1472 dynalinkapidocs: $(DYNALINKAPI_INDEX_HTML)
1473
1474 # Set relative location to core api document root
1475 $(DYNALINKAPI_INDEX_HTML): GET2DOCSDIR=$(DYNALINKAPI2COREAPI)/..
1476
1477 # Run javadoc if the index file is out of date or missing
1478 $(DYNALINKAPI_INDEX_HTML): $(DYNALINKAPI_OPTIONS_FILE) $(DYNALINKAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1479 $(prep-javadoc)
1480 $(call JavadocSummary,$(DYNALINKAPI_OPTIONS_FILE),$(DYNALINKAPI_PACKAGES_FILE))
1481 $(JAVADOC_CMD_SMALL) -d $(@D) \
1482 @$(DYNALINKAPI_OPTIONS_FILE) @$(DYNALINKAPI_PACKAGES_FILE)
1483
1484 # Create file with javadoc options in it
1485 $(DYNALINKAPI_OPTIONS_FILE):
1486 $(prep-target)
1487 @($(call COMMON_JAVADOCFLAGS) ; \
1488 $(call COMMON_JAVADOCTAGS) ; \
1489 $(call OptionOnly,-Xdoclint:all) ; \
1490 $(call OptionPair,-system,none) ; \
1491 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
1492 $(call OptionPair,-addmods,$(DYNALINKAPI_MODULES)) ; \
1493 $(call OptionPair,-encoding,ascii) ; \
1494 $(call OptionPair,-doctitle,$(DYNALINKAPI_DOCTITLE)) ; \
1495 $(call OptionPair,-windowtitle,$(DYNALINKAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1496 $(call OptionPair,-header,$(DYNALINKAPI_HEADER)$(DRAFT_HEADER)) ; \
1497 $(call OptionPair,-bottom,$(DYNALINKAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1498 $(call OptionTrip,-linkoffline,$(DYNALINKAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1499 ) >> $@
1500
1501 # Create a file with the package names in it
1502 $(DYNALINKAPI_PACKAGES_FILE): $(call PackageDependencies,$(DYNALINKAPI_PKGS))
1503 $(prep-target)
1504 $(call PackageFilter,$(DYNALINKAPI_PKGS))
1505
1506 #############################################################
1507 #
1508 # sctpdocs
1509 #
1510
1511 ALL_OTHER_TARGETS += sctpdocs
1512
1513 SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec
1514 SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
1515 SCTPAPI_DOCTITLE := SCTP API
1516 SCTPAPI_WINDOWTITLE := SCTP API
1517 SCTPAPI_HEADER := <strong>SCTP API</strong>
1518 SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR))
1519 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk
1520
1521 SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html
1522 SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options
1523 SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages
1524
1525 # The modules required to be documented
1526 SCTPAPI_MODULES = jdk.sctp
1527
1528 sctpdocs: $(SCTPAPI_INDEX_HTML)
1529
1530 # Set relative location to core api document root
1531 $(SCTPAPI_INDEX_HTML): GET2DOCSDIR=$(SCTPAPI2COREAPI)/..
1532
1533 # Run javadoc if the index file is out of date or missing
1534 $(SCTPAPI_INDEX_HTML): $(SCTPAPI_OPTIONS_FILE) $(SCTPAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1535 $(prep-javadoc)
1536 $(call JavadocSummary,$(SCTPAPI_OPTIONS_FILE),$(SCTPAPI_PACKAGES_FILE))
1537 $(JAVADOC_CMD_SMALL) -d $(@D) \
1538 @$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE)
1539
1540 # Create file with javadoc options in it
1541 $(SCTPAPI_OPTIONS_FILE):
1542 $(prep-target)
1543 @($(call COMMON_JAVADOCFLAGS) ; \
1544 $(call COMMON_JAVADOCTAGS) ; \
1545 $(call OptionOnly,-Xdoclint:none) ; \
1546 $(call OptionPair,-system,none) ; \
1547 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
1548 $(call OptionPair,-addmods,$(SCTPAPI_MODULES)) ; \
1549 $(call OptionPair,-encoding,ascii) ; \
1550 $(call OptionOnly,-nodeprecatedlist) ; \
1551 $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \
1552 $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1553 $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \
1554 $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1555 $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1556 ) >> $@
1557
1558 # Create a file with the package names in it
1559 $(SCTPAPI_PACKAGES_FILE): $(call PackageDependencies,$(SCTPAPI_PKGS))
1560 $(prep-target)
1561 $(call PackageFilter,$(SCTPAPI_PKGS))
1562
1563 #############################################################
1564 #
1565 # jaccessdocs - Java Accessibility Utilities
1566 #
1567
1568 ALL_OTHER_TARGETS += jaccessdocs
1569
1570 JACCESSAPI_DOCDIR := $(JRE_API_DOCSDIR)/accessibility/jaccess/spec
1571 JACCESSAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
1572 JACCESSAPI_DOCTITLE := JACCESS API
1573 JACCESSAPI_WINDOWTITLE := JACCESS API
1574 JACCESSAPI_HEADER := <strong>JACCESS API</strong>
1575 JACCESSAPI_BOTTOM := $(call CommonBottom,$(JACCESSAPI_FIRST_COPYRIGHT_YEAR))
1576 # JACCESSAPI_PKGS is located in NON_CORE_PKGS.gmk
1577
1578 JACCESSAPI_INDEX_HTML = $(JACCESSAPI_DOCDIR)/index.html
1579 JACCESSAPI_OPTIONS_FILE = $(DOCSTMPDIR)/jaccess.options
1580 JACCESSAPI_PACKAGES_FILE = $(DOCSTMPDIR)/jaccess.packages
1581
1582 # The modules required to be documented
1583 JACCESSAPI_MODULES = jdk.accessibility
1584
1585 jaccessdocs: $(JACCESSAPI_INDEX_HTML)
1586
1587 # Set relative location to core api document root
1588 $(JACCESSAPI_INDEX_HTML): GET2DOCSDIR=$(JACCESSAPI2COREAPI)/..
1589
1590 # Run javadoc if the index file is out of date or missing
1591 $(JACCESSAPI_INDEX_HTML): $(JACCESSAPI_OPTIONS_FILE) $(JACCESSAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1592 $(prep-javadoc)
1593 $(call JavadocSummary,$(JACCESSAPI_OPTIONS_FILE),$(JACCESSAPI_PACKAGES_FILE))
1594 $(JAVADOC_CMD) -d $(@D) \
1595 @$(JACCESSAPI_OPTIONS_FILE) @$(JACCESSAPI_PACKAGES_FILE)
1596
1597 # Create file with javadoc options in it
1598 $(JACCESSAPI_OPTIONS_FILE):
1599 $(prep-target)
1600 @($(call COMMON_JAVADOCFLAGS) ; \
1601 $(call COMMON_JAVADOCTAGS) ; \
1602 $(call OptionOnly,-Xdoclint:all) ; \
1603 $(call OptionPair,-system,none) ; \
1604 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
1605 $(call OptionPair,-addmods,$(JACCESSAPI_MODULES)) ; \
1606 $(call OptionPair,-encoding,ascii) ; \
1607 $(call OptionOnly,-nodeprecatedlist) ; \
1608 $(call OptionPair,-doctitle,$(JACCESSAPI_DOCTITLE)) ; \
1609 $(call OptionPair,-windowtitle,$(JACCESSAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1610 $(call OptionPair,-header,$(JACCESSAPI_HEADER)$(DRAFT_HEADER)) ; \
1611 $(call OptionPair,-bottom,$(JACCESSAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1612 $(call OptionTrip,-linkoffline,$(JACCESSAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1613 ) >> $@
1614
1615 # Create a file with the package names in it
1616 $(JACCESSAPI_PACKAGES_FILE): $(call PackageDependencies,$(JACCESSAPI_PKGS))
1617 $(prep-target)
1618 $(call PackageFilter,$(JACCESSAPI_PKGS))
1619
1620 #############################################################
1621 #
1622 # jdk.net docs
1623 #
1624
1625 ALL_OTHER_TARGETS += jdknetdocs
1626
1627 JDKNET_DOCDIR := $(JRE_API_DOCSDIR)/net/socketoptions/spec
1628 JDKNET2COREAPI := ../../../$(JDKJRE2COREAPI)
1629 JDKNET_DOCTITLE := jdk.net API
1630 JDKNET_WINDOWTITLE := jdk.net API
1631 JDKNET_HEADER := <strong>jdk.net API</strong>
1632 JDKNET_BOTTOM := $(call CommonBottom,$(JDKNET_FIRST_COPYRIGHT_YEAR))
1633 JDKNET_PKGS := jdk.net
1634
1635 JDKNET_INDEX_HTML = $(JDKNET_DOCDIR)/index.html
1636 JDKNET_OPTIONS_FILE = $(DOCSTMPDIR)/jdknet.options
1637 JDKNET_PACKAGES_FILE = $(DOCSTMPDIR)/jdknet.packages
1638
1639 # The modules required to be documented
1640 JDKNET_MODULES = jdk.net
1641
1642 jdknetdocs: $(JDKNET_INDEX_HTML)
1643
1644 # Set relative location to core api document root
1645 $(JDKNET_INDEX_HTML): GET2DOCSDIR=$(JDKNET2COREAPI)/..
1646
1647 # Run javadoc if the index file is out of date or missing
1648 $(JDKNET_INDEX_HTML): $(JDKNET_OPTIONS_FILE) $(JDKNET_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1649 $(prep-javadoc)
1650 $(call JavadocSummary,$(JDKNET_OPTIONS_FILE),$(JDKNET_PACKAGES_FILE))
1651 $(JAVADOC_CMD_SMALL) -d $(@D) \
1652 @$(JDKNET_OPTIONS_FILE) @$(JDKNET_PACKAGES_FILE)
1653
1654 # Create file with javadoc options in it
1655 $(JDKNET_OPTIONS_FILE):
1656 $(prep-target)
1657 @($(call COMMON_JAVADOCFLAGS) ; \
1658 $(call COMMON_JAVADOCTAGS) ; \
1659 $(call OptionOnly,-Xdoclint:none) ; \
1660 $(call OptionPair,-system,none) ; \
1661 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
1662 $(call OptionPair,-addmods,$(JDKNET_MODULES)) ; \
1663 $(call OptionPair,-encoding,ascii) ; \
1664 $(call OptionOnly,-nodeprecatedlist) ; \
1665 $(call OptionPair,-doctitle,$(JDKNET_DOCTITLE)) ; \
1666 $(call OptionPair,-windowtitle,$(JDKNET_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1667 $(call OptionPair,-header,$(JDKNET_HEADER)$(DRAFT_HEADER)); \
1668 $(call OptionPair,-bottom,$(JDKNET_BOTTOM)$(DRAFT_BOTTOM)); \
1669 $(call OptionTrip,-linkoffline,$(JDKNET2COREAPI),$(COREAPI_DOCSDIR)/); \
1670 ) >> $@
1671
1672 # Create a file with the package names in it
1673 $(JDKNET_PACKAGES_FILE): $(call PackageDependencies,$(JDKNET_PKGS))
1674 $(prep-target)
1675 $(call PackageFilter,$(JDKNET_PKGS))
1676
1677 #############################################################
1678 #
1679 # jlink plugin API docs
1680 #
1681 # TODO: Need to decide when the plugin API is ready to publish as experimental API.
1682 # This target is temporarily added for internal use for now.
1683 #
1684
1685 ALL_OTHER_TARGETS += jlinkdocs
1686
1687 JLINK_PLUGIN_FIRST_COPYRIGHT_YEAR = 2015
1688 JLINK_PLUGIN_DOCDIR := $(JDK_API_DOCSDIR)/jlink
1689 JLINK_PLUGIN2COREAPI := ../$(JDKJRE2COREAPI)
1690 JLINK_PLUGIN_DOCTITLE := JLink Plugin API - EXPERIMENTAL
1691 JLINK_PLUGIN_WINDOWTITLE := JLink Plugin API - EXPERIMENTAL
1692 JLINK_PLUGIN_HEADER := <strong>JLink Plugin API - EXPERIMENTAL</strong>
1693 JLINK_PLUGIN_BOTTOM := $(call CommonBottom,$(JLINK_PLUGIN_FIRST_COPYRIGHT_YEAR))
1694 JLINK_PLUGIN_PKGS = jdk.tools.jlink.plugin
1695
1696 JLINK_PLUGIN_INDEX_HTML = $(JLINK_PLUGIN_DOCDIR)/index.html
1697 JLINK_PLUGIN_OPTIONS_FILE = $(DOCSTMPDIR)/jlinkplugins.options
1698 JLINK_PLUGIN_PACKAGES_FILE = $(DOCSTMPDIR)/jlinkplugins.packages
1699
1700 # The modules required to be documented
1701 JLINK_PLUGIN_MODULES = jdk.jlink
1702
1703 jlinkdocs: $(JLINK_PLUGIN_INDEX_HTML)
1704
1705 # Set relative location to core api document root
1706 $(JLINK_PLUGIN_INDEX_HTML): GET2DOCSDIR=$(JLINK_PLUGIN2COREAPI)/..
1707
1708 # Run javadoc if the index file is out of date or missing
1709 $(JLINK_PLUGIN_INDEX_HTML): $(JLINK_PLUGIN_OPTIONS_FILE) $(JLINK_PLUGIN_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1710 $(prep-javadoc)
1711 $(call JavadocSummary,$(JLINK_PLUGIN_OPTIONS_FILE),$(JLINK_PLUGIN_PACKAGES_FILE))
1712 $(JAVADOC_CMD_SMALL) -d $(@D) \
1713 @$(JLINK_PLUGIN_OPTIONS_FILE) @$(JLINK_PLUGIN_PACKAGES_FILE)
1714
1715 # Create file with javadoc options in it
1716 $(JLINK_PLUGIN_OPTIONS_FILE):
1717 $(prep-target)
1718 @($(call COMMON_JAVADOCFLAGS) ; \
1719 $(call COMMON_JAVADOCTAGS) ; \
1720 $(call OptionOnly,-Xdoclint:none) ; \
1721 $(call OptionPair,-system,none) ; \
1722 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
1723 $(call OptionPair,-addmods,$(JLINK_PLUGIN_MODULES)) ; \
1724 $(call OptionPair,-encoding,ascii) ; \
1725 $(call OptionOnly,-nodeprecatedlist) ; \
1726 $(call OptionPair,-doctitle,$(JLINK_PLUGIN_DOCTITLE)) ; \
1727 $(call OptionPair,-windowtitle,$(JLINK_PLUGIN_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1728 $(call OptionPair,-header,$(JLINK_PLUGIN_HEADER)$(DRAFT_HEADER)); \
1729 $(call OptionPair,-bottom,$(JLINK_PLUGIN_BOTTOM)$(DRAFT_BOTTOM)); \
1730 $(call OptionTrip,-linkoffline,$(JLINK_PLUGIN2COREAPI),$(COREAPI_DOCSDIR)/); \
1731 ) >> $@
1732
1733 # Create a file with the package names in it
1734 $(JLINK_PLUGIN_PACKAGES_FILE): $(call PackageDependencies,$(JLINK_PLUGIN_PKGS))
1735 $(prep-target)
1736 $(call PackageFilter,$(JLINK_PLUGIN_PKGS))
1737
1738
1739 otherdocs: $(ALL_OTHER_TARGETS)
1740
1741 #
1742 # Add the core docs as prerequisite to the archive to trigger a rebuild
1743 # if the core docs were rebuilt. Ideally any doc rebuild should trigger
1744 # this, but the way prerequisites are currently setup in this file, that
1745 # is hard to achieve.
1746 #
1747
1748 $(JAVADOC_ARCHIVE): $(COREAPI_INDEX_FILE)
1749 $(call LogInfo, Compressing javadoc to single $(JAVADOC_ARCHIVE_NAME))
1750 $(MKDIR) -p $(JAVADOC_ARCHIVE_DIR)
1751 $(RM) -r $(JAVADOC_ARCHIVE_ASSEMBLY_DIR)
1752 $(MKDIR) -p $(JAVADOC_ARCHIVE_ASSEMBLY_DIR)
1753 all_roots=`$(FIND) $(DOCSDIR) | $(GREP) index.html | grep -v old/doclet`; \
1754 pushd $(JAVADOC_ARCHIVE_ASSEMBLY_DIR); \
1755 for index_file in $${all_roots} ; do \
1756 target_dir=`dirname $${index_file}`; \
1757 name=`$(ECHO) $${target_dir} | $(SED) "s;/spec;;" | $(SED) "s;.*/;;"`; \
1758 $(LN) -s $${target_dir} $${name}; \
1759 done; \
1760 $(ZIP) -q -r $(JAVADOC_ARCHIVE) * ; \
1761 popd ;
1762
1763 #############################################################
1764 .PHONY: all docs coredocs otherdocs \
1765 $(ALL_OTHER_TARGETS) zip-docs