Mercurial > jdk8-mips64-public / file revision
common/makefiles/javadoc/Javadoc.gmk@d5f3a6f60d51
common/makefiles/javadoc/Javadoc.gmk
Thu, 27 Dec 2012 20:55:53 +0100
- author
- erikj
- date
- Thu, 27 Dec 2012 20:55:53 +0100
- changeset 558
- d5f3a6f60d51
- parent 518
- 6ff2e1280dc3
- child 594
- 2e12a508d7ae
- child 623
- b80abec66e70
- permissions
- -rw-r--r--
8005548: build-infra: Fix docs target on windows
Summary: Fix path sep variable
Reviewed-by: tbell
1 # Copyright (c) 1997, 2012, 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 $(ADDITIONAL_JAVADOCFLAGS)
274 ifdef OPENJDK
275 ADDITIONAL_JAVADOCFLAGS = \
276 -Xdocrootparent $(DOCS_BASE_URL)
277 else
278 ADDITIONAL_JAVADOCFLAGS =
279 endif
281 # Draft used for non-fcs documents
282 DRAFT_HEADER =
283 ifneq ($(MILESTONE), fcs)
284 DRAFT_HEADER = <br><strong>DRAFT $(MILESTONE)-$(BUILD_NUMBER)</strong>
285 DRAFT_BOTTOM = <br><strong>DRAFT $(MILESTONE)-$(BUILD_NUMBER)</strong>
286 DRAFT_WINTITLE = $(BUILD_NUMBER)
287 # Early access top text (not used in FCS releases)
288 COREAPI_TOP_EARLYACCESS = \
289 <div style="background-color: \#EEEEEE"> \
290 <div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; \
291 margin-left: 6px; margin-right: 6px; text-align: justify; \
292 font-size: 80%; font-family: Helvetica, Arial, sans-serif; \
293 font-weight: normal;"> \
294 Please note that the specifications and other information \
295 contained herein are not final and are subject to change. \
296 The information is being made available to you solely for purpose of \
297 evaluation. \
298 </div> </div>
299 endif
301 #################################################################
303 #
304 # CORE_PKGS environment variable has been moved to the following file
305 #
306 include CORE_PKGS.gmk
308 #
309 # Load environment variables for API package names that are not part of
310 # the Java SE platform
311 #
312 include NON_CORE_PKGS.gmk
314 #################################################################
316 #
317 # Default target is same as docs target, create core api and all others it can
318 #
320 all: docs
321 docs: coredocs otherdocs
323 #################################################################
324 # Production Targets -- USE THESE TARGETS WHEN:
325 # a) You're generating docs outside of release engineering's
326 # standard control build.
327 # b) The docs will be pushed to the web and/or included in
328 # the downloaded doc bundle.
329 #
330 # See: Notes.html#releaseTargets
331 # Note: Spaces precede ifdef/ifndef indents. Tabs precede target commands (!)
332 #
334 sanitycheckcoredocs:
335 @$(ECHO) ""
336 @$(ECHO) "Building core api docs with these values:"
337 @$(ECHO) " BUILD_NUMBER = $(BUILD_NUMBER)"
338 @$(ECHO) " MILESTONE = $(MILESTONE)"
339 @$(ECHO) ""
340 ifeq ($(BUILD_NUMBER), b00)
341 @$(ECHO) "ERROR: Build number must be defined"
342 @$(ECHO) "MILESTONE is set to $(MILESTONE)"
343 @$(ECHO) ""
344 exit 1
345 endif
347 #############################################################
348 #
349 # coredocs
350 #
351 COREAPI_DOCTITLE = Java$(TRADEMARK) Platform, Standard Edition \
352 $(JDK_MINOR_VERSION)<br>API Specification
353 COREAPI_WINDOWTITLE = Java Platform SE $(JDK_MINOR_VERSION)
354 COREAPI_HEADER = \
355 <strong>Java$(TRADEMARK) Platform<br>Standard Ed. $(JDK_MINOR_VERSION)</strong>
357 # Java language specification cite
358 TAG_JLS = jls:a:See <cite> \
359 The Java™ Language Specification</cite>:
361 # Overview file for core apis
362 COREAPI_OVERVIEW = $(JDK_SHARE_CLASSES)/overview-core.html
364 # The index.html, options, and packages files
365 COREAPI_INDEX_FILE = $(COREAPI_DOCSDIR)/index.html
366 COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options
367 COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages
369 coredocs: $(COREAPI_INDEX_FILE)
371 # Set relative location to core api document root
372 $(COREAPI_INDEX_FILE): GET2DOCSDIR=..
374 # Run javadoc if the index file is out of date or missing
375 $(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE)
376 $(prep-javadoc)
377 $(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE))
378 $(JAVADOC_CMD) -d $(@D) \
379 @$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE)
381 # Create file with javadoc options in it
382 $(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW)
383 $(prep-target)
384 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
385 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
386 $(call OptionPair,-encoding,ISO-8859-1) ; \
387 $(call OptionPair,-tag,beaninfo:X) ; \
388 $(call OptionPair,-tag,revised:X) ; \
389 $(call OptionPair,-tag,since.unbundled:X) ; \
390 $(call OptionPair,-tag,spec:X) ; \
391 $(call OptionPair,-tag,specdefault:X) ; \
392 $(call OptionPair,-tag,Note:X) ; \
393 $(call OptionPair,-tag,ToDo:X) ; \
394 $(call OptionPair,-tag,$(TAG_JLS)) ; \
395 $(call OptionOnly,-splitIndex) ; \
396 $(call OptionPair,-overview,$(COREAPI_OVERVIEW)) ; \
397 $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE)) ; \
398 $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ;\
399 $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER)) ; \
400 $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
401 ) >> $@
402 ifdef COREAPI_TOP_EARLYACCESS
403 @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@
404 endif
406 # Create a file with the package names in it
407 $(COREAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(CORE_PKGS))
408 $(prep-target)
409 $(call PackageFilter,$(CORE_PKGS))
411 #############################################################
412 #
413 # docletapidocs
414 #
416 ALL_OTHER_TARGETS += docletapidocs
418 DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet
419 DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
420 DOCLETAPI_DOCTITLE := Doclet API
421 DOCLETAPI_WINDOWTITLE := Doclet API
422 DOCLETAPI_HEADER := <strong>Doclet API</strong>
423 DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
424 DOCLETAPI_GROUPNAME := Packages
425 DOCLETAPI_REGEXP := com.sun.javadoc
426 # DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
428 # The index.html, options, and packages files
429 DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html
430 DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options
431 DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages
433 docletapidocs: $(DOCLETAPI_INDEX_FILE)
435 # Set relative location to core api document root
436 $(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/..
438 # Run javadoc if the index file is out of date or missing
439 $(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) coredocs
440 $(prep-javadoc)
441 $(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE))
442 $(JAVADOC_CMD) -d $(@D) \
443 @$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE)
445 # Create file with javadoc options in it
446 $(DOCLETAPI_OPTIONS_FILE):
447 $(prep-target)
448 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
449 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
450 $(call OptionPair,-encoding,ascii) ; \
451 $(call OptionOnly,-breakiterator) ; \
452 $(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \
453 $(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\
454 $(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \
455 $(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
456 $(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \
457 $(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
458 ) >> $@
460 # Create a file with the package names in it
461 $(DOCLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOCLETAPI_PKGS))
462 $(prep-target)
463 $(call PackageFilter,$(DOCLETAPI_PKGS))
465 #############################################################
466 #
467 # tagletapidocs
468 #
470 ALL_OTHER_TARGETS += tagletapidocs
471 TAGLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/taglet
472 TAGLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
473 TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR))
474 # TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk
476 # Temporary directory (special generation rules)
477 TAGLETAPI_TEMPDIR = $(DOCSTMPDIR)/taglets_temp
479 # The index.html, options, and packages files
480 TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/index.html
481 TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options
482 TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages
484 tagletapidocs: $(TAGLETAPI_INDEX_FILE)
486 # Set relative location to core api document root
487 $(TAGLETAPI_INDEX_FILE): GET2DOCSDIR=$(TAGLETAPI2COREAPI)/..
489 # Run javadoc if the index file is out of date or missing
490 $(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) coredocs
491 $(prep-javadoc)
492 $(RM) -r $(TAGLETAPI_TEMPDIR)
493 $(MKDIR) -p $(TAGLETAPI_TEMPDIR)
494 $(call JavadocSummary,$(TAGLETAPI_OPTIONS_FILE),$(TAGLETAPI_PACKAGES_FILE))
495 $(JAVADOC_CMD) -d $(TAGLETAPI_TEMPDIR) \
496 @$(TAGLETAPI_OPTIONS_FILE) @$(TAGLETAPI_PACKAGES_FILE)
497 cp -r $(TAGLETAPI_TEMPDIR)/com $(@D)
498 cp $(TAGLETAPI_TEMPDIR)/stylesheet.css $(@D)
499 $(RM) -r $(TAGLETAPI_TEMPDIR)
501 # Create file with javadoc options in it
502 $(TAGLETAPI_OPTIONS_FILE):
503 $(prep-target)
504 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
505 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
506 $(call OptionPair,-encoding,ascii) ; \
507 $(call OptionOnly,-nonavbar) ; \
508 $(call OptionOnly,-noindex) ; \
509 $(call OptionPair,-bottom,$(TAGLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
510 $(call OptionTrip,-linkoffline,$(TAGLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
511 ) >> $@
513 # Create a file with the package names in it
514 $(TAGLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TAGLETAPI_PKGS))
515 $(prep-target)
516 @($(ECHO) "$(JDK_IMPSRC)/$(TAGLETAPI_FILE)" ) > $@
518 #############################################################
519 #
520 # domapidocs
521 #
523 ALL_OTHER_TARGETS += domapidocs
525 DOMAPI_DOCDIR := $(JRE_API_DOCSDIR)/plugin/dom
526 DOMAPI2COREAPI := ../../$(JDKJRE2COREAPI)
527 DOMAPI_DOCTITLE := Common DOM API
528 DOMAPI_WINDOWTITLE := Common DOM API
529 DOMAPI_HEADER := <strong>Common DOM API</strong>
530 DOMAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOMAPI_FIRST_COPYRIGHT_YEAR))
531 DOMAPI_GROUPNAME := Packages
532 DOMAPI_REGEXP := com.sun.java.browser.dom:org.w3c.dom*
533 # DOMAPI_PKGS is located in NON_CORE_PKGS.gmk
535 # The index.html, options, and packages files
536 DOMAPI_INDEX_FILE = $(DOMAPI_DOCDIR)/index.html
537 DOMAPI_OPTIONS_FILE = $(DOCSTMPDIR)/domapi.options
538 DOMAPI_PACKAGES_FILE = $(DOCSTMPDIR)/domapi.packages
540 domapidocs: $(DOMAPI_INDEX_FILE)
542 # Set relative location to core api document root
543 $(DOMAPI_INDEX_FILE): GET2DOCSDIR=$(DOMAPI2COREAPI)/..
545 # Run javadoc if the index file is out of date or missing
546 $(DOMAPI_INDEX_FILE): $(DOMAPI_OPTIONS_FILE) $(DOMAPI_PACKAGES_FILE) coredocs
547 $(prep-javadoc)
548 $(call JavadocSummary,$(DOMAPI_OPTIONS_FILE),$(DOMAPI_PACKAGES_FILE))
549 $(JAVADOC_CMD) -d $(@D) \
550 @$(DOMAPI_OPTIONS_FILE) @$(DOMAPI_PACKAGES_FILE)
552 # Create file with javadoc options in it
553 $(DOMAPI_OPTIONS_FILE):
554 $(prep-target)
555 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
556 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
557 $(call OptionPair,-encoding,ascii) ; \
558 $(call OptionOnly,-splitIndex) ; \
559 $(call OptionPair,-doctitle,$(DOMAPI_DOCTITLE)) ; \
560 $(call OptionPair,-windowtitle,$(DOMAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\
561 $(call OptionPair,-header,$(DOMAPI_HEADER)$(DRAFT_HEADER)) ; \
562 $(call OptionPair,-bottom,$(DOMAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
563 $(call OptionTrip,-group,$(DOMAPI_GROUPNAME),$(DOMAPI_REGEXP)); \
564 $(call OptionTrip,-linkoffline,$(DOMAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
565 ) >> $@
567 # Create a file with the package names in it
568 $(DOMAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOMAPI_PKGS))
569 $(prep-target)
570 $(call PackageFilter,$(DOMAPI_PKGS))
572 #############################################################
573 #
574 # jpdadocs
575 #
577 ALL_OTHER_TARGETS += jpdadocs
579 jpdadocs: jdidocs jdwpdocs jvmtidocs
581 #############################################################
582 #
583 # jdidocs
584 #
586 ALL_OTHER_TARGETS += jdidocs
588 JDI_DOCDIR := $(JDK_API_DOCSDIR)/jpda/jdi
589 JDI2COREAPI := ../../$(JDKJRE2COREAPI)
590 JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface
591 JDI_WINDOWTITLE := Java Debug Interface
592 JDI_HEADER := <strong>Java Debug Interface</strong>
593 JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR))
594 JDI_OVERVIEW := $(JDK_SHARE_CLASSES)/jdi-overview.html
595 # JDI_PKGS is located in NON_CORE_PKGS.gmk
597 # The index.html, options, and packages files
598 JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html
599 JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options
600 JDI_PACKAGES_FILE = $(DOCSTMPDIR)/jdi.packages
602 jdidocs: $(JDI_INDEX_FILE)
604 # Set relative location to core api document root
605 $(JDI_INDEX_FILE): GET2DOCSDIR=$(JDI2COREAPI)/..
607 # Run javadoc if the index file is out of date or missing
608 $(JDI_INDEX_FILE): $(JDI_OPTIONS_FILE) $(JDI_PACKAGES_FILE) coredocs
609 $(prep-javadoc)
610 $(call JavadocSummary,$(JDI_OPTIONS_FILE),$(JDI_PACKAGES_FILE))
611 $(JAVADOC_CMD) -d $(@D) \
612 @$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE)
614 # Create file with javadoc options in it
615 $(JDI_OPTIONS_FILE): $(JDI_OVERVIEW)
616 $(prep-target)
617 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
618 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
619 $(call OptionPair,-encoding,ascii) ; \
620 $(call OptionPair,-overview,$(JDI_OVERVIEW)) ; \
621 $(call OptionPair,-doctitle,$(JDI_DOCTITLE)) ; \
622 $(call OptionPair,-windowtitle,$(JDI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
623 $(call OptionPair,-header,$(JDI_HEADER)$(DRAFT_HEADER)) ; \
624 $(call OptionPair,-bottom,$(JDI_BOTTOM)$(DRAFT_BOTTOM)) ; \
625 $(call OptionTrip,-linkoffline,$(JDI2COREAPI),$(COREAPI_DOCSDIR)/); \
626 ) >> $@
628 # Create a file with the package names in it
629 $(JDI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JDI_PKGS))
630 $(prep-target)
631 $(call PackageFilter,$(JDI_PKGS))
633 #############################################################
634 #
635 # jdwpdocs
636 #
638 ALL_OTHER_TARGETS += jdwpdocs
640 JDWP_DOCDIR = $(PLATFORM_DOCSDIR)/jpda/jdwp
642 jdwpdocs: $(JDWP_DOCDIR)/jdwp-protocol.html
643 $(JDWP_DOCDIR)/jdwp-protocol.html : $(JDK_OUTPUTDIR)/gensrc_jdwp_doc/jdwp-protocol.html
644 $(MKDIR) -p $(@D)
645 $(RM) $@
646 $(CP) $< $@
648 #############################################################
649 #
650 # jvmtidocs
651 #
653 ALL_OTHER_TARGETS += jvmtidocs
655 JVMTI_DOCDIR = $(PLATFORM_DOCSDIR)/jvmti
656 JVMTI_HTML = $(HOTSPOT_DIST)/docs/platform/jvmti/jvmti.html
658 jvmtidocs: $(JVMTI_DOCDIR)/jvmti.html
659 $(JVMTI_DOCDIR)/jvmti.html:
660 @$(prep-javadoc)
661 @if [ -f $(JVMTI_HTML) ] ; then \
662 $(ECHO) "$(CP) $(JVMTI_HTML) $@"; \
663 $(CP) $(JVMTI_HTML) $@; \
664 else \
665 $(ECHO) "WARNING: Generated file does not exist: $(JVMTI_HTML)"; \
666 fi
668 #############################################################
669 #
670 # jaasdocs
671 #
673 ALL_OTHER_TARGETS += jaasdocs
675 JAAS_DOCDIR := $(JRE_API_DOCSDIR)/security/jaas/spec
676 JAAS2COREAPI := ../../../$(JDKJRE2COREAPI)
677 JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service
678 JAAS_WINDOWTITLE := Java Authentication and Authorization Service
679 JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong>
680 JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR))
681 # JAAS_PKGS is located in NON_CORE_PKGS.gmk
682 JAAS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/auth/jaas-overview.html
684 # The index.html, options, and packages files
685 JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html
686 JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options
687 JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages
689 jaasdocs: $(JAAS_INDEX_FILE)
691 # Set relative location to core api document root
692 $(JAAS_INDEX_FILE): GET2DOCSDIR=$(JAAS2COREAPI)/..
694 # Run javadoc if the index file is out of date or missing
695 $(JAAS_INDEX_FILE): $(JAAS_OPTIONS_FILE) $(JAAS_PACKAGES_FILE) coredocs
696 $(prep-javadoc)
697 $(call JavadocSummary,$(JAAS_OPTIONS_FILE),$(JAAS_PACKAGES_FILE))
698 $(JAVADOC_CMD) -d $(@D) \
699 @$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE)
701 # Create file with javadoc options in it
702 $(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW)
703 $(prep-target)
704 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
705 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
706 $(call OptionPair,-encoding,ascii) ; \
707 $(call OptionPair,-overview,$(JAAS_OVERVIEW)) ; \
708 $(call OptionPair,-doctitle,$(JAAS_DOCTITLE)) ; \
709 $(call OptionPair,-windowtitle,$(JAAS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
710 $(call OptionPair,-header,$(JAAS_HEADER)$(DRAFT_HEADER)) ; \
711 $(call OptionPair,-bottom,$(JAAS_BOTTOM)$(DRAFT_BOTTOM)) ; \
712 $(call OptionTrip,-linkoffline,$(JAAS2COREAPI),$(COREAPI_DOCSDIR)/); \
713 ) >> $@
715 # Create a file with the package names in it
716 $(JAAS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JAAS_PKGS))
717 $(prep-target)
718 $(call PackageFilter,$(JAAS_PKGS))
720 #############################################################
721 #
722 # jgssdocs
723 #
725 ALL_OTHER_TARGETS += jgssdocs
727 JGSS_DOCDIR := $(JRE_API_DOCSDIR)/security/jgss/spec
728 JGSS2COREAPI := ../../../$(JDKJRE2COREAPI)
729 JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities
730 JGSS_WINDOWTITLE := Java GSS-API Utilities
731 JGSS_HEADER := <strong>Java GSS-API Utilities</strong>
732 JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR))
733 JGSS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/jgss/jgss-overview.html
734 # JGSS_PKGS is located in NON_CORE_PKGS.gmk
736 # The index.html, options, and packages files
737 JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html
738 JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options
739 JGSS_PACKAGES_FILE = $(DOCSTMPDIR)/jgss.packages
741 jgssdocs: $(JGSS_INDEX_FILE)
743 # Set relative location to core api document root
744 $(JGSS_INDEX_FILE): GET2DOCSDIR=$(JGSS2COREAPI)/..
746 # Run javadoc if the index file is out of date or missing
747 $(JGSS_INDEX_FILE): $(JGSS_OPTIONS_FILE) $(JGSS_PACKAGES_FILE) coredocs
748 $(prep-javadoc)
749 $(call JavadocSummary,$(JGSS_OPTIONS_FILE),$(JGSS_PACKAGES_FILE))
750 $(JAVADOC_CMD) -d $(@D) \
751 @$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE)
753 # Create file with javadoc options in it
754 $(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW)
755 $(prep-target)
756 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
757 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
758 $(call OptionPair,-encoding,ascii) ; \
759 $(call OptionOnly,-nodeprecatedlist) ; \
760 $(call OptionPair,-overview,$(JGSS_OVERVIEW)) ; \
761 $(call OptionPair,-doctitle,$(JGSS_DOCTITLE)) ; \
762 $(call OptionPair,-windowtitle,$(JGSS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
763 $(call OptionPair,-header,$(JGSS_HEADER)$(DRAFT_HEADER)) ; \
764 $(call OptionPair,-bottom,$(JGSS_BOTTOM)$(DRAFT_BOTTOM)) ; \
765 $(call OptionTrip,-linkoffline,$(JGSS2COREAPI),$(COREAPI_DOCSDIR)/); \
766 ) >> $@
768 # Create a file with the package names in it
769 $(JGSS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JGSS_PKGS))
770 $(prep-target)
771 $(call PackageFilter,$(JGSS_PKGS))
773 #############################################################
774 #
775 # smartcardiodocs
776 #
778 ALL_OTHER_TARGETS += smartcardiodocs
780 SMARTCARDIO_DOCDIR := $(JRE_API_DOCSDIR)/security/smartcardio/spec
781 SMARTCARDIO2COREAPI := ../../../$(JDKJRE2COREAPI)
782 SMARTCARDIO_DOCTITLE := Java$(TRADEMARK) Smart Card I/O
783 SMARTCARDIO_WINDOWTITLE := Java Smart Card I/O
784 SMARTCARDIO_HEADER := <strong>Java Smart Card I/O</strong>
785 SMARTCARDIO_BOTTOM := $(call CommonBottom,$(SMARTCARDIO_FIRST_COPYRIGHT_YEAR))
786 # SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk
788 # The index.html, options, and packages files
789 SMARTCARDIO_INDEX_FILE = $(SMARTCARDIO_DOCDIR)/index.html
790 SMARTCARDIO_OPTIONS_FILE = $(DOCSTMPDIR)/smartcardio.options
791 SMARTCARDIO_PACKAGES_FILE = $(DOCSTMPDIR)/smartcardio.packages
793 smartcardiodocs: $(SMARTCARDIO_INDEX_FILE)
795 # Set relative location to core api document root
796 $(SMARTCARDIO_INDEX_FILE): GET2DOCSDIR=$(SMARTCARDIO2COREAPI)/..
798 # Run javadoc if the index file is out of date or missing
799 $(SMARTCARDIO_INDEX_FILE): $(SMARTCARDIO_OPTIONS_FILE) $(SMARTCARDIO_PACKAGES_FILE) coredocs
800 $(prep-javadoc)
801 $(call JavadocSummary,$(SMARTCARDIO_OPTIONS_FILE),$(SMARTCARDIO_PACKAGES_FILE))
802 $(JAVADOC_CMD) -d $(@D) \
803 @$(SMARTCARDIO_OPTIONS_FILE) @$(SMARTCARDIO_PACKAGES_FILE)
805 # Create file with javadoc options in it
806 $(SMARTCARDIO_OPTIONS_FILE):
807 $(prep-target)
808 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
809 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
810 $(call OptionPair,-encoding,ascii) ; \
811 $(call OptionOnly,-nodeprecatedlist) ; \
812 $(call OptionPair,-doctitle,$(SMARTCARDIO_DOCTITLE)) ; \
813 $(call OptionPair,-windowtitle,$(SMARTCARDIO_WINDOWTITLE) $(DRAFT_WINTITLE));\
814 $(call OptionPair,-header,$(SMARTCARDIO_HEADER)$(DRAFT_HEADER)); \
815 $(call OptionPair,-bottom,$(SMARTCARDIO_BOTTOM)$(DRAFT_BOTTOM)); \
816 $(call OptionTrip,-linkoffline,$(SMARTCARDIO2COREAPI),$(COREAPI_DOCSDIR)/); \
817 ) >> $@
819 # Create a file with the package names in it
820 $(SMARTCARDIO_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SMARTCARDIO_PKGS))
821 $(prep-target)
822 $(call PackageFilter,$(SMARTCARDIO_PKGS))
824 #############################################################
825 #
826 # httpserverdocs
827 #
829 ALL_OTHER_TARGETS += httpserverdocs
831 HTTPSERVER_DOCDIR := $(JRE_API_DOCSDIR)/net/httpserver/spec
832 HTTPSERVER2COREAPI := ../../../$(JDKJRE2COREAPI)
833 HTTPSERVER_DOCTITLE := Java$(TRADEMARK) HTTP Server
834 HTTPSERVER_WINDOWTITLE := Java HTTP Server
835 HTTPSERVER_HEADER := <strong>Java HTTP Server</strong>
836 HTTPSERVER_BOTTOM := $(call CommonBottom,$(HTTPSERVER_FIRST_COPYRIGHT_YEAR))
837 # HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk
839 HTTPSERVER_INDEX_HTML = $(HTTPSERVER_DOCDIR)/index.html
840 HTTPSERVER_OPTIONS_FILE = $(DOCSTMPDIR)/httpserver.options
841 HTTPSERVER_PACKAGES_FILE = $(DOCSTMPDIR)/httpserver.packages
843 httpserverdocs: $(HTTPSERVER_INDEX_HTML)
845 # Set relative location to core api document root
846 $(HTTPSERVER_INDEX_HTML): GET2DOCSDIR=$(HTTPSERVER2COREAPI)/..
848 # Run javadoc if the index file is out of date or missing
849 $(HTTPSERVER_INDEX_HTML): $(HTTPSERVER_OPTIONS_FILE) $(HTTPSERVER_PACKAGES_FILE) coredocs
850 $(prep-javadoc)
851 $(call JavadocSummary,$(HTTPSERVER_OPTIONS_FILE),$(HTTPSERVER_PACKAGES_FILE))
852 $(JAVADOC_CMD) -d $(@D) \
853 @$(HTTPSERVER_OPTIONS_FILE) @$(HTTPSERVER_PACKAGES_FILE)
855 # Create file with javadoc options in it
856 $(HTTPSERVER_OPTIONS_FILE):
857 $(prep-target)
858 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
859 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
860 $(call OptionPair,-encoding,ascii) ; \
861 $(call OptionOnly,-nodeprecatedlist) ; \
862 $(call OptionPair,-doctitle,$(HTTPSERVER_DOCTITLE)) ; \
863 $(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE));\
864 $(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \
865 $(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \
866 $(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \
867 ) >> $@
869 # Create a file with the package names in it
870 $(HTTPSERVER_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(HTTPSERVER_PKGS))
871 $(prep-target)
872 $(call PackageFilter,$(HTTPSERVER_PKGS))
874 #############################################################
875 #
876 # mgmtdocs
877 #
879 ALL_OTHER_TARGETS += mgmtdocs
881 MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension
882 MGMT2COREAPI := ../../$(JDKJRE2COREAPI)
883 JVM_MIB_NAME := JVM-MANAGEMENT-MIB.mib
884 JVM_MIB_SRC := $(JDK_TOPDIR)/src/closed/share/classes/sun/management/snmp/$(JVM_MIB_NAME)
885 MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform
886 MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform
887 MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong>
888 MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR))
889 MGMT_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/management/mgmt-overview.html
890 # MGMT_PKGS is located in NON_CORE_PKGS.gmk
892 # The index.html, options, and packages files
893 MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html
894 MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options
895 MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages
897 mgmtdocs: $(MGMT_INDEX_FILE)
899 # Set relative location to core api document root
900 $(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/..
902 # Run javadoc if the index file is out of date or missing
903 $(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) coredocs
904 $(prep-javadoc)
905 @if [ -f $(JVM_MIB_SRC) ] ; then \
906 $(ECHO) "$(CP) $(JVM_MIB_SRC) $(@D)/.."; \
907 $(CP) $(JVM_MIB_SRC) $(@D)/.. ; \
908 else \
909 $(ECHO) "WARNING: File $(JVM_MIB_NAME) not available."; \
910 fi
911 $(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE))
912 $(JAVADOC_CMD) -d $(@D) \
913 @$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE)
915 # Create file with javadoc options in it
916 $(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW)
917 $(prep-target)
918 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
919 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
920 $(call OptionPair,-encoding,ascii) ; \
921 $(call OptionOnly,-nodeprecatedlist) ; \
922 $(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \
923 $(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \
924 $(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \
925 $(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \
926 $(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \
927 $(call OptionTrip,-linkoffline,$(MGMT2COREAPI),$(COREAPI_DOCSDIR)/); \
928 ) >> $@
930 # Create a file with the package names in it
931 $(MGMT_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(MGMT_PKGS))
932 $(prep-target)
933 $(call PackageFilter,$(MGMT_PKGS))
935 #############################################################
936 #
937 # attachdocs
938 #
940 ALL_OTHER_TARGETS += attachdocs
942 ATTACH_DOCDIR := $(JDK_API_DOCSDIR)/attach/spec
943 ATTACH2COREAPI := ../../$(JDKJRE2COREAPI)
944 ATTACH_DOCTITLE := Attach API
945 ATTACH_WINDOWTITLE := Attach API
946 ATTACH_HEADER := <strong>Attach API</strong>
947 ATTACH_BOTTOM := $(call CommonBottom,$(ATTACH_FIRST_COPYRIGHT_YEAR))
948 # ATTACH_PKGS is located in NON_CORE_PKGS.gmk
950 ATTACH_INDEX_HTML = $(ATTACH_DOCDIR)/index.html
951 ATTACH_OPTIONS_FILE = $(DOCSTMPDIR)/attach.options
952 ATTACH_PACKAGES_FILE = $(DOCSTMPDIR)/attach.packages
954 attachdocs: $(ATTACH_INDEX_HTML)
956 # Set relative location to core api document root
957 $(ATTACH_INDEX_HTML): GET2DOCSDIR=$(ATTACH2COREAPI)/..
959 # Run javadoc if the index file is out of date or missing
960 $(ATTACH_INDEX_HTML): $(ATTACH_OPTIONS_FILE) $(ATTACH_PACKAGES_FILE) coredocs
961 $(prep-javadoc)
962 $(call JavadocSummary,$(ATTACH_OPTIONS_FILE),$(ATTACH_PACKAGES_FILE))
963 $(JAVADOC_CMD) -d $(@D) \
964 @$(ATTACH_OPTIONS_FILE) @$(ATTACH_PACKAGES_FILE)
966 # Create file with javadoc options in it
967 $(ATTACH_OPTIONS_FILE):
968 $(prep-target)
969 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
970 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
971 $(call OptionPair,-encoding,ascii) ; \
972 $(call OptionOnly,-nodeprecatedlist) ; \
973 $(call OptionPair,-doctitle,$(ATTACH_DOCTITLE)) ; \
974 $(call OptionPair,-windowtitle,$(ATTACH_WINDOWTITLE) $(DRAFT_WINTITLE));\
975 $(call OptionPair,-header,$(ATTACH_HEADER)$(DRAFT_HEADER)) ; \
976 $(call OptionPair,-bottom,$(ATTACH_BOTTOM)$(DRAFT_BOTTOM)) ; \
977 $(call OptionTrip,-linkoffline,$(ATTACH2COREAPI),$(COREAPI_DOCSDIR)/); \
978 ) >> $@
980 # Create a file with the package names in it
981 $(ATTACH_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(ATTACH_PKGS))
982 $(prep-target)
983 $(call PackageFilter,$(ATTACH_PKGS))
985 #############################################################
986 #
987 # jconsoledocs
988 #
990 ALL_OTHER_TARGETS += jconsoledocs
992 JCONSOLE_DOCDIR := $(JDK_API_DOCSDIR)/jconsole/spec
993 JCONSOLE2COREAPI := ../../$(JDKJRE2COREAPI)
994 JCONSOLE_DOCTITLE := JConsole API
995 JCONSOLE_WINDOWTITLE := JConsole API
996 JCONSOLE_HEADER := <strong>JConsole API</strong>
997 JCONSOLE_BOTTOM := $(call CommonBottom,$(JCONSOLE_FIRST_COPYRIGHT_YEAR))
998 # JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk
1000 JCONSOLE_INDEX_HTML = $(JCONSOLE_DOCDIR)/index.html
1001 JCONSOLE_OPTIONS_FILE = $(DOCSTMPDIR)/jconsole.options
1002 JCONSOLE_PACKAGES_FILE = $(DOCSTMPDIR)/jconsole.packages
1004 jconsoledocs: $(JCONSOLE_INDEX_HTML)
1006 # Set relative location to core api document root
1007 $(JCONSOLE_INDEX_HTML): GET2DOCSDIR=$(JCONSOLE2COREAPI)/..
1009 # Run javadoc if the index file is out of date or missing
1010 $(JCONSOLE_INDEX_HTML): $(JCONSOLE_OPTIONS_FILE) $(JCONSOLE_PACKAGES_FILE) coredocs
1011 $(prep-javadoc)
1012 $(call JavadocSummary,$(JCONSOLE_OPTIONS_FILE),$(JCONSOLE_PACKAGES_FILE))
1013 $(JAVADOC_CMD) -d $(@D) \
1014 @$(JCONSOLE_OPTIONS_FILE) @$(JCONSOLE_PACKAGES_FILE)
1016 # Create file with javadoc options in it
1017 $(JCONSOLE_OPTIONS_FILE):
1018 $(prep-target)
1019 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1020 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1021 $(call OptionPair,-encoding,ascii) ; \
1022 $(call OptionOnly,-nodeprecatedlist) ; \
1023 $(call OptionPair,-doctitle,$(JCONSOLE_DOCTITLE)) ; \
1024 $(call OptionPair,-windowtitle,$(JCONSOLE_WINDOWTITLE) $(DRAFT_WINTITLE));\
1025 $(call OptionPair,-header,$(JCONSOLE_HEADER)$(DRAFT_HEADER)) ; \
1026 $(call OptionPair,-bottom,$(JCONSOLE_BOTTOM)$(DRAFT_BOTTOM)) ; \
1027 $(call OptionTrip,-linkoffline,$(JCONSOLE2COREAPI),$(COREAPI_DOCSDIR)/); \
1028 ) >> $@
1030 # Create a file with the package names in it
1031 $(JCONSOLE_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JCONSOLE_PKGS))
1032 $(prep-target)
1033 $(call PackageFilter,$(JCONSOLE_PKGS))
1035 #############################################################
1036 #
1037 # treeapidocs
1038 #
1040 ALL_OTHER_TARGETS += treeapidocs
1042 TREEAPI_DOCDIR := $(JDK_API_DOCSDIR)/javac/tree
1043 TREEAPI2COREAPI := ../../$(JDKJRE2COREAPI)
1044 TREEAPI_DOCTITLE := Compiler Tree API
1045 TREEAPI_WINDOWTITLE := Compiler Tree API
1046 TREEAPI_HEADER := <strong>Compiler Tree API</strong>
1047 TREEAPI_BOTTOM := $(call CommonBottom,$(TREEAPI_FIRST_COPYRIGHT_YEAR))
1048 TREEAPI_GROUPNAME := Packages
1049 TREEAPI_REGEXP := com.sun.source.*
1050 # TREEAPI_PKGS is located in NON_CORE_PKGS.gmk
1052 TREEAPI_INDEX_HTML = $(TREEAPI_DOCDIR)/index.html
1053 TREEAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options
1054 TREEAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages
1056 treeapidocs: $(TREEAPI_INDEX_HTML)
1058 # Set relative location to core api document root
1059 $(TREEAPI_INDEX_HTML): GET2DOCSDIR=$(TREEAPI2COREAPI)/..
1061 # Run javadoc if the index file is out of date or missing
1062 $(TREEAPI_INDEX_HTML): $(TREEAPI_OPTIONS_FILE) $(TREEAPI_PACKAGES_FILE) coredocs
1063 $(prep-javadoc)
1064 $(call JavadocSummary,$(TREEAPI_OPTIONS_FILE),$(TREEAPI_PACKAGES_FILE))
1065 $(JAVADOC_CMD) -d $(@D) \
1066 @$(TREEAPI_OPTIONS_FILE) @$(TREEAPI_PACKAGES_FILE)
1068 # Create file with javadoc options in it
1069 $(TREEAPI_OPTIONS_FILE):
1070 $(prep-target)
1071 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1072 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1073 $(call OptionPair,-encoding,ascii) ; \
1074 $(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \
1075 $(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\
1076 $(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \
1077 $(call OptionPair,-tag,$(TAG_JLS)) ; \
1078 $(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1079 $(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \
1080 $(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1081 ) >> $@
1083 # Create a file with the package names in it
1084 $(TREEAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TREEAPI_PKGS))
1085 $(prep-target)
1086 $(call PackageFilter,$(TREEAPI_PKGS))
1088 #############################################################
1089 #
1090 # sctpdocs
1091 #
1093 ALL_OTHER_TARGETS += sctpdocs
1095 SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec
1096 SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
1097 SCTPAPI_DOCTITLE := SCTP API
1098 SCTPAPI_WINDOWTITLE := SCTP API
1099 SCTPAPI_HEADER := <strong>SCTP API</strong>
1100 SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR))
1101 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk
1103 SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html
1104 SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options
1105 SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages
1107 sctpdocs: $(SCTPAPI_INDEX_HTML)
1109 # Set relative location to core api document root
1110 $(SCTPAPI_INDEX_HTML): GET2DOCSDIR=$(SCTPAPI2COREAPI)/..
1112 # Run javadoc if the index file is out of date or missing
1113 $(SCTPAPI_INDEX_HTML): $(SCTPAPI_OPTIONS_FILE) $(SCTPAPI_PACKAGES_FILE) coredocs
1114 $(prep-javadoc)
1115 $(call JavadocSummary,$(SCTPAPI_OPTIONS_FILE),$(SCTPAPI_PACKAGES_FILE))
1116 $(JAVADOC_CMD) -d $(@D) \
1117 @$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE)
1119 # Create file with javadoc options in it
1120 $(SCTPAPI_OPTIONS_FILE):
1121 $(prep-target)
1122 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1123 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1124 $(call OptionPair,-encoding,ascii) ; \
1125 $(call OptionOnly,-nodeprecatedlist) ; \
1126 $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \
1127 $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\
1128 $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \
1129 $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1130 $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1131 ) >> $@
1133 # Create a file with the package names in it
1134 $(SCTPAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SCTPAPI_PKGS))
1135 $(prep-target)
1136 $(call PackageFilter,$(SCTPAPI_PKGS))
1138 #############################################################
1139 #
1140 # Get a cache of all the directories
1142 $(DIRECTORY_CACHE): $(ALL_EXISTING_SOURCE_DIRS)
1143 $(prep-target)
1144 @for cp in $(ALL_EXISTING_SOURCE_DIRS) ; do \
1145 $(ECHO) "$(FIND) $${cp} -type f >> $@"; \
1146 $(FIND) $${cp} -type f >> $@; \
1147 done
1149 #############################################################
1150 #release version of core packages ########
1151 # Maximize performance and ensure that build number & milestone are set.
1153 rel-coredocs: sanitycheckcoredocs
1154 $(MAKE) coredocs
1156 rel-docs: rel-coredocs $(ALL_OTHER_TARGETS)
1157 #
1158 # end of production targets
1160 otherdocs: $(ALL_OTHER_TARGETS)
1162 clean:
1163 $(RM) -r $(DOCSDIR) $(DOCSTMPDIR)
1165 #############################################################
1166 # DEBUG TARGET
1167 # List the values defined in the makefile hierarchy, to make sure everything
1168 # is set properly, and to help identify values we can use instead of making new ones.
1169 # (Most of them come from common/shared/Defs.gmk)
1170 #
1171 # Notes:
1172 # * BUILD_NUMBER defaults to b00 if not set on command line with BUILD_NUMBER=<value>
1173 # * MILESTONE defaults to internal unless set to beta, rc, or fcs on command line
1174 #
1176 #############################################################
1177 .PHONY: all docs coredocs rel-docs otherdocs rel-coredocs \
1178 sanitycheckcoredocs $(ALL_OTHER_TARGETS)
