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