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