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