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