Mercurial > jdk8-mips64-public / file revision
common/makefiles/javadoc/Javadoc.gmk@6ff2e1280dc3
common/makefiles/javadoc/Javadoc.gmk
Wed, 28 Nov 2012 13:40:17 +0100
- author
- erikj
- date
- Wed, 28 Nov 2012 13:40:17 +0100
- changeset 518
- 6ff2e1280dc3
- parent 478
- 2ba6f4da4bf3
- child 558
- d5f3a6f60d51
- child 592
- 1129fb75f611
- permissions
- -rw-r--r--
8003844: build-infra: docs target isn't working properly
Summary: Fixed docs and docs-clean target. Added compare support for docs.
Reviewed-by: ohair, jjg, ohrstrom
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 CLASSPATH_SEPARATOR = :
37 DOCSDIR=$(OUTPUT_ROOT)/docs
38 TEMPDIR=$(OUTPUT_ROOT)/docstemp
40 JDK_SHARE_SRC=$(JDK_TOPDIR)/src/share
41 JDK_SHARE_CLASSES=$(JDK_SHARE_SRC)/classes
43 JDK_IMPSRC = $(JDK_OUTPUTDIR)/impsrc
45 JDK_GENSRC = $(JDK_OUTPUTDIR)/gensrc
47 HOTSPOT_DOCS_IMPORT_PATH=$(HOTSPOT_OUTPUTDIR)/docs
49 BUILD_NUMBER=$(JDK_BUILD_NUMBER)
51 BOOT_JAVA_CMD=$(JAVA)
53 JAVADOC_JAR = $(LANGTOOLS_DIST)/bootstrap/lib/javadoc.jar
54 JAVADOC_CMD = $(BOOT_JAVA_CMD) \
55 -Xmx1024m \
56 -Djava.awt.headless=true \
57 "-Xbootclasspath/p:$(JAVADOC_JAR)" \
58 -jar $(JAVADOC_JAR) -bootclasspath $(JDK_OUTPUTDIR)/classes
60 # Copyright year for beginning of Java and some of the apis
61 # (Needed when creating the javadocs)
62 FIRST_COPYRIGHT_YEAR = 1993
63 DOMAPI_FIRST_COPYRIGHT_YEAR = 2005
64 MIRROR_FIRST_COPYRIGHT_YEAR = 2004
65 DOCLETAPI_FIRST_COPYRIGHT_YEAR = 1993
66 TAGLETAPI_FIRST_COPYRIGHT_YEAR = 1993
67 JDI_FIRST_COPYRIGHT_YEAR = 1999
68 JAAS_FIRST_COPYRIGHT_YEAR = 1998
69 JGSS_FIRST_COPYRIGHT_YEAR = 2000
70 SMARTCARDIO_FIRST_COPYRIGHT_YEAR = 2005
71 HTTPSERVER_FIRST_COPYRIGHT_YEAR = 2005
72 MGMT_FIRST_COPYRIGHT_YEAR = 2003
73 ATTACH_FIRST_COPYRIGHT_YEAR = 2005
74 JCONSOLE_FIRST_COPYRIGHT_YEAR = 2006
75 SCTPAPI_FIRST_COPYRIGHT_YEAR = 2009
76 TRACING_FIRST_COPYRIGHT_YEAR = 2008
77 TREEAPI_FIRST_COPYRIGHT_YEAR = 2005
78 JNLP_FIRST_COPYRIGHT_YEAR = 1998
79 PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007
81 # Oracle name
82 FULL_COMPANY_NAME = Oracle and/or its affiliates
84 # Copyright address
85 COMPANY_ADDRESS = 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA.
87 # The trademark symbol
88 TRADEMARK = ™
90 # Common copyright lines used
91 # The word "Copyright" might optionally be a link to the file cpyr.html.
92 # The first year of copyright may vary or not be available.
93 # The address to the company might be optional.
94 COMMA:= ,
95 EMPTY:=
96 SPACE:=$(EMPTY) $(EMPTY)
97 COPYRIGHT_SYMBOL = &\#x00a9;
98 # Macro to construct the copyright line
99 # (The GNU make 3.78.1 "if" conditional is broken, fixed in GNU make 3.81)
100 define CopyrightLine # optionalurl optionalfirstyear optionaladdress
101 $(if $(strip $1),<a href="$(strip $1)">Copyright</a>,Copyright) \
102 $(COPYRIGHT_SYMBOL) $(if $2,$2${COMMA},) $(COPYRIGHT_YEAR),\
103 $(FULL_COMPANY_NAME). $3 All rights reserved.
104 endef
106 # Url to root of documents
107 DOCSDIR_URL = {@docroot}/$(GET2DOCSDIR)
109 # Url to copyright html file
110 COPYRIGHT_URL-7 = $(DOCSDIR_URL)/legal/cpyr.html
111 # This isn't added in old build yet.
112 #COPYRIGHT_URL-8 = $(DOCSDIR_URL)/legal/cpyr.html
113 COPYRIGHT_URL = $(COPYRIGHT_URL-$(JDK_MINOR_VERSION))
115 # Url to bug filing site
116 BUG_SUBMIT_URL = http://bugreport.sun.com/bugreport/
118 # Common line for how to submit a bug or rfe
119 BUG_SUBMIT_LINE = <a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a>
121 # Url to devdocs page
122 # Was: http://java.sun.com/javase/6/webnotes/devdocs-vs-specs.html
123 DEV_DOCS_URL-7 = http://download.oracle.com/javase/7/docs/index.html
124 # This isn't added in old build yet.
125 #DEV_DOCS_URL-8 = http://download.oracle.com/javase/7/docs/index.html
126 DEV_DOCS_URL = $(DEV_DOCS_URL-$(JDK_MINOR_VERSION))
127 DOCS_BASE_URL = http://download.oracle.com/javase/7/docs
129 # Common Java trademark line
130 JAVA_TRADEMARK_LINE = Java is a trademark or registered trademark of \
131 $(FULL_COMPANY_NAME) in the US and other countries.
133 #################################################################
134 # Macros:
137 # List of all possible directories for javadoc to look for sources
138 # NOTE: Quotes are required around sourcepath argument only on Windows.
139 # Otherwise, you get "No packages or classes specified." due
140 # to $(CLASSPATH_SEPARATOR) being interpreted as an end of
141 # command (newline or shell ; character)
142 ALL_SOURCE_DIRS = $(JDK_SHARE_CLASSES) \
143 $(JDK_IMPSRC) \
144 $(JDK_GENSRC) \
145 $(JDK_OUTPUTDIR)/gendocsrc_rmic \
146 $(JDK_TOPDIR)/src/solaris/classes \
147 $(JDK_TOPDIR)/src/windows/classes \
148 $(JDK_SHARE_SRC)/doc/stub
150 # List of directories that actually exist
151 ALL_EXISTING_SOURCE_DIRS := $(wildcard $(ALL_SOURCE_DIRS))
153 # List with classpath separator between them
154 EMPTY:=
155 SPACE:= $(EMPTY) $(EMPTY)
156 RELEASEDOCS_SOURCEPATH = \
157 $(subst $(SPACE),$(CLASSPATH_SEPARATOR),$(strip $(ALL_SOURCE_DIRS)))
159 define prep-target
160 $(MKDIR) -p $(@D)
161 $(RM) $@
162 endef
164 # Prep for javadoc creation, assumes $@ is an index.html file
165 define prep-javadoc
166 @if [ -f "$@" -a "$?" != "" ] ; then \
167 $(ECHO) "# Dependencies have changed: $?"; \
168 fi
169 $(RM) -r $(@D)
170 $(MKDIR) -p $(@D)
171 endef
173 # A cache of the directories in ALL_SOURCE_DIRS
174 DIRECTORY_CACHE = $(DOCSTMPDIR)/directory.cache
176 # Given a list of packages, return a list of files or dirs to be dependent on
177 # (Currently only returning a list of directories)
178 define PackageDependencies # packages
179 $(shell \
180 if [ "$1" != "" -a -f $(DIRECTORY_CACHE) ] ; then \
181 for p in $1 ; do \
182 pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \
183 $(CAT) $(DIRECTORY_CACHE) | $(GREP) "/$${pd}/" ; \
184 done; \
185 fi \
186 )
187 endef
189 # Given a list of packages, add packages that exist to $@, print summary
190 define PackageFilter # packages
191 @if [ "$1" != "" ] ; then \
192 for p in $1 ; do \
193 pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \
194 found="false"; \
195 for cp in $(ALL_SOURCE_DIRS) ; do \
196 if [ -d $${cp}/$${pd} ] ; then \
197 $(ECHO) "$${p}" >> $@; \
198 found="true"; \
199 break; \
200 fi; \
201 done; \
202 if [ "$${found}" = "false" ] ; then \
203 $(ECHO) "WARNING: Package not found: $${p}"; \
204 fi; \
205 done; \
206 fi
207 endef
209 # Print out a summary of the javadoc command about to be run
210 define JavadocSummary # optionsfile packagesfile
211 @$(ECHO) "# Summary for $@";\
212 $(ECHO) "# Options (`$(BASENAME) $1`):"; $(SED) -e 's@^@# @' $1; \
213 $(ECHO) "# Packages (`$(BASENAME) $2`):";$(SED) -e 's@^@# @' $2
214 endef
216 #
217 # Temporary directory for javadoc creation
218 #
219 DOCSTMPDIR = $(TEMPDIR)/doctmp
221 #
222 # Different api directories created from root directory
223 #
224 COREAPI_DOCSDIR = $(DOCSDIR)/api
225 JDK_API_DOCSDIR = $(DOCSDIR)/jdk/api
226 JRE_API_DOCSDIR = $(DOCSDIR)/jre/api
227 PLATFORM_DOCSDIR = $(DOCSDIR)/platform
229 # The non-core api javadocs need to be able to access the root of the core
230 # api directory, so for jdk/api or jre/api to get to the core api/
231 # directory we would use this:
232 JDKJRE2COREAPI = ../../api
234 # Common bottom argument
235 define CommonBottom # year
236 <font size="-1"><br> $(call CopyrightLine,,$1,)</font>
237 endef
239 # Common trademark bottom argument (Not sure why this is used sometimes)
240 define CommonTrademarkBottom # year
241 <font size="-1">\
242 $(BUG_SUBMIT_LINE)<br>$(JAVA_TRADEMARK_LINE)<br>\
243 $(call CopyrightLine,,$1,$(COMPANY_ADDRESS))\
244 </font>
245 endef
247 # Common echo of option
248 define OptionOnly # opt
249 $(PRINTF) "%s\n" "$1"
250 endef
251 define OptionPair # opt arg
252 $(PRINTF) "%s '%s'\n" "$1" '$2'
253 endef
254 define OptionTrip # opt arg arg
255 $(PRINTF) "%s '%s' '%s'\n" "$1" '$2' '$3'
256 endef
258 # Core api bottom argument (with special sauce)
259 COREAPI_BOTTOM = <font size="-1"> $(BUG_SUBMIT_LINE)\
260 <br>For further API reference and developer documentation, \
261 see <a href="$(DEV_DOCS_URL)" target="_blank">Java SE Documentation</a>. \
262 That documentation contains more detailed, developer-targeted descriptions, \
263 with conceptual overviews, definitions of terms, workarounds, \
264 and working code examples.<br>\
265 $(call CopyrightLine,$(COPYRIGHT_URL),$(FIRST_COPYRIGHT_YEAR),)\
266 </font>
268 # Common javadoc options used by all
269 COMMON_JAVADOCFLAGS = \
270 -XDignore.symbol.file=true \
271 -quiet \
272 -use \
273 -keywords \
274 $(ADDITIONAL_JAVADOCFLAGS)
276 ifdef OPENJDK
277 ADDITIONAL_JAVADOCFLAGS = \
278 -Xdocrootparent $(DOCS_BASE_URL)
279 else
280 ADDITIONAL_JAVADOCFLAGS =
281 endif
283 # Draft used for non-fcs documents
284 DRAFT_HEADER =
285 ifneq ($(MILESTONE), fcs)
286 DRAFT_HEADER = <br><strong>DRAFT $(MILESTONE)-$(BUILD_NUMBER)</strong>
287 DRAFT_BOTTOM = <br><strong>DRAFT $(MILESTONE)-$(BUILD_NUMBER)</strong>
288 DRAFT_WINTITLE = $(BUILD_NUMBER)
289 # Early access top text (not used in FCS releases)
290 COREAPI_TOP_EARLYACCESS = \
291 <div style="background-color: \#EEEEEE"> \
292 <div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; \
293 margin-left: 6px; margin-right: 6px; text-align: justify; \
294 font-size: 80%; font-family: Helvetica, Arial, sans-serif; \
295 font-weight: normal;"> \
296 Please note that the specifications and other information \
297 contained herein are not final and are subject to change. \
298 The information is being made available to you solely for purpose of \
299 evaluation. \
300 </div> </div>
301 endif
303 #################################################################
305 #
306 # CORE_PKGS environment variable has been moved to the following file
307 #
308 include CORE_PKGS.gmk
310 #
311 # Load environment variables for API package names that are not part of
312 # the Java SE platform
313 #
314 include NON_CORE_PKGS.gmk
316 #################################################################
318 #
319 # Default target is same as docs target, create core api and all others it can
320 #
322 all: docs
323 docs: coredocs otherdocs
325 #################################################################
326 # Production Targets -- USE THESE TARGETS WHEN:
327 # a) You're generating docs outside of release engineering's
328 # standard control build.
329 # b) The docs will be pushed to the web and/or included in
330 # the downloaded doc bundle.
331 #
332 # See: Notes.html#releaseTargets
333 # Note: Spaces precede ifdef/ifndef indents. Tabs precede target commands (!)
334 #
336 sanitycheckcoredocs:
337 @$(ECHO) ""
338 @$(ECHO) "Building core api docs with these values:"
339 @$(ECHO) " BUILD_NUMBER = $(BUILD_NUMBER)"
340 @$(ECHO) " MILESTONE = $(MILESTONE)"
341 @$(ECHO) ""
342 ifeq ($(BUILD_NUMBER), b00)
343 @$(ECHO) "ERROR: Build number must be defined"
344 @$(ECHO) "MILESTONE is set to $(MILESTONE)"
345 @$(ECHO) ""
346 exit 1
347 endif
349 #############################################################
350 #
351 # coredocs
352 #
353 COREAPI_DOCTITLE = Java$(TRADEMARK) Platform, Standard Edition \
354 $(JDK_MINOR_VERSION)<br>API Specification
355 COREAPI_WINDOWTITLE = Java Platform SE $(JDK_MINOR_VERSION)
356 COREAPI_HEADER = \
357 <strong>Java$(TRADEMARK) Platform<br>Standard Ed. $(JDK_MINOR_VERSION)</strong>
359 # Java language specification cite
360 TAG_JLS = jls:a:See <cite> \
361 The Java™ Language Specification</cite>:
363 # Overview file for core apis
364 COREAPI_OVERVIEW = $(JDK_SHARE_CLASSES)/overview-core.html
366 # The index.html, options, and packages files
367 COREAPI_INDEX_FILE = $(COREAPI_DOCSDIR)/index.html
368 COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options
369 COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages
371 coredocs: $(COREAPI_INDEX_FILE)
373 # Set relative location to core api document root
374 $(COREAPI_INDEX_FILE): GET2DOCSDIR=..
376 # Run javadoc if the index file is out of date or missing
377 $(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE)
378 $(prep-javadoc)
379 $(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE))
380 $(JAVADOC_CMD) -d $(@D) \
381 @$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE)
383 # Create file with javadoc options in it
384 $(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW)
385 $(prep-target)
386 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
387 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
388 $(call OptionPair,-encoding,ISO-8859-1) ; \
389 $(call OptionPair,-tag,beaninfo:X) ; \
390 $(call OptionPair,-tag,revised:X) ; \
391 $(call OptionPair,-tag,since.unbundled:X) ; \
392 $(call OptionPair,-tag,spec:X) ; \
393 $(call OptionPair,-tag,specdefault:X) ; \
394 $(call OptionPair,-tag,Note:X) ; \
395 $(call OptionPair,-tag,ToDo:X) ; \
396 $(call OptionPair,-tag,$(TAG_JLS)) ; \
397 $(call OptionOnly,-splitIndex) ; \
398 $(call OptionPair,-overview,$(COREAPI_OVERVIEW)) ; \
399 $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE)) ; \
400 $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ;\
401 $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER)) ; \
402 $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
403 ) >> $@
404 ifdef COREAPI_TOP_EARLYACCESS
405 @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@
406 endif
408 # Create a file with the package names in it
409 $(COREAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(CORE_PKGS))
410 $(prep-target)
411 $(call PackageFilter,$(CORE_PKGS))
413 #############################################################
414 #
415 # docletapidocs
416 #
418 ALL_OTHER_TARGETS += docletapidocs
420 DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet
421 DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
422 DOCLETAPI_DOCTITLE := Doclet API
423 DOCLETAPI_WINDOWTITLE := Doclet API
424 DOCLETAPI_HEADER := <strong>Doclet API</strong>
425 DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
426 DOCLETAPI_GROUPNAME := Packages
427 DOCLETAPI_REGEXP := com.sun.javadoc
428 # DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
430 # The index.html, options, and packages files
431 DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html
432 DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options
433 DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages
435 docletapidocs: $(DOCLETAPI_INDEX_FILE)
437 # Set relative location to core api document root
438 $(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/..
440 # Run javadoc if the index file is out of date or missing
441 $(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) coredocs
442 $(prep-javadoc)
443 $(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE))
444 $(JAVADOC_CMD) -d $(@D) \
445 @$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE)
447 # Create file with javadoc options in it
448 $(DOCLETAPI_OPTIONS_FILE):
449 $(prep-target)
450 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
451 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
452 $(call OptionPair,-encoding,ascii) ; \
453 $(call OptionOnly,-breakiterator) ; \
454 $(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \
455 $(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\
456 $(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \
457 $(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
458 $(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \
459 $(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
460 ) >> $@
462 # Create a file with the package names in it
463 $(DOCLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOCLETAPI_PKGS))
464 $(prep-target)
465 $(call PackageFilter,$(DOCLETAPI_PKGS))
467 #############################################################
468 #
469 # tagletapidocs
470 #
472 ALL_OTHER_TARGETS += tagletapidocs
473 TAGLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/taglet
474 TAGLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
475 TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR))
476 # TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk
478 # Temporary directory (special generation rules)
479 TAGLETAPI_TEMPDIR = $(DOCSTMPDIR)/taglets_temp
481 # The index.html, options, and packages files
482 TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/index.html
483 TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options
484 TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages
486 tagletapidocs: $(TAGLETAPI_INDEX_FILE)
488 # Set relative location to core api document root
489 $(TAGLETAPI_INDEX_FILE): GET2DOCSDIR=$(TAGLETAPI2COREAPI)/..
491 # Run javadoc if the index file is out of date or missing
492 $(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) coredocs
493 $(prep-javadoc)
494 $(RM) -r $(TAGLETAPI_TEMPDIR)
495 $(MKDIR) -p $(TAGLETAPI_TEMPDIR)
496 $(call JavadocSummary,$(TAGLETAPI_OPTIONS_FILE),$(TAGLETAPI_PACKAGES_FILE))
497 $(JAVADOC_CMD) -d $(TAGLETAPI_TEMPDIR) \
498 @$(TAGLETAPI_OPTIONS_FILE) @$(TAGLETAPI_PACKAGES_FILE)
499 cp -r $(TAGLETAPI_TEMPDIR)/com $(@D)
500 cp $(TAGLETAPI_TEMPDIR)/stylesheet.css $(@D)
501 $(RM) -r $(TAGLETAPI_TEMPDIR)
503 # Create file with javadoc options in it
504 $(TAGLETAPI_OPTIONS_FILE):
505 $(prep-target)
506 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
507 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
508 $(call OptionPair,-encoding,ascii) ; \
509 $(call OptionOnly,-nonavbar) ; \
510 $(call OptionOnly,-noindex) ; \
511 $(call OptionPair,-bottom,$(TAGLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
512 $(call OptionTrip,-linkoffline,$(TAGLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
513 ) >> $@
515 # Create a file with the package names in it
516 $(TAGLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TAGLETAPI_PKGS))
517 $(prep-target)
518 @($(ECHO) "$(JDK_IMPSRC)/$(TAGLETAPI_FILE)" ) > $@
520 #############################################################
521 #
522 # domapidocs
523 #
525 ALL_OTHER_TARGETS += domapidocs
527 DOMAPI_DOCDIR := $(JRE_API_DOCSDIR)/plugin/dom
528 DOMAPI2COREAPI := ../../$(JDKJRE2COREAPI)
529 DOMAPI_DOCTITLE := Common DOM API
530 DOMAPI_WINDOWTITLE := Common DOM API
531 DOMAPI_HEADER := <strong>Common DOM API</strong>
532 DOMAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOMAPI_FIRST_COPYRIGHT_YEAR))
533 DOMAPI_GROUPNAME := Packages
534 DOMAPI_REGEXP := com.sun.java.browser.dom:org.w3c.dom*
535 # DOMAPI_PKGS is located in NON_CORE_PKGS.gmk
537 # The index.html, options, and packages files
538 DOMAPI_INDEX_FILE = $(DOMAPI_DOCDIR)/index.html
539 DOMAPI_OPTIONS_FILE = $(DOCSTMPDIR)/domapi.options
540 DOMAPI_PACKAGES_FILE = $(DOCSTMPDIR)/domapi.packages
542 domapidocs: $(DOMAPI_INDEX_FILE)
544 # Set relative location to core api document root
545 $(DOMAPI_INDEX_FILE): GET2DOCSDIR=$(DOMAPI2COREAPI)/..
547 # Run javadoc if the index file is out of date or missing
548 $(DOMAPI_INDEX_FILE): $(DOMAPI_OPTIONS_FILE) $(DOMAPI_PACKAGES_FILE) coredocs
549 $(prep-javadoc)
550 $(call JavadocSummary,$(DOMAPI_OPTIONS_FILE),$(DOMAPI_PACKAGES_FILE))
551 $(JAVADOC_CMD) -d $(@D) \
552 @$(DOMAPI_OPTIONS_FILE) @$(DOMAPI_PACKAGES_FILE)
554 # Create file with javadoc options in it
555 $(DOMAPI_OPTIONS_FILE):
556 $(prep-target)
557 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
558 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
559 $(call OptionPair,-encoding,ascii) ; \
560 $(call OptionOnly,-splitIndex) ; \
561 $(call OptionPair,-doctitle,$(DOMAPI_DOCTITLE)) ; \
562 $(call OptionPair,-windowtitle,$(DOMAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\
563 $(call OptionPair,-header,$(DOMAPI_HEADER)$(DRAFT_HEADER)) ; \
564 $(call OptionPair,-bottom,$(DOMAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
565 $(call OptionTrip,-group,$(DOMAPI_GROUPNAME),$(DOMAPI_REGEXP)); \
566 $(call OptionTrip,-linkoffline,$(DOMAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
567 ) >> $@
569 # Create a file with the package names in it
570 $(DOMAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOMAPI_PKGS))
571 $(prep-target)
572 $(call PackageFilter,$(DOMAPI_PKGS))
574 #############################################################
575 #
576 # jpdadocs
577 #
579 ALL_OTHER_TARGETS += jpdadocs
581 jpdadocs: jdidocs jdwpdocs jvmtidocs
583 #############################################################
584 #
585 # jdidocs
586 #
588 ALL_OTHER_TARGETS += jdidocs
590 JDI_DOCDIR := $(JDK_API_DOCSDIR)/jpda/jdi
591 JDI2COREAPI := ../../$(JDKJRE2COREAPI)
592 JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface
593 JDI_WINDOWTITLE := Java Debug Interface
594 JDI_HEADER := <strong>Java Debug Interface</strong>
595 JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR))
596 JDI_OVERVIEW := $(JDK_SHARE_CLASSES)/jdi-overview.html
597 # JDI_PKGS is located in NON_CORE_PKGS.gmk
599 # The index.html, options, and packages files
600 JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html
601 JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options
602 JDI_PACKAGES_FILE = $(DOCSTMPDIR)/jdi.packages
604 jdidocs: $(JDI_INDEX_FILE)
606 # Set relative location to core api document root
607 $(JDI_INDEX_FILE): GET2DOCSDIR=$(JDI2COREAPI)/..
609 # Run javadoc if the index file is out of date or missing
610 $(JDI_INDEX_FILE): $(JDI_OPTIONS_FILE) $(JDI_PACKAGES_FILE) coredocs
611 $(prep-javadoc)
612 $(call JavadocSummary,$(JDI_OPTIONS_FILE),$(JDI_PACKAGES_FILE))
613 $(JAVADOC_CMD) -d $(@D) \
614 @$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE)
616 # Create file with javadoc options in it
617 $(JDI_OPTIONS_FILE): $(JDI_OVERVIEW)
618 $(prep-target)
619 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
620 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
621 $(call OptionPair,-encoding,ascii) ; \
622 $(call OptionPair,-overview,$(JDI_OVERVIEW)) ; \
623 $(call OptionPair,-doctitle,$(JDI_DOCTITLE)) ; \
624 $(call OptionPair,-windowtitle,$(JDI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
625 $(call OptionPair,-header,$(JDI_HEADER)$(DRAFT_HEADER)) ; \
626 $(call OptionPair,-bottom,$(JDI_BOTTOM)$(DRAFT_BOTTOM)) ; \
627 $(call OptionTrip,-linkoffline,$(JDI2COREAPI),$(COREAPI_DOCSDIR)/); \
628 ) >> $@
630 # Create a file with the package names in it
631 $(JDI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JDI_PKGS))
632 $(prep-target)
633 $(call PackageFilter,$(JDI_PKGS))
635 #############################################################
636 #
637 # jdwpdocs
638 #
640 ALL_OTHER_TARGETS += jdwpdocs
642 JDWP_DOCDIR = $(PLATFORM_DOCSDIR)/jpda/jdwp
644 jdwpdocs: $(JDWP_DOCDIR)/jdwp-protocol.html
645 $(JDWP_DOCDIR)/jdwp-protocol.html : $(JDK_OUTPUTDIR)/gensrc_jdwp_doc/jdwp-protocol.html
646 $(MKDIR) -p $(@D)
647 $(RM) $@
648 $(CP) $< $@
650 #############################################################
651 #
652 # jvmtidocs
653 #
655 ALL_OTHER_TARGETS += jvmtidocs
657 JVMTI_DOCDIR = $(PLATFORM_DOCSDIR)/jvmti
658 JVMTI_HTML = $(HOTSPOT_DIST)/docs/platform/jvmti/jvmti.html
660 jvmtidocs: $(JVMTI_DOCDIR)/jvmti.html
661 $(JVMTI_DOCDIR)/jvmti.html:
662 @$(prep-javadoc)
663 @if [ -f $(JVMTI_HTML) ] ; then \
664 $(ECHO) "$(CP) $(JVMTI_HTML) $@"; \
665 $(CP) $(JVMTI_HTML) $@; \
666 else \
667 $(ECHO) "WARNING: Generated file does not exist: $(JVMTI_HTML)"; \
668 fi
670 #############################################################
671 #
672 # jaasdocs
673 #
675 ALL_OTHER_TARGETS += jaasdocs
677 JAAS_DOCDIR := $(JRE_API_DOCSDIR)/security/jaas/spec
678 JAAS2COREAPI := ../../../$(JDKJRE2COREAPI)
679 JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service
680 JAAS_WINDOWTITLE := Java Authentication and Authorization Service
681 JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong>
682 JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR))
683 # JAAS_PKGS is located in NON_CORE_PKGS.gmk
684 JAAS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/auth/jaas-overview.html
686 # The index.html, options, and packages files
687 JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html
688 JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options
689 JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages
691 jaasdocs: $(JAAS_INDEX_FILE)
693 # Set relative location to core api document root
694 $(JAAS_INDEX_FILE): GET2DOCSDIR=$(JAAS2COREAPI)/..
696 # Run javadoc if the index file is out of date or missing
697 $(JAAS_INDEX_FILE): $(JAAS_OPTIONS_FILE) $(JAAS_PACKAGES_FILE) coredocs
698 $(prep-javadoc)
699 $(call JavadocSummary,$(JAAS_OPTIONS_FILE),$(JAAS_PACKAGES_FILE))
700 $(JAVADOC_CMD) -d $(@D) \
701 @$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE)
703 # Create file with javadoc options in it
704 $(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW)
705 $(prep-target)
706 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
707 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
708 $(call OptionPair,-encoding,ascii) ; \
709 $(call OptionPair,-overview,$(JAAS_OVERVIEW)) ; \
710 $(call OptionPair,-doctitle,$(JAAS_DOCTITLE)) ; \
711 $(call OptionPair,-windowtitle,$(JAAS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
712 $(call OptionPair,-header,$(JAAS_HEADER)$(DRAFT_HEADER)) ; \
713 $(call OptionPair,-bottom,$(JAAS_BOTTOM)$(DRAFT_BOTTOM)) ; \
714 $(call OptionTrip,-linkoffline,$(JAAS2COREAPI),$(COREAPI_DOCSDIR)/); \
715 ) >> $@
717 # Create a file with the package names in it
718 $(JAAS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JAAS_PKGS))
719 $(prep-target)
720 $(call PackageFilter,$(JAAS_PKGS))
722 #############################################################
723 #
724 # jgssdocs
725 #
727 ALL_OTHER_TARGETS += jgssdocs
729 JGSS_DOCDIR := $(JRE_API_DOCSDIR)/security/jgss/spec
730 JGSS2COREAPI := ../../../$(JDKJRE2COREAPI)
731 JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities
732 JGSS_WINDOWTITLE := Java GSS-API Utilities
733 JGSS_HEADER := <strong>Java GSS-API Utilities</strong>
734 JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR))
735 JGSS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/jgss/jgss-overview.html
736 # JGSS_PKGS is located in NON_CORE_PKGS.gmk
738 # The index.html, options, and packages files
739 JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html
740 JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options
741 JGSS_PACKAGES_FILE = $(DOCSTMPDIR)/jgss.packages
743 jgssdocs: $(JGSS_INDEX_FILE)
745 # Set relative location to core api document root
746 $(JGSS_INDEX_FILE): GET2DOCSDIR=$(JGSS2COREAPI)/..
748 # Run javadoc if the index file is out of date or missing
749 $(JGSS_INDEX_FILE): $(JGSS_OPTIONS_FILE) $(JGSS_PACKAGES_FILE) coredocs
750 $(prep-javadoc)
751 $(call JavadocSummary,$(JGSS_OPTIONS_FILE),$(JGSS_PACKAGES_FILE))
752 $(JAVADOC_CMD) -d $(@D) \
753 @$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE)
755 # Create file with javadoc options in it
756 $(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW)
757 $(prep-target)
758 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
759 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
760 $(call OptionPair,-encoding,ascii) ; \
761 $(call OptionOnly,-nodeprecatedlist) ; \
762 $(call OptionPair,-overview,$(JGSS_OVERVIEW)) ; \
763 $(call OptionPair,-doctitle,$(JGSS_DOCTITLE)) ; \
764 $(call OptionPair,-windowtitle,$(JGSS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
765 $(call OptionPair,-header,$(JGSS_HEADER)$(DRAFT_HEADER)) ; \
766 $(call OptionPair,-bottom,$(JGSS_BOTTOM)$(DRAFT_BOTTOM)) ; \
767 $(call OptionTrip,-linkoffline,$(JGSS2COREAPI),$(COREAPI_DOCSDIR)/); \
768 ) >> $@
770 # Create a file with the package names in it
771 $(JGSS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JGSS_PKGS))
772 $(prep-target)
773 $(call PackageFilter,$(JGSS_PKGS))
775 #############################################################
776 #
777 # smartcardiodocs
778 #
780 ALL_OTHER_TARGETS += smartcardiodocs
782 SMARTCARDIO_DOCDIR := $(JRE_API_DOCSDIR)/security/smartcardio/spec
783 SMARTCARDIO2COREAPI := ../../../$(JDKJRE2COREAPI)
784 SMARTCARDIO_DOCTITLE := Java$(TRADEMARK) Smart Card I/O
785 SMARTCARDIO_WINDOWTITLE := Java Smart Card I/O
786 SMARTCARDIO_HEADER := <strong>Java Smart Card I/O</strong>
787 SMARTCARDIO_BOTTOM := $(call CommonBottom,$(SMARTCARDIO_FIRST_COPYRIGHT_YEAR))
788 # SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk
790 # The index.html, options, and packages files
791 SMARTCARDIO_INDEX_FILE = $(SMARTCARDIO_DOCDIR)/index.html
792 SMARTCARDIO_OPTIONS_FILE = $(DOCSTMPDIR)/smartcardio.options
793 SMARTCARDIO_PACKAGES_FILE = $(DOCSTMPDIR)/smartcardio.packages
795 smartcardiodocs: $(SMARTCARDIO_INDEX_FILE)
797 # Set relative location to core api document root
798 $(SMARTCARDIO_INDEX_FILE): GET2DOCSDIR=$(SMARTCARDIO2COREAPI)/..
800 # Run javadoc if the index file is out of date or missing
801 $(SMARTCARDIO_INDEX_FILE): $(SMARTCARDIO_OPTIONS_FILE) $(SMARTCARDIO_PACKAGES_FILE) coredocs
802 $(prep-javadoc)
803 $(call JavadocSummary,$(SMARTCARDIO_OPTIONS_FILE),$(SMARTCARDIO_PACKAGES_FILE))
804 $(JAVADOC_CMD) -d $(@D) \
805 @$(SMARTCARDIO_OPTIONS_FILE) @$(SMARTCARDIO_PACKAGES_FILE)
807 # Create file with javadoc options in it
808 $(SMARTCARDIO_OPTIONS_FILE):
809 $(prep-target)
810 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
811 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
812 $(call OptionPair,-encoding,ascii) ; \
813 $(call OptionOnly,-nodeprecatedlist) ; \
814 $(call OptionPair,-doctitle,$(SMARTCARDIO_DOCTITLE)) ; \
815 $(call OptionPair,-windowtitle,$(SMARTCARDIO_WINDOWTITLE) $(DRAFT_WINTITLE));\
816 $(call OptionPair,-header,$(SMARTCARDIO_HEADER)$(DRAFT_HEADER)); \
817 $(call OptionPair,-bottom,$(SMARTCARDIO_BOTTOM)$(DRAFT_BOTTOM)); \
818 $(call OptionTrip,-linkoffline,$(SMARTCARDIO2COREAPI),$(COREAPI_DOCSDIR)/); \
819 ) >> $@
821 # Create a file with the package names in it
822 $(SMARTCARDIO_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SMARTCARDIO_PKGS))
823 $(prep-target)
824 $(call PackageFilter,$(SMARTCARDIO_PKGS))
826 #############################################################
827 #
828 # httpserverdocs
829 #
831 ALL_OTHER_TARGETS += httpserverdocs
833 HTTPSERVER_DOCDIR := $(JRE_API_DOCSDIR)/net/httpserver/spec
834 HTTPSERVER2COREAPI := ../../../$(JDKJRE2COREAPI)
835 HTTPSERVER_DOCTITLE := Java$(TRADEMARK) HTTP Server
836 HTTPSERVER_WINDOWTITLE := Java HTTP Server
837 HTTPSERVER_HEADER := <strong>Java HTTP Server</strong>
838 HTTPSERVER_BOTTOM := $(call CommonBottom,$(HTTPSERVER_FIRST_COPYRIGHT_YEAR))
839 # HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk
841 HTTPSERVER_INDEX_HTML = $(HTTPSERVER_DOCDIR)/index.html
842 HTTPSERVER_OPTIONS_FILE = $(DOCSTMPDIR)/httpserver.options
843 HTTPSERVER_PACKAGES_FILE = $(DOCSTMPDIR)/httpserver.packages
845 httpserverdocs: $(HTTPSERVER_INDEX_HTML)
847 # Set relative location to core api document root
848 $(HTTPSERVER_INDEX_HTML): GET2DOCSDIR=$(HTTPSERVER2COREAPI)/..
850 # Run javadoc if the index file is out of date or missing
851 $(HTTPSERVER_INDEX_HTML): $(HTTPSERVER_OPTIONS_FILE) $(HTTPSERVER_PACKAGES_FILE) coredocs
852 $(prep-javadoc)
853 $(call JavadocSummary,$(HTTPSERVER_OPTIONS_FILE),$(HTTPSERVER_PACKAGES_FILE))
854 $(JAVADOC_CMD) -d $(@D) \
855 @$(HTTPSERVER_OPTIONS_FILE) @$(HTTPSERVER_PACKAGES_FILE)
857 # Create file with javadoc options in it
858 $(HTTPSERVER_OPTIONS_FILE):
859 $(prep-target)
860 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
861 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
862 $(call OptionPair,-encoding,ascii) ; \
863 $(call OptionOnly,-nodeprecatedlist) ; \
864 $(call OptionPair,-doctitle,$(HTTPSERVER_DOCTITLE)) ; \
865 $(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE));\
866 $(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \
867 $(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \
868 $(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \
869 ) >> $@
871 # Create a file with the package names in it
872 $(HTTPSERVER_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(HTTPSERVER_PKGS))
873 $(prep-target)
874 $(call PackageFilter,$(HTTPSERVER_PKGS))
876 #############################################################
877 #
878 # mgmtdocs
879 #
881 ALL_OTHER_TARGETS += mgmtdocs
883 MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension
884 MGMT2COREAPI := ../../$(JDKJRE2COREAPI)
885 JVM_MIB_NAME := JVM-MANAGEMENT-MIB.mib
886 JVM_MIB_SRC := $(JDK_TOPDIR)/src/closed/share/classes/sun/management/snmp/$(JVM_MIB_NAME)
887 MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform
888 MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform
889 MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong>
890 MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR))
891 MGMT_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/management/mgmt-overview.html
892 # MGMT_PKGS is located in NON_CORE_PKGS.gmk
894 # The index.html, options, and packages files
895 MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html
896 MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options
897 MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages
899 mgmtdocs: $(MGMT_INDEX_FILE)
901 # Set relative location to core api document root
902 $(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/..
904 # Run javadoc if the index file is out of date or missing
905 $(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) coredocs
906 $(prep-javadoc)
907 @if [ -f $(JVM_MIB_SRC) ] ; then \
908 $(ECHO) "$(CP) $(JVM_MIB_SRC) $(@D)/.."; \
909 $(CP) $(JVM_MIB_SRC) $(@D)/.. ; \
910 else \
911 $(ECHO) "WARNING: File $(JVM_MIB_NAME) not available."; \
912 fi
913 $(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE))
914 $(JAVADOC_CMD) -d $(@D) \
915 @$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE)
917 # Create file with javadoc options in it
918 $(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW)
919 $(prep-target)
920 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
921 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
922 $(call OptionPair,-encoding,ascii) ; \
923 $(call OptionOnly,-nodeprecatedlist) ; \
924 $(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \
925 $(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \
926 $(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \
927 $(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \
928 $(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \
929 $(call OptionTrip,-linkoffline,$(MGMT2COREAPI),$(COREAPI_DOCSDIR)/); \
930 ) >> $@
932 # Create a file with the package names in it
933 $(MGMT_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(MGMT_PKGS))
934 $(prep-target)
935 $(call PackageFilter,$(MGMT_PKGS))
937 #############################################################
938 #
939 # attachdocs
940 #
942 ALL_OTHER_TARGETS += attachdocs
944 ATTACH_DOCDIR := $(JDK_API_DOCSDIR)/attach/spec
945 ATTACH2COREAPI := ../../$(JDKJRE2COREAPI)
946 ATTACH_DOCTITLE := Attach API
947 ATTACH_WINDOWTITLE := Attach API
948 ATTACH_HEADER := <strong>Attach API</strong>
949 ATTACH_BOTTOM := $(call CommonBottom,$(ATTACH_FIRST_COPYRIGHT_YEAR))
950 # ATTACH_PKGS is located in NON_CORE_PKGS.gmk
952 ATTACH_INDEX_HTML = $(ATTACH_DOCDIR)/index.html
953 ATTACH_OPTIONS_FILE = $(DOCSTMPDIR)/attach.options
954 ATTACH_PACKAGES_FILE = $(DOCSTMPDIR)/attach.packages
956 attachdocs: $(ATTACH_INDEX_HTML)
958 # Set relative location to core api document root
959 $(ATTACH_INDEX_HTML): GET2DOCSDIR=$(ATTACH2COREAPI)/..
961 # Run javadoc if the index file is out of date or missing
962 $(ATTACH_INDEX_HTML): $(ATTACH_OPTIONS_FILE) $(ATTACH_PACKAGES_FILE) coredocs
963 $(prep-javadoc)
964 $(call JavadocSummary,$(ATTACH_OPTIONS_FILE),$(ATTACH_PACKAGES_FILE))
965 $(JAVADOC_CMD) -d $(@D) \
966 @$(ATTACH_OPTIONS_FILE) @$(ATTACH_PACKAGES_FILE)
968 # Create file with javadoc options in it
969 $(ATTACH_OPTIONS_FILE):
970 $(prep-target)
971 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
972 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
973 $(call OptionPair,-encoding,ascii) ; \
974 $(call OptionOnly,-nodeprecatedlist) ; \
975 $(call OptionPair,-doctitle,$(ATTACH_DOCTITLE)) ; \
976 $(call OptionPair,-windowtitle,$(ATTACH_WINDOWTITLE) $(DRAFT_WINTITLE));\
977 $(call OptionPair,-header,$(ATTACH_HEADER)$(DRAFT_HEADER)) ; \
978 $(call OptionPair,-bottom,$(ATTACH_BOTTOM)$(DRAFT_BOTTOM)) ; \
979 $(call OptionTrip,-linkoffline,$(ATTACH2COREAPI),$(COREAPI_DOCSDIR)/); \
980 ) >> $@
982 # Create a file with the package names in it
983 $(ATTACH_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(ATTACH_PKGS))
984 $(prep-target)
985 $(call PackageFilter,$(ATTACH_PKGS))
987 #############################################################
988 #
989 # jconsoledocs
990 #
992 ALL_OTHER_TARGETS += jconsoledocs
994 JCONSOLE_DOCDIR := $(JDK_API_DOCSDIR)/jconsole/spec
995 JCONSOLE2COREAPI := ../../$(JDKJRE2COREAPI)
996 JCONSOLE_DOCTITLE := JConsole API
997 JCONSOLE_WINDOWTITLE := JConsole API
998 JCONSOLE_HEADER := <strong>JConsole API</strong>
999 JCONSOLE_BOTTOM := $(call CommonBottom,$(JCONSOLE_FIRST_COPYRIGHT_YEAR))
1000 # JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk
1002 JCONSOLE_INDEX_HTML = $(JCONSOLE_DOCDIR)/index.html
1003 JCONSOLE_OPTIONS_FILE = $(DOCSTMPDIR)/jconsole.options
1004 JCONSOLE_PACKAGES_FILE = $(DOCSTMPDIR)/jconsole.packages
1006 jconsoledocs: $(JCONSOLE_INDEX_HTML)
1008 # Set relative location to core api document root
1009 $(JCONSOLE_INDEX_HTML): GET2DOCSDIR=$(JCONSOLE2COREAPI)/..
1011 # Run javadoc if the index file is out of date or missing
1012 $(JCONSOLE_INDEX_HTML): $(JCONSOLE_OPTIONS_FILE) $(JCONSOLE_PACKAGES_FILE) coredocs
1013 $(prep-javadoc)
1014 $(call JavadocSummary,$(JCONSOLE_OPTIONS_FILE),$(JCONSOLE_PACKAGES_FILE))
1015 $(JAVADOC_CMD) -d $(@D) \
1016 @$(JCONSOLE_OPTIONS_FILE) @$(JCONSOLE_PACKAGES_FILE)
1018 # Create file with javadoc options in it
1019 $(JCONSOLE_OPTIONS_FILE):
1020 $(prep-target)
1021 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1022 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1023 $(call OptionPair,-encoding,ascii) ; \
1024 $(call OptionOnly,-nodeprecatedlist) ; \
1025 $(call OptionPair,-doctitle,$(JCONSOLE_DOCTITLE)) ; \
1026 $(call OptionPair,-windowtitle,$(JCONSOLE_WINDOWTITLE) $(DRAFT_WINTITLE));\
1027 $(call OptionPair,-header,$(JCONSOLE_HEADER)$(DRAFT_HEADER)) ; \
1028 $(call OptionPair,-bottom,$(JCONSOLE_BOTTOM)$(DRAFT_BOTTOM)) ; \
1029 $(call OptionTrip,-linkoffline,$(JCONSOLE2COREAPI),$(COREAPI_DOCSDIR)/); \
1030 ) >> $@
1032 # Create a file with the package names in it
1033 $(JCONSOLE_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JCONSOLE_PKGS))
1034 $(prep-target)
1035 $(call PackageFilter,$(JCONSOLE_PKGS))
1037 #############################################################
1038 #
1039 # treeapidocs
1040 #
1042 ALL_OTHER_TARGETS += treeapidocs
1044 TREEAPI_DOCDIR := $(JDK_API_DOCSDIR)/javac/tree
1045 TREEAPI2COREAPI := ../../$(JDKJRE2COREAPI)
1046 TREEAPI_DOCTITLE := Compiler Tree API
1047 TREEAPI_WINDOWTITLE := Compiler Tree API
1048 TREEAPI_HEADER := <strong>Compiler Tree API</strong>
1049 TREEAPI_BOTTOM := $(call CommonBottom,$(TREEAPI_FIRST_COPYRIGHT_YEAR))
1050 TREEAPI_GROUPNAME := Packages
1051 TREEAPI_REGEXP := com.sun.source.*
1052 # TREEAPI_PKGS is located in NON_CORE_PKGS.gmk
1054 TREEAPI_INDEX_HTML = $(TREEAPI_DOCDIR)/index.html
1055 TREEAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options
1056 TREEAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages
1058 treeapidocs: $(TREEAPI_INDEX_HTML)
1060 # Set relative location to core api document root
1061 $(TREEAPI_INDEX_HTML): GET2DOCSDIR=$(TREEAPI2COREAPI)/..
1063 # Run javadoc if the index file is out of date or missing
1064 $(TREEAPI_INDEX_HTML): $(TREEAPI_OPTIONS_FILE) $(TREEAPI_PACKAGES_FILE) coredocs
1065 $(prep-javadoc)
1066 $(call JavadocSummary,$(TREEAPI_OPTIONS_FILE),$(TREEAPI_PACKAGES_FILE))
1067 $(JAVADOC_CMD) -d $(@D) \
1068 @$(TREEAPI_OPTIONS_FILE) @$(TREEAPI_PACKAGES_FILE)
1070 # Create file with javadoc options in it
1071 $(TREEAPI_OPTIONS_FILE):
1072 $(prep-target)
1073 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1074 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1075 $(call OptionPair,-encoding,ascii) ; \
1076 $(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \
1077 $(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\
1078 $(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \
1079 $(call OptionPair,-tag,$(TAG_JLS)) ; \
1080 $(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1081 $(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \
1082 $(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1083 ) >> $@
1085 # Create a file with the package names in it
1086 $(TREEAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TREEAPI_PKGS))
1087 $(prep-target)
1088 $(call PackageFilter,$(TREEAPI_PKGS))
1090 #############################################################
1091 #
1092 # sctpdocs
1093 #
1095 ALL_OTHER_TARGETS += sctpdocs
1097 SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec
1098 SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
1099 SCTPAPI_DOCTITLE := SCTP API
1100 SCTPAPI_WINDOWTITLE := SCTP API
1101 SCTPAPI_HEADER := <strong>SCTP API</strong>
1102 SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR))
1103 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk
1105 SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html
1106 SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options
1107 SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages
1109 sctpdocs: $(SCTPAPI_INDEX_HTML)
1111 # Set relative location to core api document root
1112 $(SCTPAPI_INDEX_HTML): GET2DOCSDIR=$(SCTPAPI2COREAPI)/..
1114 # Run javadoc if the index file is out of date or missing
1115 $(SCTPAPI_INDEX_HTML): $(SCTPAPI_OPTIONS_FILE) $(SCTPAPI_PACKAGES_FILE) coredocs
1116 $(prep-javadoc)
1117 $(call JavadocSummary,$(SCTPAPI_OPTIONS_FILE),$(SCTPAPI_PACKAGES_FILE))
1118 $(JAVADOC_CMD) -d $(@D) \
1119 @$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE)
1121 # Create file with javadoc options in it
1122 $(SCTPAPI_OPTIONS_FILE):
1123 $(prep-target)
1124 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1125 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1126 $(call OptionPair,-encoding,ascii) ; \
1127 $(call OptionOnly,-nodeprecatedlist) ; \
1128 $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \
1129 $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE));\
1130 $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \
1131 $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1132 $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1133 ) >> $@
1135 # Create a file with the package names in it
1136 $(SCTPAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SCTPAPI_PKGS))
1137 $(prep-target)
1138 $(call PackageFilter,$(SCTPAPI_PKGS))
1140 #############################################################
1141 #
1142 # Get a cache of all the directories
1144 $(DIRECTORY_CACHE): $(ALL_EXISTING_SOURCE_DIRS)
1145 $(prep-target)
1146 @for cp in $(ALL_EXISTING_SOURCE_DIRS) ; do \
1147 $(ECHO) "$(FIND) $${cp} -type f >> $@"; \
1148 $(FIND) $${cp} -type f >> $@; \
1149 done
1151 #############################################################
1152 #release version of core packages ########
1153 # Maximize performance and ensure that build number & milestone are set.
1155 rel-coredocs: sanitycheckcoredocs
1156 $(MAKE) coredocs
1158 rel-docs: rel-coredocs $(ALL_OTHER_TARGETS)
1159 #
1160 # end of production targets
1162 otherdocs: $(ALL_OTHER_TARGETS)
1164 clean:
1165 $(RM) -r $(DOCSDIR) $(DOCSTMPDIR)
1167 #############################################################
1168 # DEBUG TARGET
1169 # List the values defined in the makefile hierarchy, to make sure everything
1170 # is set properly, and to help identify values we can use instead of making new ones.
1171 # (Most of them come from common/shared/Defs.gmk)
1172 #
1173 # Notes:
1174 # * BUILD_NUMBER defaults to b00 if not set on command line with BUILD_NUMBER=<value>
1175 # * MILESTONE defaults to internal unless set to beta, rc, or fcs on command line
1176 #
1178 #############################################################
1179 .PHONY: all docs coredocs rel-docs otherdocs rel-coredocs \
1180 sanitycheckcoredocs $(ALL_OTHER_TARGETS)
