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