Mercurial > jdk8-mips64-public / file revision
common/makefiles/javadoc/Javadoc.gmk@2e12a508d7ae
common/makefiles/javadoc/Javadoc.gmk
Sun, 20 Jan 2013 23:35:25 -0800
- author
- lana
- date
- Sun, 20 Jan 2013 23:35:25 -0800
- changeset 594
- 2e12a508d7ae
- parent 592
- 1129fb75f611
- parent 558
- d5f3a6f60d51
- child 607
- 12782ec1da5f
- permissions
- -rw-r--r--
Merge
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 #
25 include $(SPEC)
26 include MakeBase.gmk
28 .SUFFIXES: # Delete the default suffixes
29 .SUFFIXES: .java
31 #
32 # Definitions for $(DOCSDIR), $(MKDIR), $(BINDIR), etc.
33 #
35 DOCSDIR=$(OUTPUT_ROOT)/docs
36 TEMPDIR=$(OUTPUT_ROOT)/docstemp
38 JDK_SHARE_SRC=$(JDK_TOPDIR)/src/share
39 JDK_SHARE_CLASSES=$(JDK_SHARE_SRC)/classes
41 JDK_IMPSRC = $(JDK_OUTPUTDIR)/impsrc
43 JDK_GENSRC = $(JDK_OUTPUTDIR)/gensrc
45 HOTSPOT_DOCS_IMPORT_PATH=$(HOTSPOT_OUTPUTDIR)/docs
47 BUILD_NUMBER=$(JDK_BUILD_NUMBER)
49 BOOT_JAVA_CMD=$(JAVA)
51 JAVADOC_JAR = $(LANGTOOLS_DIST)/bootstrap/lib/javadoc.jar
52 JAVADOC_CMD = $(BOOT_JAVA_CMD) \
53 -Xmx1024m \
54 -Djava.awt.headless=true \
55 "-Xbootclasspath/p:$(JAVADOC_JAR)" \
56 -jar $(JAVADOC_JAR) -bootclasspath $(JDK_OUTPUTDIR)/classes
58 # Copyright year for beginning of Java and some of the apis
59 # (Needed when creating the javadocs)
60 FIRST_COPYRIGHT_YEAR = 1993
61 DOMAPI_FIRST_COPYRIGHT_YEAR = 2005
62 MIRROR_FIRST_COPYRIGHT_YEAR = 2004
63 DOCLETAPI_FIRST_COPYRIGHT_YEAR = 1993
64 TAGLETAPI_FIRST_COPYRIGHT_YEAR = 1993
65 JDI_FIRST_COPYRIGHT_YEAR = 1999
66 JAAS_FIRST_COPYRIGHT_YEAR = 1998
67 JGSS_FIRST_COPYRIGHT_YEAR = 2000
68 SMARTCARDIO_FIRST_COPYRIGHT_YEAR = 2005
69 HTTPSERVER_FIRST_COPYRIGHT_YEAR = 2005
70 MGMT_FIRST_COPYRIGHT_YEAR = 2003
71 ATTACH_FIRST_COPYRIGHT_YEAR = 2005
72 JCONSOLE_FIRST_COPYRIGHT_YEAR = 2006
73 SCTPAPI_FIRST_COPYRIGHT_YEAR = 2009
74 TRACING_FIRST_COPYRIGHT_YEAR = 2008
75 TREEAPI_FIRST_COPYRIGHT_YEAR = 2005
76 JNLP_FIRST_COPYRIGHT_YEAR = 1998
77 PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007
79 # Oracle name
80 FULL_COMPANY_NAME = Oracle and/or its affiliates
82 # Copyright address
83 COMPANY_ADDRESS = 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA.
85 # The trademark symbol
86 TRADEMARK = ™
88 # Common copyright lines used
89 # The word "Copyright" might optionally be a link to the file cpyr.html.
90 # The first year of copyright may vary or not be available.
91 # The address to the company might be optional.
92 COMMA:= ,
93 EMPTY:=
94 SPACE:=$(EMPTY) $(EMPTY)
95 COPYRIGHT_SYMBOL = &\#x00a9;
96 # Macro to construct the copyright line
97 # (The GNU make 3.78.1 "if" conditional is broken, fixed in GNU make 3.81)
98 define CopyrightLine # optionalurl optionalfirstyear optionaladdress
99 $(if $(strip $1),<a href="$(strip $1)">Copyright</a>,Copyright) \
100 $(COPYRIGHT_SYMBOL) $(if $2,$2${COMMA},) $(COPYRIGHT_YEAR),\
101 $(FULL_COMPANY_NAME). $3 All rights reserved.
102 endef
104 # Url to root of documents
105 DOCSDIR_URL = {@docroot}/$(GET2DOCSDIR)
107 # Url to copyright html file
108 COPYRIGHT_URL-7 = $(DOCSDIR_URL)/legal/cpyr.html
109 # This isn't added in old build yet.
110 #COPYRIGHT_URL-8 = $(DOCSDIR_URL)/legal/cpyr.html
111 COPYRIGHT_URL = $(COPYRIGHT_URL-$(JDK_MINOR_VERSION))
113 # Url to bug filing site
114 BUG_SUBMIT_URL = http://bugreport.sun.com/bugreport/
116 # Common line for how to submit a bug or rfe
117 BUG_SUBMIT_LINE = <a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a>
119 # Url to devdocs page
120 # Was: http://java.sun.com/javase/6/webnotes/devdocs-vs-specs.html
121 DEV_DOCS_URL-7 = http://download.oracle.com/javase/7/docs/index.html
122 # This isn't added in old build yet.
123 #DEV_DOCS_URL-8 = http://download.oracle.com/javase/7/docs/index.html
124 DEV_DOCS_URL = $(DEV_DOCS_URL-$(JDK_MINOR_VERSION))
125 DOCS_BASE_URL = http://download.oracle.com/javase/7/docs
127 # Common Java trademark line
128 JAVA_TRADEMARK_LINE = Java is a trademark or registered trademark of \
129 $(FULL_COMPANY_NAME) in the US and other countries.
131 #################################################################
132 # Macros:
135 # List of all possible directories for javadoc to look for sources
136 # NOTE: Quotes are required around sourcepath argument only on Windows.
137 # Otherwise, you get "No packages or classes specified." due
138 # to $(PATH_SEP) being interpreted as an end of
139 # command (newline or shell ; character)
140 ALL_SOURCE_DIRS = $(JDK_SHARE_CLASSES) \
141 $(JDK_IMPSRC) \
142 $(JDK_GENSRC) \
143 $(JDK_OUTPUTDIR)/gendocsrc_rmic \
144 $(JDK_TOPDIR)/src/solaris/classes \
145 $(JDK_TOPDIR)/src/windows/classes \
146 $(JDK_SHARE_SRC)/doc/stub
148 # List of directories that actually exist
149 ALL_EXISTING_SOURCE_DIRS := $(wildcard $(ALL_SOURCE_DIRS))
151 # List with classpath separator between them
152 EMPTY:=
153 SPACE:= $(EMPTY) $(EMPTY)
154 RELEASEDOCS_SOURCEPATH = \
155 $(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_SOURCE_DIRS)))
157 define prep-target
158 $(MKDIR) -p $(@D)
159 $(RM) $@
160 endef
162 # Prep for javadoc creation, assumes $@ is an index.html file
163 define prep-javadoc
164 @if [ -f "$@" -a "$?" != "" ] ; then \
165 $(ECHO) "# Dependencies have changed: $?"; \
166 fi
167 $(RM) -r $(@D)
168 $(MKDIR) -p $(@D)
169 endef
171 # A cache of the directories in ALL_SOURCE_DIRS
172 DIRECTORY_CACHE = $(DOCSTMPDIR)/directory.cache
174 # Given a list of packages, return a list of files or dirs to be dependent on
175 # (Currently only returning a list of directories)
176 define PackageDependencies # packages
177 $(shell \
178 if [ "$1" != "" -a -f $(DIRECTORY_CACHE) ] ; then \
179 for p in $1 ; do \
180 pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \
181 $(CAT) $(DIRECTORY_CACHE) | $(GREP) "/$${pd}/" ; \
182 done; \
183 fi \
184 )
185 endef
187 # Given a list of packages, add packages that exist to $@, print summary
188 define PackageFilter # packages
189 @if [ "$1" != "" ] ; then \
190 for p in $1 ; do \
191 pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \
192 found="false"; \
193 for cp in $(ALL_SOURCE_DIRS) ; do \
194 if [ -d $${cp}/$${pd} ] ; then \
195 $(ECHO) "$${p}" >> $@; \
196 found="true"; \
197 break; \
198 fi; \
199 done; \
200 if [ "$${found}" = "false" ] ; then \
201 $(ECHO) "WARNING: Package not found: $${p}"; \
202 fi; \
203 done; \
204 fi
205 endef
207 # Print out a summary of the javadoc command about to be run
208 define JavadocSummary # optionsfile packagesfile
209 @$(ECHO) "# Summary for $@";\
210 $(ECHO) "# Options (`$(BASENAME) $1`):"; $(SED) -e 's@^@# @' $1; \
211 $(ECHO) "# Packages (`$(BASENAME) $2`):";$(SED) -e 's@^@# @' $2
212 endef
214 #
215 # Temporary directory for javadoc creation
216 #
217 DOCSTMPDIR = $(TEMPDIR)/doctmp
219 #
220 # Different api directories created from root directory
221 #
222 COREAPI_DOCSDIR = $(DOCSDIR)/api
223 JDK_API_DOCSDIR = $(DOCSDIR)/jdk/api
224 JRE_API_DOCSDIR = $(DOCSDIR)/jre/api
225 PLATFORM_DOCSDIR = $(DOCSDIR)/platform
227 # The non-core api javadocs need to be able to access the root of the core
228 # api directory, so for jdk/api or jre/api to get to the core api/
229 # directory we would use this:
230 JDKJRE2COREAPI = ../../api
232 # Common bottom argument
233 define CommonBottom # year
234 <font size="-1"><br> $(call CopyrightLine,,$1,)</font>
235 endef
237 # Common trademark bottom argument (Not sure why this is used sometimes)
238 define CommonTrademarkBottom # year
239 <font size="-1">\
240 $(BUG_SUBMIT_LINE)<br>$(JAVA_TRADEMARK_LINE)<br>\
241 $(call CopyrightLine,,$1,$(COMPANY_ADDRESS))\
242 </font>
243 endef
245 # Common echo of option
246 define OptionOnly # opt
247 $(PRINTF) "%s\n" "$1"
248 endef
249 define OptionPair # opt arg
250 $(PRINTF) "%s '%s'\n" "$1" '$2'
251 endef
252 define OptionTrip # opt arg arg
253 $(PRINTF) "%s '%s' '%s'\n" "$1" '$2' '$3'
254 endef
256 # Core api bottom argument (with special sauce)
257 COREAPI_BOTTOM = <font size="-1"> $(BUG_SUBMIT_LINE)\
258 <br>For further API reference and developer documentation, \
259 see <a href="$(DEV_DOCS_URL)" target="_blank">Java SE Documentation</a>. \
260 That documentation contains more detailed, developer-targeted descriptions, \
261 with conceptual overviews, definitions of terms, workarounds, \
262 and working code examples.<br>\
263 $(call CopyrightLine,$(COPYRIGHT_URL),$(FIRST_COPYRIGHT_YEAR),)\
264 </font>
266 # Common javadoc options used by all
267 COMMON_JAVADOCFLAGS = \
268 -XDignore.symbol.file=true \
269 -quiet \
270 -use \
271 -keywords \
272 -Xdoclint:none \
273 $(ADDITIONAL_JAVADOCFLAGS)
275 ifdef OPENJDK
276 ADDITIONAL_JAVADOCFLAGS = \
277 -Xdocrootparent $(DOCS_BASE_URL)
278 else
279 ADDITIONAL_JAVADOCFLAGS =
280 endif
282 # Draft used for non-fcs documents
283 DRAFT_HEADER =
284 ifneq ($(MILESTONE), fcs)
285 DRAFT_HEADER = <br><strong>DRAFT $(MILESTONE)-$(BUILD_NUMBER)</strong>
286 DRAFT_BOTTOM = <br><strong>DRAFT $(MILESTONE)-$(BUILD_NUMBER)</strong>
287 DRAFT_WINTITLE = $(BUILD_NUMBER)
288 # Early access top text (not used in FCS releases)
289 COREAPI_TOP_EARLYACCESS = \
290 <div style="background-color: \#EEEEEE"> \
291 <div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; \
292 margin-left: 6px; margin-right: 6px; text-align: justify; \
293 font-size: 80%; font-family: Helvetica, Arial, sans-serif; \
294 font-weight: normal;"> \
295 Please note that the specifications and other information \
296 contained herein are not final and are subject to change. \
297 The information is being made available to you solely for purpose of \
298 evaluation. \
299 </div> </div>
300 endif
302 #################################################################
304 #
305 # CORE_PKGS environment variable has been moved to the following file
306 #
307 include CORE_PKGS.gmk
309 #
310 # Load environment variables for API package names that are not part of
311 # the Java SE platform
312 #
313 include NON_CORE_PKGS.gmk
315 #################################################################
317 #
318 # Default target is same as docs target, create core api and all others it can
319 #
321 all: docs
322 docs: coredocs otherdocs
324 #################################################################
325 # Production Targets -- USE THESE TARGETS WHEN:
326 # a) You're generating docs outside of release engineering's
327 # standard control build.
328 # b) The docs will be pushed to the web and/or included in
329 # the downloaded doc bundle.
330 #
331 # See: Notes.html#releaseTargets
332 # Note: Spaces precede ifdef/ifndef indents. Tabs precede target commands (!)
333 #
335 sanitycheckcoredocs:
336 @$(ECHO) ""
337 @$(ECHO) "Building core api docs with these values:"
338 @$(ECHO) " BUILD_NUMBER = $(BUILD_NUMBER)"
339 @$(ECHO) " MILESTONE = $(MILESTONE)"
340 @$(ECHO) ""
341 ifeq ($(BUILD_NUMBER), b00)
342 @$(ECHO) "ERROR: Build number must be defined"
343 @$(ECHO) "MILESTONE is set to $(MILESTONE)"
344 @$(ECHO) ""
345 exit 1
346 endif
348 #############################################################
349 #
350 # coredocs
351 #
352 COREAPI_DOCTITLE = Java$(TRADEMARK) Platform, Standard Edition \
353 $(JDK_MINOR_VERSION)<br>API Specification
354 COREAPI_WINDOWTITLE = Java Platform SE $(JDK_MINOR_VERSION)
355 COREAPI_HEADER = \
356 <strong>Java$(TRADEMARK) Platform<br>Standard Ed. $(JDK_MINOR_VERSION)</strong>
358 # Java language specification cite
359 TAG_JLS = jls:a:See <cite> \
360 The Java™ Language Specification</cite>:
362 # Overview file for core apis
363 COREAPI_OVERVIEW = $(JDK_SHARE_CLASSES)/overview-core.html
365 # The index.html, options, and packages files
366 COREAPI_INDEX_FILE = $(COREAPI_DOCSDIR)/index.html
367 COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options
368 COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages
370 coredocs: $(COREAPI_INDEX_FILE)
372 # Set relative location to core api document root
373 $(COREAPI_INDEX_FILE): GET2DOCSDIR=..
375 # Run javadoc if the index file is out of date or missing
376 $(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE)
377 $(prep-javadoc)
378 $(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE))
379 $(JAVADOC_CMD) -d $(@D) \
380 @$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE)
382 # Create file with javadoc options in it
383 $(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW)
384 $(prep-target)
385 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
386 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
387 $(call OptionPair,-encoding,ISO-8859-1) ; \
388 $(call OptionPair,-tag,beaninfo:X) ; \
389 $(call OptionPair,-tag,revised:X) ; \
390 $(call OptionPair,-tag,since.unbundled:X) ; \
391 $(call OptionPair,-tag,spec:X) ; \
392 $(call OptionPair,-tag,specdefault:X) ; \
393 $(call OptionPair,-tag,Note:X) ; \
394 $(call OptionPair,-tag,ToDo:X) ; \
395 $(call OptionPair,-tag,$(TAG_JLS)) ; \
396 $(call OptionOnly,-splitIndex) ; \
397 $(call OptionPair,-overview,$(COREAPI_OVERVIEW)) ; \
398 $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE)) ; \
399 $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ;\
400 $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER)) ; \
401 $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
402 ) >> $@
403 ifdef COREAPI_TOP_EARLYACCESS
404 @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@
405 endif
407 # Create a file with the package names in it
408 $(COREAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(CORE_PKGS))
409 $(prep-target)
410 $(call PackageFilter,$(CORE_PKGS))
412 #############################################################
413 #
414 # docletapidocs
415 #
417 ALL_OTHER_TARGETS += docletapidocs
419 DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet
420 DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
421 DOCLETAPI_DOCTITLE := Doclet API
422 DOCLETAPI_WINDOWTITLE := Doclet API
423 DOCLETAPI_HEADER := <strong>Doclet API</strong>
424 DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
425 DOCLETAPI_GROUPNAME := Packages
426 DOCLETAPI_REGEXP := com.sun.javadoc
427 # DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
429 # The index.html, options, and packages files
430 DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html
431 DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options
432 DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages
434 docletapidocs: $(DOCLETAPI_INDEX_FILE)
436 # Set relative location to core api document root
437 $(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/..
439 # Run javadoc if the index file is out of date or missing
440 $(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) coredocs
441 $(prep-javadoc)
442 $(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE))
443 $(JAVADOC_CMD) -d $(@D) \
444 @$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE)
446 # Create file with javadoc options in it
447 $(DOCLETAPI_OPTIONS_FILE):
448 $(prep-target)
449 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
450 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
451 $(call OptionPair,-encoding,ascii) ; \
452 $(call OptionOnly,-breakiterator) ; \
453 $(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \
454 $(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\
455 $(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \
456 $(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
457 $(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \
458 $(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
459 ) >> $@
461 # Create a file with the package names in it
462 $(DOCLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOCLETAPI_PKGS))
463 $(prep-target)
464 $(call PackageFilter,$(DOCLETAPI_PKGS))
466 #############################################################
467 #
468 # tagletapidocs
469 #
471 ALL_OTHER_TARGETS += tagletapidocs
472 TAGLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/taglet
473 TAGLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
474 TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR))
475 # TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk
477 # Temporary directory (special generation rules)
478 TAGLETAPI_TEMPDIR = $(DOCSTMPDIR)/taglets_temp
480 # The index.html, options, and packages files
481 TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/index.html
482 TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options
483 TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages
485 tagletapidocs: $(TAGLETAPI_INDEX_FILE)
487 # Set relative location to core api document root
488 $(TAGLETAPI_INDEX_FILE): GET2DOCSDIR=$(TAGLETAPI2COREAPI)/..
490 # Run javadoc if the index file is out of date or missing
491 $(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) coredocs
492 $(prep-javadoc)
493 $(RM) -r $(TAGLETAPI_TEMPDIR)
494 $(MKDIR) -p $(TAGLETAPI_TEMPDIR)
495 $(call JavadocSummary,$(TAGLETAPI_OPTIONS_FILE),$(TAGLETAPI_PACKAGES_FILE))
496 $(JAVADOC_CMD) -d $(TAGLETAPI_TEMPDIR) \
497 @$(TAGLETAPI_OPTIONS_FILE) @$(TAGLETAPI_PACKAGES_FILE)
498 cp -r $(TAGLETAPI_TEMPDIR)/com $(@D)
499 cp $(TAGLETAPI_TEMPDIR)/stylesheet.css $(@D)
500 $(RM) -r $(TAGLETAPI_TEMPDIR)
502 # Create file with javadoc options in it
503 $(TAGLETAPI_OPTIONS_FILE):
504 $(prep-target)
505 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
506 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
507 $(call OptionPair,-encoding,ascii) ; \
508 $(call OptionOnly,-nonavbar) ; \
509 $(call OptionOnly,-noindex) ; \
510 $(call OptionPair,-bottom,$(TAGLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
511 $(call OptionTrip,-linkoffline,$(TAGLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
512 ) >> $@
514 # Create a file with the package names in it
515 $(TAGLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TAGLETAPI_PKGS))
516 $(prep-target)
517 @($(ECHO) "$(JDK_IMPSRC)/$(TAGLETAPI_FILE)" ) > $@
519 #############################################################
520 #
521 # domapidocs
522 #
524 ALL_OTHER_TARGETS += domapidocs
526 DOMAPI_DOCDIR := $(JRE_API_DOCSDIR)/plugin/dom
527 DOMAPI2COREAPI := ../../$(JDKJRE2COREAPI)
528 DOMAPI_DOCTITLE := Common DOM API
529 DOMAPI_WINDOWTITLE := Common DOM API
530 DOMAPI_HEADER := <strong>Common DOM API</strong>
531 DOMAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOMAPI_FIRST_COPYRIGHT_YEAR))
532 DOMAPI_GROUPNAME := Packages
533 DOMAPI_REGEXP := com.sun.java.browser.dom:org.w3c.dom*
534 # DOMAPI_PKGS is located in NON_CORE_PKGS.gmk
536 # The index.html, options, and packages files
537 DOMAPI_INDEX_FILE = $(DOMAPI_DOCDIR)/index.html
538 DOMAPI_OPTIONS_FILE = $(DOCSTMPDIR)/domapi.options
539 DOMAPI_PACKAGES_FILE = $(DOCSTMPDIR)/domapi.packages
541 domapidocs: $(DOMAPI_INDEX_FILE)
543 # Set relative location to core api document root
544 $(DOMAPI_INDEX_FILE): GET2DOCSDIR=$(DOMAPI2COREAPI)/..
546 # Run javadoc if the index file is out of date or missing
547 $(DOMAPI_INDEX_FILE): $(DOMAPI_OPTIONS_FILE) $(DOMAPI_PACKAGES_FILE) coredocs
548 $(prep-javadoc)
549 $(call JavadocSummary,$(DOMAPI_OPTIONS_FILE),$(DOMAPI_PACKAGES_FILE))
550 $(JAVADOC_CMD) -d $(@D) \
551 @$(DOMAPI_OPTIONS_FILE) @$(DOMAPI_PACKAGES_FILE)
553 # Create file with javadoc options in it
554 $(DOMAPI_OPTIONS_FILE):
555 $(prep-target)
556 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
557 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
558 $(call OptionPair,-encoding,ascii) ; \
559 $(call OptionOnly,-splitIndex) ; \
560 $(call OptionPair,-doctitle,$(DOMAPI_DOCTITLE)) ; \
561 $(call OptionPair,-windowtitle,$(DOMAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\
562 $(call OptionPair,-header,$(DOMAPI_HEADER)$(DRAFT_HEADER)) ; \
563 $(call OptionPair,-bottom,$(DOMAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
564 $(call OptionTrip,-group,$(DOMAPI_GROUPNAME),$(DOMAPI_REGEXP)); \
565 $(call OptionTrip,-linkoffline,$(DOMAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
566 ) >> $@
568 # Create a file with the package names in it
569 $(DOMAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOMAPI_PKGS))
570 $(prep-target)
571 $(call PackageFilter,$(DOMAPI_PKGS))
573 #############################################################
574 #
575 # jpdadocs
576 #
578 ALL_OTHER_TARGETS += jpdadocs
580 jpdadocs: jdidocs jdwpdocs jvmtidocs
582 #############################################################
583 #
584 # jdidocs
585 #
587 ALL_OTHER_TARGETS += jdidocs
589 JDI_DOCDIR := $(JDK_API_DOCSDIR)/jpda/jdi
590 JDI2COREAPI := ../../$(JDKJRE2COREAPI)
591 JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface
592 JDI_WINDOWTITLE := Java Debug Interface
593 JDI_HEADER := <strong>Java Debug Interface</strong>
594 JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR))
595 JDI_OVERVIEW := $(JDK_SHARE_CLASSES)/jdi-overview.html
596 # JDI_PKGS is located in NON_CORE_PKGS.gmk
598 # The index.html, options, and packages files
599 JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html
600 JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options
601 JDI_PACKAGES_FILE = $(DOCSTMPDIR)/jdi.packages
603 jdidocs: $(JDI_INDEX_FILE)
605 # Set relative location to core api document root
606 $(JDI_INDEX_FILE): GET2DOCSDIR=$(JDI2COREAPI)/..
608 # Run javadoc if the index file is out of date or missing
609 $(JDI_INDEX_FILE): $(JDI_OPTIONS_FILE) $(JDI_PACKAGES_FILE) coredocs
610 $(prep-javadoc)
611 $(call JavadocSummary,$(JDI_OPTIONS_FILE),$(JDI_PACKAGES_FILE))
612 $(JAVADOC_CMD) -d $(@D) \
613 @$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE)
615 # Create file with javadoc options in it
616 $(JDI_OPTIONS_FILE): $(JDI_OVERVIEW)
617 $(prep-target)
618 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
619 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
620 $(call OptionPair,-encoding,ascii) ; \
621 $(call OptionPair,-overview,$(JDI_OVERVIEW)) ; \
622 $(call OptionPair,-doctitle,$(JDI_DOCTITLE)) ; \
623 $(call OptionPair,-windowtitle,$(JDI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
624 $(call OptionPair,-header,$(JDI_HEADER)$(DRAFT_HEADER)) ; \
625 $(call OptionPair,-bottom,$(JDI_BOTTOM)$(DRAFT_BOTTOM)) ; \
626 $(call OptionTrip,-linkoffline,$(JDI2COREAPI),$(COREAPI_DOCSDIR)/); \
627 ) >> $@
629 # Create a file with the package names in it
630 $(JDI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JDI_PKGS))
631 $(prep-target)
632 $(call PackageFilter,$(JDI_PKGS))
634 #############################################################
635 #
636 # jdwpdocs
637 #
639 ALL_OTHER_TARGETS += jdwpdocs
641 JDWP_DOCDIR = $(PLATFORM_DOCSDIR)/jpda/jdwp
643 jdwpdocs: $(JDWP_DOCDIR)/jdwp-protocol.html
644 $(JDWP_DOCDIR)/jdwp-protocol.html : $(JDK_OUTPUTDIR)/gensrc_jdwp_doc/jdwp-protocol.html
645 $(MKDIR) -p $(@D)
646 $(RM) $@
647 $(CP) $< $@
649 #############################################################
650 #
651 # jvmtidocs
652 #
654 ALL_OTHER_TARGETS += jvmtidocs
656 JVMTI_DOCDIR = $(PLATFORM_DOCSDIR)/jvmti
657 JVMTI_HTML = $(HOTSPOT_DIST)/docs/platform/jvmti/jvmti.html
659 jvmtidocs: $(JVMTI_DOCDIR)/jvmti.html
660 $(JVMTI_DOCDIR)/jvmti.html:
661 @$(prep-javadoc)
662 @if [ -f $(JVMTI_HTML) ] ; then \
663 $(ECHO) "$(CP) $(JVMTI_HTML) $@"; \
664 $(CP) $(JVMTI_HTML) $@; \
665 else \
666 $(ECHO) "WARNING: Generated file does not exist: $(JVMTI_HTML)"; \
667 fi
669 #############################################################
670 #
671 # jaasdocs
672 #
674 ALL_OTHER_TARGETS += jaasdocs
676 JAAS_DOCDIR := $(JRE_API_DOCSDIR)/security/jaas/spec
677 JAAS2COREAPI := ../../../$(JDKJRE2COREAPI)
678 JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service
679 JAAS_WINDOWTITLE := Java Authentication and Authorization Service
680 JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong>
681 JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR))
682 # JAAS_PKGS is located in NON_CORE_PKGS.gmk
683 JAAS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/auth/jaas-overview.html
685 # The index.html, options, and packages files
686 JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html
687 JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options
688 JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages
690 jaasdocs: $(JAAS_INDEX_FILE)
692 # Set relative location to core api document root
693 $(JAAS_INDEX_FILE): GET2DOCSDIR=$(JAAS2COREAPI)/..
695 # Run javadoc if the index file is out of date or missing
696 $(JAAS_INDEX_FILE): $(JAAS_OPTIONS_FILE) $(JAAS_PACKAGES_FILE) coredocs
697 $(prep-javadoc)
698 $(call JavadocSummary,$(JAAS_OPTIONS_FILE),$(JAAS_PACKAGES_FILE))
699 $(JAVADOC_CMD) -d $(@D) \
700 @$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE)
702 # Create file with javadoc options in it
703 $(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW)
704 $(prep-target)
705 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
706 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
707 $(call OptionPair,-encoding,ascii) ; \
708 $(call OptionPair,-overview,$(JAAS_OVERVIEW)) ; \
709 $(call OptionPair,-doctitle,$(JAAS_DOCTITLE)) ; \
710 $(call OptionPair,-windowtitle,$(JAAS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
711 $(call OptionPair,-header,$(JAAS_HEADER)$(DRAFT_HEADER)) ; \
712 $(call OptionPair,-bottom,$(JAAS_BOTTOM)$(DRAFT_BOTTOM)) ; \
713 $(call OptionTrip,-linkoffline,$(JAAS2COREAPI),$(COREAPI_DOCSDIR)/); \
714 ) >> $@
716 # Create a file with the package names in it
717 $(JAAS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JAAS_PKGS))
718 $(prep-target)
719 $(call PackageFilter,$(JAAS_PKGS))
721 #############################################################
722 #
723 # jgssdocs
724 #
726 ALL_OTHER_TARGETS += jgssdocs
728 JGSS_DOCDIR := $(JRE_API_DOCSDIR)/security/jgss/spec
729 JGSS2COREAPI := ../../../$(JDKJRE2COREAPI)
730 JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities
731 JGSS_WINDOWTITLE := Java GSS-API Utilities
732 JGSS_HEADER := <strong>Java GSS-API Utilities</strong>
733 JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR))
734 JGSS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/jgss/jgss-overview.html
735 # JGSS_PKGS is located in NON_CORE_PKGS.gmk
737 # The index.html, options, and packages files
738 JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html
739 JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options
740 JGSS_PACKAGES_FILE = $(DOCSTMPDIR)/jgss.packages
742 jgssdocs: $(JGSS_INDEX_FILE)
744 # Set relative location to core api document root
745 $(JGSS_INDEX_FILE): GET2DOCSDIR=$(JGSS2COREAPI)/..
747 # Run javadoc if the index file is out of date or missing
748 $(JGSS_INDEX_FILE): $(JGSS_OPTIONS_FILE) $(JGSS_PACKAGES_FILE) coredocs
749 $(prep-javadoc)
750 $(call JavadocSummary,$(JGSS_OPTIONS_FILE),$(JGSS_PACKAGES_FILE))
751 $(JAVADOC_CMD) -d $(@D) \
752 @$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE)
754 # Create file with javadoc options in it
755 $(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW)
756 $(prep-target)
757 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
758 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
759 $(call OptionPair,-encoding,ascii) ; \
760 $(call OptionOnly,-nodeprecatedlist) ; \
761 $(call OptionPair,-overview,$(JGSS_OVERVIEW)) ; \
762 $(call OptionPair,-doctitle,$(JGSS_DOCTITLE)) ; \
763 $(call OptionPair,-windowtitle,$(JGSS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
764 $(call OptionPair,-header,$(JGSS_HEADER)$(DRAFT_HEADER)) ; \
765 $(call OptionPair,-bottom,$(JGSS_BOTTOM)$(DRAFT_BOTTOM)) ; \
766 $(call OptionTrip,-linkoffline,$(JGSS2COREAPI),$(COREAPI_DOCSDIR)/); \
767 ) >> $@
769 # Create a file with the package names in it
770 $(JGSS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JGSS_PKGS))
771 $(prep-target)
772 $(call PackageFilter,$(JGSS_PKGS))
774 #############################################################
775 #
776 # smartcardiodocs
777 #
779 ALL_OTHER_TARGETS += smartcardiodocs
781 SMARTCARDIO_DOCDIR := $(JRE_API_DOCSDIR)/security/smartcardio/spec
782 SMARTCARDIO2COREAPI := ../../../$(JDKJRE2COREAPI)
783 SMARTCARDIO_DOCTITLE := Java$(TRADEMARK) Smart Card I/O
784 SMARTCARDIO_WINDOWTITLE := Java Smart Card I/O
785 SMARTCARDIO_HEADER := <strong>Java Smart Card I/O</strong>
786 SMARTCARDIO_BOTTOM := $(call CommonBottom,$(SMARTCARDIO_FIRST_COPYRIGHT_YEAR))
787 # SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk
789 # The index.html, options, and packages files
790 SMARTCARDIO_INDEX_FILE = $(SMARTCARDIO_DOCDIR)/index.html
791 SMARTCARDIO_OPTIONS_FILE = $(DOCSTMPDIR)/smartcardio.options
792 SMARTCARDIO_PACKAGES_FILE = $(DOCSTMPDIR)/smartcardio.packages
794 smartcardiodocs: $(SMARTCARDIO_INDEX_FILE)
796 # Set relative location to core api document root
797 $(SMARTCARDIO_INDEX_FILE): GET2DOCSDIR=$(SMARTCARDIO2COREAPI)/..
799 # Run javadoc if the index file is out of date or missing
800 $(SMARTCARDIO_INDEX_FILE): $(SMARTCARDIO_OPTIONS_FILE) $(SMARTCARDIO_PACKAGES_FILE) coredocs
801 $(prep-javadoc)
802 $(call JavadocSummary,$(SMARTCARDIO_OPTIONS_FILE),$(SMARTCARDIO_PACKAGES_FILE))
803 $(JAVADOC_CMD) -d $(@D) \
804 @$(SMARTCARDIO_OPTIONS_FILE) @$(SMARTCARDIO_PACKAGES_FILE)
806 # Create file with javadoc options in it
807 $(SMARTCARDIO_OPTIONS_FILE):
808 $(prep-target)
809 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
810 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
811 $(call OptionPair,-encoding,ascii) ; \
812 $(call OptionOnly,-nodeprecatedlist) ; \
813 $(call OptionPair,-doctitle,$(SMARTCARDIO_DOCTITLE)) ; \
814 $(call OptionPair,-windowtitle,$(SMARTCARDIO_WINDOWTITLE) $(DRAFT_WINTITLE));\
815 $(call OptionPair,-header,$(SMARTCARDIO_HEADER)$(DRAFT_HEADER)); \
816 $(call OptionPair,-bottom,$(SMARTCARDIO_BOTTOM)$(DRAFT_BOTTOM)); \
817 $(call OptionTrip,-linkoffline,$(SMARTCARDIO2COREAPI),$(COREAPI_DOCSDIR)/); \
818 ) >> $@
820 # Create a file with the package names in it
821 $(SMARTCARDIO_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SMARTCARDIO_PKGS))
822 $(prep-target)
823 $(call PackageFilter,$(SMARTCARDIO_PKGS))
825 #############################################################
826 #
827 # httpserverdocs
828 #
830 ALL_OTHER_TARGETS += httpserverdocs
832 HTTPSERVER_DOCDIR := $(JRE_API_DOCSDIR)/net/httpserver/spec
833 HTTPSERVER2COREAPI := ../../../$(JDKJRE2COREAPI)
834 HTTPSERVER_DOCTITLE := Java$(TRADEMARK) HTTP Server
835 HTTPSERVER_WINDOWTITLE := Java HTTP Server
836 HTTPSERVER_HEADER := <strong>Java HTTP Server</strong>
837 HTTPSERVER_BOTTOM := $(call CommonBottom,$(HTTPSERVER_FIRST_COPYRIGHT_YEAR))
838 # HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk
840 HTTPSERVER_INDEX_HTML = $(HTTPSERVER_DOCDIR)/index.html
841 HTTPSERVER_OPTIONS_FILE = $(DOCSTMPDIR)/httpserver.options
842 HTTPSERVER_PACKAGES_FILE = $(DOCSTMPDIR)/httpserver.packages
844 httpserverdocs: $(HTTPSERVER_INDEX_HTML)
846 # Set relative location to core api document root
847 $(HTTPSERVER_INDEX_HTML): GET2DOCSDIR=$(HTTPSERVER2COREAPI)/..
849 # Run javadoc if the index file is out of date or missing
850 $(HTTPSERVER_INDEX_HTML): $(HTTPSERVER_OPTIONS_FILE) $(HTTPSERVER_PACKAGES_FILE) coredocs
851 $(prep-javadoc)
852 $(call JavadocSummary,$(HTTPSERVER_OPTIONS_FILE),$(HTTPSERVER_PACKAGES_FILE))
853 $(JAVADOC_CMD) -d $(@D) \
854 @$(HTTPSERVER_OPTIONS_FILE) @$(HTTPSERVER_PACKAGES_FILE)
856 # Create file with javadoc options in it
857 $(HTTPSERVER_OPTIONS_FILE):
858 $(prep-target)
859 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
860 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
861 $(call OptionPair,-encoding,ascii) ; \
862 $(call OptionOnly,-nodeprecatedlist) ; \
863 $(call OptionPair,-doctitle,$(HTTPSERVER_DOCTITLE)) ; \
864 $(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE));\
865 $(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \
866 $(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \
867 $(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \
868 ) >> $@
870 # Create a file with the package names in it
871 $(HTTPSERVER_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(HTTPSERVER_PKGS))
872 $(prep-target)
873 $(call PackageFilter,$(HTTPSERVER_PKGS))
875 #############################################################
876 #
877 # mgmtdocs
878 #
880 ALL_OTHER_TARGETS += mgmtdocs
882 MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension
883 MGMT2COREAPI := ../../$(JDKJRE2COREAPI)
884 JVM_MIB_NAME := JVM-MANAGEMENT-MIB.mib
885 JVM_MIB_SRC := $(JDK_TOPDIR)/src/closed/share/classes/sun/management/snmp/$(JVM_MIB_NAME)
886 MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform
887 MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform
888 MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong>
889 MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR))
890 MGMT_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/management/mgmt-overview.html
891 # MGMT_PKGS is located in NON_CORE_PKGS.gmk
893 # The index.html, options, and packages files
894 MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html
895 MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options
896 MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages
898 mgmtdocs: $(MGMT_INDEX_FILE)
900 # Set relative location to core api document root
901 $(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/..
903 # Run javadoc if the index file is out of date or missing
904 $(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) coredocs
905 $(prep-javadoc)
906 @if [ -f $(JVM_MIB_SRC) ] ; then \
907 $(ECHO) "$(CP) $(JVM_MIB_SRC) $(@D)/.."; \
908 $(CP) $(JVM_MIB_SRC) $(@D)/.. ; \
909 else \
910 $(ECHO) "WARNING: File $(JVM_MIB_NAME) not available."; \
911 fi
912 $(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE))
913 $(JAVADOC_CMD) -d $(@D) \
914 @$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE)
916 # Create file with javadoc options in it
917 $(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW)
918 $(prep-target)
919 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
920 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
921 $(call OptionPair,-encoding,ascii) ; \
922 $(call OptionOnly,-nodeprecatedlist) ; \
923 $(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \
924 $(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \
925 $(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \
926 $(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \
927 $(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \
928 $(call OptionTrip,-linkoffline,$(MGMT2COREAPI),$(COREAPI_DOCSDIR)/); \
929 ) >> $@
931 # Create a file with the package names in it
932 $(MGMT_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(MGMT_PKGS))
933 $(prep-target)
934 $(call PackageFilter,$(MGMT_PKGS))
936 #############################################################
937 #
938 # attachdocs
939 #
941 ALL_OTHER_TARGETS += attachdocs
943 ATTACH_DOCDIR := $(JDK_API_DOCSDIR)/attach/spec
944 ATTACH2COREAPI := ../../$(JDKJRE2COREAPI)
945 ATTACH_DOCTITLE := Attach API
946 ATTACH_WINDOWTITLE := Attach API
947 ATTACH_HEADER := <strong>Attach API</strong>
948 ATTACH_BOTTOM := $(call CommonBottom,$(ATTACH_FIRST_COPYRIGHT_YEAR))
949 # ATTACH_PKGS is located in NON_CORE_PKGS.gmk
951 ATTACH_INDEX_HTML = $(ATTACH_DOCDIR)/index.html
952 ATTACH_OPTIONS_FILE = $(DOCSTMPDIR)/attach.options
953 ATTACH_PACKAGES_FILE = $(DOCSTMPDIR)/attach.packages
955 attachdocs: $(ATTACH_INDEX_HTML)
957 # Set relative location to core api document root
958 $(ATTACH_INDEX_HTML): GET2DOCSDIR=$(ATTACH2COREAPI)/..
960 # Run javadoc if the index file is out of date or missing
961 $(ATTACH_INDEX_HTML): $(ATTACH_OPTIONS_FILE) $(ATTACH_PACKAGES_FILE) coredocs
962 $(prep-javadoc)
963 $(call JavadocSummary,$(ATTACH_OPTIONS_FILE),$(ATTACH_PACKAGES_FILE))
964 $(JAVADOC_CMD) -d $(@D) \
965 @$(ATTACH_OPTIONS_FILE) @$(ATTACH_PACKAGES_FILE)
967 # Create file with javadoc options in it
968 $(ATTACH_OPTIONS_FILE):
969 $(prep-target)
970 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
971 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
972 $(call OptionPair,-encoding,ascii) ; \
973 $(call OptionOnly,-nodeprecatedlist) ; \
974 $(call OptionPair,-doctitle,$(ATTACH_DOCTITLE)) ; \
975 $(call OptionPair,-windowtitle,$(ATTACH_WINDOWTITLE) $(DRAFT_WINTITLE));\
976 $(call OptionPair,-header,$(ATTACH_HEADER)$(DRAFT_HEADER)) ; \
977 $(call OptionPair,-bottom,$(ATTACH_BOTTOM)$(DRAFT_BOTTOM)) ; \
978 $(call OptionTrip,-linkoffline,$(ATTACH2COREAPI),$(COREAPI_DOCSDIR)/); \
979 ) >> $@
981 # Create a file with the package names in it
982 $(ATTACH_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(ATTACH_PKGS))
983 $(prep-target)
984 $(call PackageFilter,$(ATTACH_PKGS))
986 #############################################################
987 #
988 # jconsoledocs
989 #
991 ALL_OTHER_TARGETS += jconsoledocs
993 JCONSOLE_DOCDIR := $(JDK_API_DOCSDIR)/jconsole/spec
994 JCONSOLE2COREAPI := ../../$(JDKJRE2COREAPI)
995 JCONSOLE_DOCTITLE := JConsole API
996 JCONSOLE_WINDOWTITLE := JConsole API
997 JCONSOLE_HEADER := <strong>JConsole API</strong>
998 JCONSOLE_BOTTOM := $(call CommonBottom,$(JCONSOLE_FIRST_COPYRIGHT_YEAR))
999 # JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk
1001 JCONSOLE_INDEX_HTML = $(JCONSOLE_DOCDIR)/index.html
1002 JCONSOLE_OPTIONS_FILE = $(DOCSTMPDIR)/jconsole.options
1003 JCONSOLE_PACKAGES_FILE = $(DOCSTMPDIR)/jconsole.packages
1005 jconsoledocs: $(JCONSOLE_INDEX_HTML)
1007 # Set relative location to core api document root
1008 $(JCONSOLE_INDEX_HTML): GET2DOCSDIR=$(JCONSOLE2COREAPI)/..
1010 # Run javadoc if the index file is out of date or missing
1011 $(JCONSOLE_INDEX_HTML): $(JCONSOLE_OPTIONS_FILE) $(JCONSOLE_PACKAGES_FILE) coredocs
1012 $(prep-javadoc)
1013 $(call JavadocSummary,$(JCONSOLE_OPTIONS_FILE),$(JCONSOLE_PACKAGES_FILE))
1014 $(JAVADOC_CMD) -d $(@D) \
1015 @$(JCONSOLE_OPTIONS_FILE) @$(JCONSOLE_PACKAGES_FILE)
1017 # Create file with javadoc options in it
1018 $(JCONSOLE_OPTIONS_FILE):
1019 $(prep-target)
1020 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1021 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1022 $(call OptionPair,-encoding,ascii) ; \
1023 $(call OptionOnly,-nodeprecatedlist) ; \
1024 $(call OptionPair,-doctitle,$(JCONSOLE_DOCTITLE)) ; \
1025 $(call OptionPair,-windowtitle,$(JCONSOLE_WINDOWTITLE) $(DRAFT_WINTITLE));\
1026 $(call OptionPair,-header,$(JCONSOLE_HEADER)$(DRAFT_HEADER)) ; \
1027 $(call OptionPair,-bottom,$(JCONSOLE_BOTTOM)$(DRAFT_BOTTOM)) ; \
1028 $(call OptionTrip,-linkoffline,$(JCONSOLE2COREAPI),$(COREAPI_DOCSDIR)/); \
1029 ) >> $@
1031 # Create a file with the package names in it
1032 $(JCONSOLE_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JCONSOLE_PKGS))
1033 $(prep-target)
1034 $(call PackageFilter,$(JCONSOLE_PKGS))
1036 #############################################################
1037 #
1038 # treeapidocs
1039 #
1041 ALL_OTHER_TARGETS += treeapidocs
1043 TREEAPI_DOCDIR := $(JDK_API_DOCSDIR)/javac/tree
1044 TREEAPI2COREAPI := ../../$(JDKJRE2COREAPI)
1045 TREEAPI_DOCTITLE := Compiler Tree API
1046 TREEAPI_WINDOWTITLE := Compiler Tree API
1047 TREEAPI_HEADER := <strong>Compiler Tree API</strong>
1048 TREEAPI_BOTTOM := $(call CommonBottom,$(TREEAPI_FIRST_COPYRIGHT_YEAR))
1049 TREEAPI_GROUPNAME := Packages
1050 TREEAPI_REGEXP := com.sun.source.*
1051 # TREEAPI_PKGS is located in NON_CORE_PKGS.gmk
1053 TREEAPI_INDEX_HTML = $(TREEAPI_DOCDIR)/index.html
1054 TREEAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options
1055 TREEAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages
1057 treeapidocs: $(TREEAPI_INDEX_HTML)
1059 # Set relative location to core api document root
1060 $(TREEAPI_INDEX_HTML): GET2DOCSDIR=$(TREEAPI2COREAPI)/..
1062 # Run javadoc if the index file is out of date or missing
1063 $(TREEAPI_INDEX_HTML): $(TREEAPI_OPTIONS_FILE) $(TREEAPI_PACKAGES_FILE) coredocs
1064 $(prep-javadoc)
1065 $(call JavadocSummary,$(TREEAPI_OPTIONS_FILE),$(TREEAPI_PACKAGES_FILE))
1066 $(JAVADOC_CMD) -d $(@D) \
1067 @$(TREEAPI_OPTIONS_FILE) @$(TREEAPI_PACKAGES_FILE)
1069 # Create file with javadoc options in it
1070 $(TREEAPI_OPTIONS_FILE):
1071 $(prep-target)
1072 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1073 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1074 $(call OptionPair,-encoding,ascii) ; \
1075 $(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \
1076 $(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\
1077 $(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \
1078 $(call OptionPair,-tag,$(TAG_JLS)) ; \
1079 $(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1080 $(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \
1081 $(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1082 ) >> $@
1084 # Create a file with the package names in it
1085 $(TREEAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TREEAPI_PKGS))
1086 $(prep-target)
1087 $(call PackageFilter,$(TREEAPI_PKGS))
1089 #############################################################
1090 #
1091 # sctpdocs
1092 #
1094 ALL_OTHER_TARGETS += sctpdocs
1096 SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec
1097 SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
1098 SCTPAPI_DOCTITLE := SCTP API
1099 SCTPAPI_WINDOWTITLE := SCTP API
1100 SCTPAPI_HEADER := <strong>SCTP API</strong>
1101 SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR))
1102 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk
1104 SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html
1105 SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options
1106 SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages
1108 sctpdocs: $(SCTPAPI_INDEX_HTML)
1110 # Set relative location to core api document root
1111 $(SCTPAPI_INDEX_HTML): GET2DOCSDIR=$(SCTPAPI2COREAPI)/..
1113 # Run javadoc if the index file is out of date or missing
1114 $(SCTPAPI_INDEX_HTML): $(SCTPAPI_OPTIONS_FILE) $(SCTPAPI_PACKAGES_FILE) coredocs
1115 $(prep-javadoc)
1116 $(call JavadocSummary,$(SCTPAPI_OPTIONS_FILE),$(SCTPAPI_PACKAGES_FILE))
1117 $(JAVADOC_CMD) -d $(@D) \
1118 @$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE)
1120 # Create file with javadoc options in it
1121 $(SCTPAPI_OPTIONS_FILE):
1122 $(prep-target)
1123 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1124 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1125 $(call OptionPair,-encoding,ascii) ; \
1126 $(call OptionOnly,-nodeprecatedlist) ; \
1127 $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \
1128 $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\
1129 $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \
1130 $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1131 $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1132 ) >> $@
1134 # Create a file with the package names in it
1135 $(SCTPAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SCTPAPI_PKGS))
1136 $(prep-target)
1137 $(call PackageFilter,$(SCTPAPI_PKGS))
1139 #############################################################
1140 #
1141 # Get a cache of all the directories
1143 $(DIRECTORY_CACHE): $(ALL_EXISTING_SOURCE_DIRS)
1144 $(prep-target)
1145 @for cp in $(ALL_EXISTING_SOURCE_DIRS) ; do \
1146 $(ECHO) "$(FIND) $${cp} -type f >> $@"; \
1147 $(FIND) $${cp} -type f >> $@; \
1148 done
1150 #############################################################
1151 #release version of core packages ########
1152 # Maximize performance and ensure that build number & milestone are set.
1154 rel-coredocs: sanitycheckcoredocs
1155 $(MAKE) coredocs
1157 rel-docs: rel-coredocs $(ALL_OTHER_TARGETS)
1158 #
1159 # end of production targets
1161 otherdocs: $(ALL_OTHER_TARGETS)
1163 clean:
1164 $(RM) -r $(DOCSDIR) $(DOCSTMPDIR)
1166 #############################################################
1167 # DEBUG TARGET
1168 # List the values defined in the makefile hierarchy, to make sure everything
1169 # is set properly, and to help identify values we can use instead of making new ones.
1170 # (Most of them come from common/shared/Defs.gmk)
1171 #
1172 # Notes:
1173 # * BUILD_NUMBER defaults to b00 if not set on command line with BUILD_NUMBER=<value>
1174 # * MILESTONE defaults to internal unless set to beta, rc, or fcs on command line
1175 #
1177 #############################################################
1178 .PHONY: all docs coredocs rel-docs otherdocs rel-coredocs \
1179 sanitycheckcoredocs $(ALL_OTHER_TARGETS)
