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