Mercurial > jdk8-mips64-public / file revision
make/Javadoc.gmk@196ee1e3add0
make/Javadoc.gmk
Fri, 31 Oct 2014 09:52:05 -0400
- author
- rriggs
- date
- Fri, 31 Oct 2014 09:52:05 -0400
- changeset 1196
- 196ee1e3add0
- parent 1039
- 389603b4000d
- child 1207
- 2eff25723f83
- permissions
- -rw-r--r--
8062475: Enable hook for custom doc generation
Reviewed-by: erikj
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
75 JDKNET_FIRST_COPYRIGHT_YEAR = 2014
77 # Oracle name
78 FULL_COMPANY_NAME = Oracle and/or its affiliates
80 # Copyright address
81 COMPANY_ADDRESS = 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA.
83 # The trademark symbol
84 TRADEMARK = ™
86 # Common copyright lines used
87 # The word "Copyright" might optionally be a link to the file cpyr.html.
88 # The first year of copyright may vary or not be available.
89 # The address to the company might be optional.
90 COMMA:= ,
91 EMPTY:=
92 SPACE:=$(EMPTY) $(EMPTY)
93 COPYRIGHT_SYMBOL = &\#x00a9;
94 # Macro to construct the copyright line
95 # (The GNU make 3.78.1 "if" conditional is broken, fixed in GNU make 3.81)
96 define CopyrightLine # optionalurl optionalfirstyear optionaladdress
97 $(if $(strip $1),<a href="$(strip $1)">Copyright</a>,Copyright) \
98 $(COPYRIGHT_SYMBOL) $(if $2,$2${COMMA},) $(COPYRIGHT_YEAR),\
99 $(FULL_COMPANY_NAME). $3 All rights reserved.
100 endef
102 # Url to root of documents
103 DOCSDIR_URL = {@docroot}/$(GET2DOCSDIR)
105 # Url to copyright html file
106 COPYRIGHT_URL = $(DOCSDIR_URL)/legal/cpyr.html
108 # Url to bug filing site
109 BUG_SUBMIT_URL = http://bugreport.sun.com/bugreport/
111 # Common line for how to submit a bug or rfe
112 BUG_SUBMIT_LINE = <a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a>
114 # Url to devdocs page
115 # Was: http://java.sun.com/javase/6/webnotes/devdocs-vs-specs.html
116 DEV_DOCS_URL-7 = http://download.oracle.com/javase/7/docs/index.html
117 DEV_DOCS_URL-8 = http://download.oracle.com/javase/8/docs/index.html
118 DEV_DOCS_URL = $(DEV_DOCS_URL-$(JDK_MINOR_VERSION))
119 DOCS_BASE_URL = http://download.oracle.com/javase/7/docs
121 # Common Java trademark line
122 JAVA_TRADEMARK_LINE = Java is a trademark or registered trademark of \
123 $(FULL_COMPANY_NAME) in the US and other countries.
125 #################################################################
126 # Macros:
129 # List of all possible directories for javadoc to look for sources
130 # NOTE: Quotes are required around sourcepath argument only on Windows.
131 # Otherwise, you get "No packages or classes specified." due
132 # to $(PATH_SEP) being interpreted as an end of
133 # command (newline or shell ; character)
134 ALL_SOURCE_DIRS = $(JDK_SHARE_CLASSES) \
135 $(JDK_IMPSRC) \
136 $(JDK_GENSRC) \
137 $(JDK_OUTPUTDIR)/gendocsrc_rmic \
138 $(JDK_TOPDIR)/src/solaris/classes \
139 $(JDK_TOPDIR)/src/windows/classes \
140 $(JDK_SHARE_SRC)/doc/stub
142 # List of directories that actually exist
143 ALL_EXISTING_SOURCE_DIRS := $(wildcard $(ALL_SOURCE_DIRS))
145 # List with classpath separator between them
146 EMPTY:=
147 SPACE:= $(EMPTY) $(EMPTY)
148 RELEASEDOCS_SOURCEPATH = \
149 $(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_SOURCE_DIRS)))
151 define prep-target
152 $(MKDIR) -p $(@D)
153 $(RM) $@
154 endef
156 # Prep for javadoc creation, assumes $@ is an index.html file
157 define prep-javadoc
158 @if [ -f "$@" -a "$?" != "" ] ; then \
159 $(ECHO) "# Dependencies have changed: $?"; \
160 fi
161 $(RM) -r $(@D)
162 $(MKDIR) -p $(@D)
163 endef
165 # A cache of the directories in ALL_SOURCE_DIRS
166 DIRECTORY_CACHE = $(DOCSTMPDIR)/directory.cache
168 # Given a list of packages, return a list of files or dirs to be dependent on
169 # (Currently only returning a list of directories)
170 define PackageDependencies # packages
171 $(shell \
172 if [ "$1" != "" -a -f $(DIRECTORY_CACHE) ] ; then \
173 for p in $1 ; do \
174 pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \
175 $(CAT) $(DIRECTORY_CACHE) | $(GREP) "/$${pd}/" ; \
176 done; \
177 fi \
178 )
179 endef
181 # Given a list of packages, add packages that exist to $@, print summary
182 define PackageFilter # packages
183 @if [ "$1" != "" ] ; then \
184 for p in $1 ; do \
185 pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \
186 found="false"; \
187 for cp in $(ALL_SOURCE_DIRS) ; do \
188 if [ -d $${cp}/$${pd} ] ; then \
189 $(ECHO) "$${p}" >> $@; \
190 found="true"; \
191 break; \
192 fi; \
193 done; \
194 if [ "$${found}" = "false" ] ; then \
195 $(ECHO) "WARNING: Package not found: $${p}"; \
196 fi; \
197 done; \
198 fi
199 endef
201 # Print out a summary of the javadoc command about to be run
202 define JavadocSummary # optionsfile packagesfile
203 @$(ECHO) "# Summary for $@"; \
204 $(ECHO) "# Options (`$(BASENAME) $1`):"; $(SED) -e 's@^@# @' $1; \
205 $(ECHO) "# Packages (`$(BASENAME) $2`):";$(SED) -e 's@^@# @' $2
206 endef
208 #
209 # Temporary directory for javadoc creation
210 #
211 DOCSTMPDIR = $(TEMPDIR)/doctmp
213 #
214 # Different api directories created from root directory
215 #
216 COREAPI_DOCSDIR = $(DOCSDIR)/api
217 JDK_API_DOCSDIR = $(DOCSDIR)/jdk/api
218 JRE_API_DOCSDIR = $(DOCSDIR)/jre/api
219 PLATFORM_DOCSDIR = $(DOCSDIR)/platform
221 # The non-core api javadocs need to be able to access the root of the core
222 # api directory, so for jdk/api or jre/api to get to the core api/
223 # directory we would use this:
224 JDKJRE2COREAPI = ../../api
226 # Common bottom argument
227 define CommonBottom # year
228 <font size="-1"><br> $(call CopyrightLine,,$1,)</font>
229 endef
231 # Common trademark bottom argument (Not sure why this is used sometimes)
232 define CommonTrademarkBottom # year
233 <font size="-1">\
234 $(BUG_SUBMIT_LINE)<br>$(JAVA_TRADEMARK_LINE)<br>\
235 $(call CopyrightLine,,$1,$(COMPANY_ADDRESS))\
236 </font>
237 endef
239 # Common echo of option
240 define OptionOnly # opt
241 $(PRINTF) "%s\n" "$1"
242 endef
243 define OptionPair # opt arg
244 $(PRINTF) "%s '%s'\n" "$1" '$2'
245 endef
246 define OptionTrip # opt arg arg
247 $(PRINTF) "%s '%s' '%s'\n" "$1" '$2' '$3'
248 endef
250 # Core api bottom argument (with special sauce)
251 COREAPI_BOTTOM = <font size="-1"> $(BUG_SUBMIT_LINE)\
252 <br>For further API reference and developer documentation, \
253 see <a href="$(DEV_DOCS_URL)" target="_blank">Java SE Documentation</a>. \
254 That documentation contains more detailed, developer-targeted descriptions, \
255 with conceptual overviews, definitions of terms, workarounds, \
256 and working code examples.<br>\
257 $(call CopyrightLine,$(COPYRIGHT_URL),$(FIRST_COPYRIGHT_YEAR),)\
258 </font>
260 # Common javadoc options used by all
261 COMMON_JAVADOCFLAGS = \
262 -XDignore.symbol.file=true \
263 -quiet \
264 -use \
265 -keywords \
266 -Xdoclint:none \
267 -Xprofilespath $(JDK_TOPDIR)/make/profile-rtjar-includes.txt \
268 $(ADDITIONAL_JAVADOCFLAGS)
270 ifdef OPENJDK
271 ADDITIONAL_JAVADOCFLAGS = \
272 -Xdocrootparent $(DOCS_BASE_URL)
273 else
274 ADDITIONAL_JAVADOCFLAGS =
275 endif
277 # Draft used for non-fcs documents
278 DRAFT_HEADER =
279 ifneq ($(MILESTONE), fcs)
280 DRAFT_HEADER = <br><strong>DRAFT $(MILESTONE)-$(BUILD_NUMBER)</strong>
281 DRAFT_BOTTOM = <br><strong>DRAFT $(MILESTONE)-$(BUILD_NUMBER)</strong>
282 DRAFT_WINTITLE = $(BUILD_NUMBER)
283 # Early access top text (not used in FCS releases)
284 COREAPI_TOP_EARLYACCESS = \
285 <div style="background-color: \#EEEEEE"> \
286 <div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; \
287 margin-left: 6px; margin-right: 6px; text-align: justify; \
288 font-size: 80%; font-family: Helvetica, Arial, sans-serif; \
289 font-weight: normal;"> \
290 Please note that the specifications and other information \
291 contained herein are not final and are subject to change. \
292 The information is being made available to you solely for purpose of \
293 evaluation. \
294 </div> </div>
296 endif
298 #################################################################
300 #
301 # CORE_PKGS environment variable has been moved to the following file
302 #
303 include CORE_PKGS.gmk
305 #
306 # Load environment variables for API package names that are not part of
307 # the Java SE platform
308 #
309 include NON_CORE_PKGS.gmk
311 #################################################################
313 #
314 # Load custom Javadoc rules, if present
315 #
316 -include $(CUSTOM_MAKE_DIR)/Javadoc.gmk
318 #################################################################
320 #
321 # Default target is same as docs target, create core api and all others it can
322 #
324 all: docs
325 docs: coredocs otherdocs
327 #################################################################
328 # Production Targets -- USE THESE TARGETS WHEN:
329 # a) You're generating docs outside of release engineering's
330 # standard control build.
331 # b) The docs will be pushed to the web and/or included in
332 # the downloaded doc bundle.
333 #
334 # See: Notes.html#releaseTargets
335 # Note: Spaces precede ifdef/ifndef indents. Tabs precede target commands (!)
336 #
338 sanitycheckcoredocs:
339 @$(ECHO) ""
340 @$(ECHO) "Building core api docs with these values:"
341 @$(ECHO) " BUILD_NUMBER = $(BUILD_NUMBER)"
342 @$(ECHO) " MILESTONE = $(MILESTONE)"
343 @$(ECHO) ""
344 ifeq ($(BUILD_NUMBER), b00)
345 @$(ECHO) "ERROR: Build number must be defined"
346 @$(ECHO) "MILESTONE is set to $(MILESTONE)"
347 @$(ECHO) ""
348 exit 1
349 endif
351 #############################################################
352 #
353 # coredocs
354 #
355 COREAPI_DOCTITLE = Java$(TRADEMARK) Platform, Standard Edition \
356 $(JDK_MINOR_VERSION)<br>API Specification
357 COREAPI_WINDOWTITLE = Java Platform SE $(JDK_MINOR_VERSION)
358 COREAPI_HEADER = \
359 <strong>Java$(TRADEMARK) Platform<br>Standard Ed. $(JDK_MINOR_VERSION)</strong>
361 # Java language specification cite
362 TAG_JLS = jls:a:See <cite> \
363 The Java™ Language Specification</cite>:
365 # Overview file for core apis
366 COREAPI_OVERVIEW = $(JDK_SHARE_CLASSES)/overview-core.html
368 # The index.html, options, and packages files
369 COREAPI_INDEX_FILE = $(COREAPI_DOCSDIR)/index.html
370 COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options
371 COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages
373 coredocs: $(COREAPI_INDEX_FILE)
375 # Set relative location to core api document root
376 $(COREAPI_INDEX_FILE): GET2DOCSDIR=..
378 # Run javadoc if the index file is out of date or missing
379 $(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE)
380 $(prep-javadoc)
381 $(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE))
382 $(JAVADOC_CMD) -d $(@D) \
383 @$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE)
385 # Create file with javadoc options in it
386 $(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW)
387 $(prep-target)
388 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
389 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
390 $(call OptionPair,-encoding,ISO-8859-1) ; \
391 $(call OptionPair,-tag,beaninfo:X) ; \
392 $(call OptionPair,-tag,revised:X) ; \
393 $(call OptionPair,-tag,since.unbundled:X) ; \
394 $(call OptionPair,-tag,spec:X) ; \
395 $(call OptionPair,-tag,specdefault:X) ; \
396 $(call OptionPair,-tag,Note:X) ; \
397 $(call OptionPair,-tag,ToDo:X) ; \
398 $(call OptionPair,-tag,apiNote:a:API Note:) ; \
399 $(call OptionPair,-tag,implSpec:a:Implementation Requirements:) ; \
400 $(call OptionPair,-tag,implNote:a:Implementation Note:) ; \
401 $(call OptionPair,-tag,param) ; \
402 $(call OptionPair,-tag,return) ; \
403 $(call OptionPair,-tag,throws) ; \
404 $(call OptionPair,-tag,since) ; \
405 $(call OptionPair,-tag,version) ; \
406 $(call OptionPair,-tag,serialData) ; \
407 $(call OptionPair,-tag,factory) ; \
408 $(call OptionPair,-tag,see) ; \
409 $(call OptionPair,-tag,$(TAG_JLS)) ; \
410 $(call OptionOnly,-splitIndex) ; \
411 $(call OptionPair,-overview,$(COREAPI_OVERVIEW)) ; \
412 $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE)) ; \
413 $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ; \
414 $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER)) ; \
415 $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
416 ) >> $@
417 ifdef COREAPI_TOP_EARLYACCESS
418 @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@
419 endif
421 # Create a file with the package names in it
422 $(COREAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(CORE_PKGS))
423 $(prep-target)
424 $(call PackageFilter,$(CORE_PKGS))
426 #############################################################
427 #
428 # docletapidocs
429 #
431 ALL_OTHER_TARGETS += docletapidocs
433 DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet
434 DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
435 DOCLETAPI_DOCTITLE := Doclet API
436 DOCLETAPI_WINDOWTITLE := Doclet API
437 DOCLETAPI_HEADER := <strong>Doclet API</strong>
438 DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
439 DOCLETAPI_GROUPNAME := Packages
440 DOCLETAPI_REGEXP := com.sun.javadoc
441 # DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
443 # The index.html, options, and packages files
444 DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html
445 DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options
446 DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages
448 docletapidocs: $(DOCLETAPI_INDEX_FILE)
450 # Set relative location to core api document root
451 $(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/..
453 # Run javadoc if the index file is out of date or missing
454 $(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) coredocs
455 $(prep-javadoc)
456 $(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE))
457 $(JAVADOC_CMD) -d $(@D) \
458 @$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE)
460 # Create file with javadoc options in it
461 $(DOCLETAPI_OPTIONS_FILE):
462 $(prep-target)
463 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
464 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
465 $(call OptionPair,-encoding,ascii) ; \
466 $(call OptionOnly,-breakiterator) ; \
467 $(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \
468 $(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
469 $(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \
470 $(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
471 $(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \
472 $(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
473 ) >> $@
475 # Create a file with the package names in it
476 $(DOCLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOCLETAPI_PKGS))
477 $(prep-target)
478 $(call PackageFilter,$(DOCLETAPI_PKGS))
480 #############################################################
481 #
482 # tagletapidocs
483 #
485 ALL_OTHER_TARGETS += tagletapidocs
486 TAGLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/taglet
487 TAGLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
488 TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR))
489 # TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk
491 # Temporary directory (special generation rules)
492 TAGLETAPI_TEMPDIR = $(DOCSTMPDIR)/taglets_temp
494 # The index.html, options, and packages files
495 TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/index.html
496 TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options
497 TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages
499 tagletapidocs: $(TAGLETAPI_INDEX_FILE)
501 # Set relative location to core api document root
502 $(TAGLETAPI_INDEX_FILE): GET2DOCSDIR=$(TAGLETAPI2COREAPI)/..
504 # Run javadoc if the index file is out of date or missing
505 $(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) coredocs
506 $(prep-javadoc)
507 $(RM) -r $(TAGLETAPI_TEMPDIR)
508 $(MKDIR) -p $(TAGLETAPI_TEMPDIR)
509 $(call JavadocSummary,$(TAGLETAPI_OPTIONS_FILE),$(TAGLETAPI_PACKAGES_FILE))
510 $(JAVADOC_CMD) -d $(TAGLETAPI_TEMPDIR) \
511 @$(TAGLETAPI_OPTIONS_FILE) @$(TAGLETAPI_PACKAGES_FILE)
512 cp -r $(TAGLETAPI_TEMPDIR)/com $(@D)
513 cp $(TAGLETAPI_TEMPDIR)/stylesheet.css $(@D)
514 $(RM) -r $(TAGLETAPI_TEMPDIR)
516 # Create file with javadoc options in it
517 $(TAGLETAPI_OPTIONS_FILE):
518 $(prep-target)
519 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
520 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
521 $(call OptionPair,-encoding,ascii) ; \
522 $(call OptionOnly,-nonavbar) ; \
523 $(call OptionOnly,-noindex) ; \
524 $(call OptionPair,-bottom,$(TAGLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
525 $(call OptionTrip,-linkoffline,$(TAGLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
526 ) >> $@
528 # Create a file with the package names in it
529 $(TAGLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TAGLETAPI_PKGS))
530 $(prep-target)
531 @($(ECHO) "$(JDK_IMPSRC)/$(TAGLETAPI_FILE)" ) > $@
533 #############################################################
534 #
535 # domapidocs
536 #
538 ALL_OTHER_TARGETS += domapidocs
540 DOMAPI_DOCDIR := $(JRE_API_DOCSDIR)/plugin/dom
541 DOMAPI2COREAPI := ../../$(JDKJRE2COREAPI)
542 DOMAPI_DOCTITLE := Common DOM API
543 DOMAPI_WINDOWTITLE := Common DOM API
544 DOMAPI_HEADER := <strong>Common DOM API</strong>
545 DOMAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOMAPI_FIRST_COPYRIGHT_YEAR))
546 DOMAPI_GROUPNAME := Packages
547 DOMAPI_REGEXP := com.sun.java.browser.dom:org.w3c.dom*
548 # DOMAPI_PKGS is located in NON_CORE_PKGS.gmk
550 # The index.html, options, and packages files
551 DOMAPI_INDEX_FILE = $(DOMAPI_DOCDIR)/index.html
552 DOMAPI_OPTIONS_FILE = $(DOCSTMPDIR)/domapi.options
553 DOMAPI_PACKAGES_FILE = $(DOCSTMPDIR)/domapi.packages
555 domapidocs: $(DOMAPI_INDEX_FILE)
557 # Set relative location to core api document root
558 $(DOMAPI_INDEX_FILE): GET2DOCSDIR=$(DOMAPI2COREAPI)/..
560 # Run javadoc if the index file is out of date or missing
561 $(DOMAPI_INDEX_FILE): $(DOMAPI_OPTIONS_FILE) $(DOMAPI_PACKAGES_FILE) coredocs
562 $(prep-javadoc)
563 $(call JavadocSummary,$(DOMAPI_OPTIONS_FILE),$(DOMAPI_PACKAGES_FILE))
564 $(JAVADOC_CMD) -d $(@D) \
565 @$(DOMAPI_OPTIONS_FILE) @$(DOMAPI_PACKAGES_FILE)
567 # Create file with javadoc options in it
568 $(DOMAPI_OPTIONS_FILE):
569 $(prep-target)
570 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
571 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
572 $(call OptionPair,-encoding,ascii) ; \
573 $(call OptionOnly,-splitIndex) ; \
574 $(call OptionPair,-doctitle,$(DOMAPI_DOCTITLE)) ; \
575 $(call OptionPair,-windowtitle,$(DOMAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
576 $(call OptionPair,-header,$(DOMAPI_HEADER)$(DRAFT_HEADER)) ; \
577 $(call OptionPair,-bottom,$(DOMAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
578 $(call OptionTrip,-group,$(DOMAPI_GROUPNAME),$(DOMAPI_REGEXP)); \
579 $(call OptionTrip,-linkoffline,$(DOMAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
580 ) >> $@
582 # Create a file with the package names in it
583 $(DOMAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOMAPI_PKGS))
584 $(prep-target)
585 $(call PackageFilter,$(DOMAPI_PKGS))
587 #############################################################
588 #
589 # jpdadocs
590 #
592 ALL_OTHER_TARGETS += jpdadocs
594 jpdadocs: jdidocs jdwpdocs jvmtidocs
596 #############################################################
597 #
598 # jdidocs
599 #
601 ALL_OTHER_TARGETS += jdidocs
603 JDI_DOCDIR := $(JDK_API_DOCSDIR)/jpda/jdi
604 JDI2COREAPI := ../../$(JDKJRE2COREAPI)
605 JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface
606 JDI_WINDOWTITLE := Java Debug Interface
607 JDI_HEADER := <strong>Java Debug Interface</strong>
608 JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR))
609 JDI_OVERVIEW := $(JDK_SHARE_CLASSES)/jdi-overview.html
610 # JDI_PKGS is located in NON_CORE_PKGS.gmk
612 # The index.html, options, and packages files
613 JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html
614 JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options
615 JDI_PACKAGES_FILE = $(DOCSTMPDIR)/jdi.packages
617 jdidocs: $(JDI_INDEX_FILE)
619 # Set relative location to core api document root
620 $(JDI_INDEX_FILE): GET2DOCSDIR=$(JDI2COREAPI)/..
622 # Run javadoc if the index file is out of date or missing
623 $(JDI_INDEX_FILE): $(JDI_OPTIONS_FILE) $(JDI_PACKAGES_FILE) coredocs
624 $(prep-javadoc)
625 $(call JavadocSummary,$(JDI_OPTIONS_FILE),$(JDI_PACKAGES_FILE))
626 $(JAVADOC_CMD) -d $(@D) \
627 @$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE)
629 # Create file with javadoc options in it
630 $(JDI_OPTIONS_FILE): $(JDI_OVERVIEW)
631 $(prep-target)
632 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
633 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
634 $(call OptionPair,-encoding,ascii) ; \
635 $(call OptionPair,-overview,$(JDI_OVERVIEW)) ; \
636 $(call OptionPair,-doctitle,$(JDI_DOCTITLE)) ; \
637 $(call OptionPair,-windowtitle,$(JDI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
638 $(call OptionPair,-header,$(JDI_HEADER)$(DRAFT_HEADER)) ; \
639 $(call OptionPair,-bottom,$(JDI_BOTTOM)$(DRAFT_BOTTOM)) ; \
640 $(call OptionTrip,-linkoffline,$(JDI2COREAPI),$(COREAPI_DOCSDIR)/); \
641 ) >> $@
643 # Create a file with the package names in it
644 $(JDI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JDI_PKGS))
645 $(prep-target)
646 $(call PackageFilter,$(JDI_PKGS))
648 #############################################################
649 #
650 # jdwpdocs
651 #
653 ALL_OTHER_TARGETS += jdwpdocs
655 JDWP_DOCDIR = $(PLATFORM_DOCSDIR)/jpda/jdwp
657 jdwpdocs: $(JDWP_DOCDIR)/jdwp-protocol.html
658 $(JDWP_DOCDIR)/jdwp-protocol.html : $(JDK_OUTPUTDIR)/gensrc_jdwp_doc/jdwp-protocol.html
659 $(MKDIR) -p $(@D)
660 $(RM) $@
661 $(CP) $< $@
663 #############################################################
664 #
665 # jvmtidocs
666 #
668 ALL_OTHER_TARGETS += jvmtidocs
670 JVMTI_DOCDIR = $(PLATFORM_DOCSDIR)/jvmti
671 JVMTI_HTML = $(HOTSPOT_DIST)/docs/platform/jvmti/jvmti.html
673 jvmtidocs: $(JVMTI_DOCDIR)/jvmti.html
674 $(JVMTI_DOCDIR)/jvmti.html:
675 @$(prep-javadoc)
676 @if [ -f $(JVMTI_HTML) ] ; then \
677 $(ECHO) "$(CP) $(JVMTI_HTML) $@"; \
678 $(CP) $(JVMTI_HTML) $@; \
679 else \
680 $(ECHO) "WARNING: Generated file does not exist: $(JVMTI_HTML)"; \
681 fi
683 #############################################################
684 #
685 # jaasdocs
686 #
688 ALL_OTHER_TARGETS += jaasdocs
690 JAAS_DOCDIR := $(JRE_API_DOCSDIR)/security/jaas/spec
691 JAAS2COREAPI := ../../../$(JDKJRE2COREAPI)
692 JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service
693 JAAS_WINDOWTITLE := Java Authentication and Authorization Service
694 JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong>
695 JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR))
696 # JAAS_PKGS is located in NON_CORE_PKGS.gmk
697 JAAS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/auth/jaas-overview.html
699 # The index.html, options, and packages files
700 JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html
701 JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options
702 JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages
704 jaasdocs: $(JAAS_INDEX_FILE)
706 # Set relative location to core api document root
707 $(JAAS_INDEX_FILE): GET2DOCSDIR=$(JAAS2COREAPI)/..
709 # Run javadoc if the index file is out of date or missing
710 $(JAAS_INDEX_FILE): $(JAAS_OPTIONS_FILE) $(JAAS_PACKAGES_FILE) coredocs
711 $(prep-javadoc)
712 $(call JavadocSummary,$(JAAS_OPTIONS_FILE),$(JAAS_PACKAGES_FILE))
713 $(JAVADOC_CMD) -d $(@D) \
714 @$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE)
716 # Create file with javadoc options in it
717 $(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW)
718 $(prep-target)
719 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
720 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
721 $(call OptionPair,-encoding,ascii) ; \
722 $(call OptionPair,-overview,$(JAAS_OVERVIEW)) ; \
723 $(call OptionPair,-doctitle,$(JAAS_DOCTITLE)) ; \
724 $(call OptionPair,-windowtitle,$(JAAS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
725 $(call OptionPair,-header,$(JAAS_HEADER)$(DRAFT_HEADER)) ; \
726 $(call OptionPair,-bottom,$(JAAS_BOTTOM)$(DRAFT_BOTTOM)) ; \
727 $(call OptionTrip,-linkoffline,$(JAAS2COREAPI),$(COREAPI_DOCSDIR)/); \
728 ) >> $@
730 # Create a file with the package names in it
731 $(JAAS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JAAS_PKGS))
732 $(prep-target)
733 $(call PackageFilter,$(JAAS_PKGS))
735 #############################################################
736 #
737 # jgssdocs
738 #
740 ALL_OTHER_TARGETS += jgssdocs
742 JGSS_DOCDIR := $(JRE_API_DOCSDIR)/security/jgss/spec
743 JGSS2COREAPI := ../../../$(JDKJRE2COREAPI)
744 JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities
745 JGSS_WINDOWTITLE := Java GSS-API Utilities
746 JGSS_HEADER := <strong>Java GSS-API Utilities</strong>
747 JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR))
748 JGSS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/jgss/jgss-overview.html
749 # JGSS_PKGS is located in NON_CORE_PKGS.gmk
751 # The index.html, options, and packages files
752 JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html
753 JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options
754 JGSS_PACKAGES_FILE = $(DOCSTMPDIR)/jgss.packages
756 jgssdocs: $(JGSS_INDEX_FILE)
758 # Set relative location to core api document root
759 $(JGSS_INDEX_FILE): GET2DOCSDIR=$(JGSS2COREAPI)/..
761 # Run javadoc if the index file is out of date or missing
762 $(JGSS_INDEX_FILE): $(JGSS_OPTIONS_FILE) $(JGSS_PACKAGES_FILE) coredocs
763 $(prep-javadoc)
764 $(call JavadocSummary,$(JGSS_OPTIONS_FILE),$(JGSS_PACKAGES_FILE))
765 $(JAVADOC_CMD) -d $(@D) \
766 @$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE)
768 # Create file with javadoc options in it
769 $(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW)
770 $(prep-target)
771 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
772 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
773 $(call OptionPair,-encoding,ascii) ; \
774 $(call OptionOnly,-nodeprecatedlist) ; \
775 $(call OptionPair,-overview,$(JGSS_OVERVIEW)) ; \
776 $(call OptionPair,-doctitle,$(JGSS_DOCTITLE)) ; \
777 $(call OptionPair,-windowtitle,$(JGSS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
778 $(call OptionPair,-header,$(JGSS_HEADER)$(DRAFT_HEADER)) ; \
779 $(call OptionPair,-bottom,$(JGSS_BOTTOM)$(DRAFT_BOTTOM)) ; \
780 $(call OptionTrip,-linkoffline,$(JGSS2COREAPI),$(COREAPI_DOCSDIR)/); \
781 ) >> $@
783 # Create a file with the package names in it
784 $(JGSS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JGSS_PKGS))
785 $(prep-target)
786 $(call PackageFilter,$(JGSS_PKGS))
788 #############################################################
789 #
790 # smartcardiodocs
791 #
793 ALL_OTHER_TARGETS += smartcardiodocs
795 SMARTCARDIO_DOCDIR := $(JRE_API_DOCSDIR)/security/smartcardio/spec
796 SMARTCARDIO2COREAPI := ../../../$(JDKJRE2COREAPI)
797 SMARTCARDIO_DOCTITLE := Java$(TRADEMARK) Smart Card I/O
798 SMARTCARDIO_WINDOWTITLE := Java Smart Card I/O
799 SMARTCARDIO_HEADER := <strong>Java Smart Card I/O</strong>
800 SMARTCARDIO_BOTTOM := $(call CommonBottom,$(SMARTCARDIO_FIRST_COPYRIGHT_YEAR))
801 # SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk
803 # The index.html, options, and packages files
804 SMARTCARDIO_INDEX_FILE = $(SMARTCARDIO_DOCDIR)/index.html
805 SMARTCARDIO_OPTIONS_FILE = $(DOCSTMPDIR)/smartcardio.options
806 SMARTCARDIO_PACKAGES_FILE = $(DOCSTMPDIR)/smartcardio.packages
808 smartcardiodocs: $(SMARTCARDIO_INDEX_FILE)
810 # Set relative location to core api document root
811 $(SMARTCARDIO_INDEX_FILE): GET2DOCSDIR=$(SMARTCARDIO2COREAPI)/..
813 # Run javadoc if the index file is out of date or missing
814 $(SMARTCARDIO_INDEX_FILE): $(SMARTCARDIO_OPTIONS_FILE) $(SMARTCARDIO_PACKAGES_FILE) coredocs
815 $(prep-javadoc)
816 $(call JavadocSummary,$(SMARTCARDIO_OPTIONS_FILE),$(SMARTCARDIO_PACKAGES_FILE))
817 $(JAVADOC_CMD) -d $(@D) \
818 @$(SMARTCARDIO_OPTIONS_FILE) @$(SMARTCARDIO_PACKAGES_FILE)
820 # Create file with javadoc options in it
821 $(SMARTCARDIO_OPTIONS_FILE):
822 $(prep-target)
823 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
824 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
825 $(call OptionPair,-encoding,ascii) ; \
826 $(call OptionOnly,-nodeprecatedlist) ; \
827 $(call OptionPair,-doctitle,$(SMARTCARDIO_DOCTITLE)) ; \
828 $(call OptionPair,-windowtitle,$(SMARTCARDIO_WINDOWTITLE) $(DRAFT_WINTITLE)); \
829 $(call OptionPair,-header,$(SMARTCARDIO_HEADER)$(DRAFT_HEADER)); \
830 $(call OptionPair,-bottom,$(SMARTCARDIO_BOTTOM)$(DRAFT_BOTTOM)); \
831 $(call OptionTrip,-linkoffline,$(SMARTCARDIO2COREAPI),$(COREAPI_DOCSDIR)/); \
832 ) >> $@
834 # Create a file with the package names in it
835 $(SMARTCARDIO_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SMARTCARDIO_PKGS))
836 $(prep-target)
837 $(call PackageFilter,$(SMARTCARDIO_PKGS))
839 #############################################################
840 #
841 # httpserverdocs
842 #
844 ALL_OTHER_TARGETS += httpserverdocs
846 HTTPSERVER_DOCDIR := $(JRE_API_DOCSDIR)/net/httpserver/spec
847 HTTPSERVER2COREAPI := ../../../$(JDKJRE2COREAPI)
848 HTTPSERVER_DOCTITLE := Java$(TRADEMARK) HTTP Server
849 HTTPSERVER_WINDOWTITLE := Java HTTP Server
850 HTTPSERVER_HEADER := <strong>Java HTTP Server</strong>
851 HTTPSERVER_BOTTOM := $(call CommonBottom,$(HTTPSERVER_FIRST_COPYRIGHT_YEAR))
852 # HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk
854 HTTPSERVER_INDEX_HTML = $(HTTPSERVER_DOCDIR)/index.html
855 HTTPSERVER_OPTIONS_FILE = $(DOCSTMPDIR)/httpserver.options
856 HTTPSERVER_PACKAGES_FILE = $(DOCSTMPDIR)/httpserver.packages
858 httpserverdocs: $(HTTPSERVER_INDEX_HTML)
860 # Set relative location to core api document root
861 $(HTTPSERVER_INDEX_HTML): GET2DOCSDIR=$(HTTPSERVER2COREAPI)/..
863 # Run javadoc if the index file is out of date or missing
864 $(HTTPSERVER_INDEX_HTML): $(HTTPSERVER_OPTIONS_FILE) $(HTTPSERVER_PACKAGES_FILE) coredocs
865 $(prep-javadoc)
866 $(call JavadocSummary,$(HTTPSERVER_OPTIONS_FILE),$(HTTPSERVER_PACKAGES_FILE))
867 $(JAVADOC_CMD) -d $(@D) \
868 @$(HTTPSERVER_OPTIONS_FILE) @$(HTTPSERVER_PACKAGES_FILE)
870 # Create file with javadoc options in it
871 $(HTTPSERVER_OPTIONS_FILE):
872 $(prep-target)
873 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
874 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
875 $(call OptionPair,-encoding,ascii) ; \
876 $(call OptionOnly,-nodeprecatedlist) ; \
877 $(call OptionPair,-doctitle,$(HTTPSERVER_DOCTITLE)) ; \
878 $(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE)); \
879 $(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \
880 $(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \
881 $(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \
882 ) >> $@
884 # Create a file with the package names in it
885 $(HTTPSERVER_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(HTTPSERVER_PKGS))
886 $(prep-target)
887 $(call PackageFilter,$(HTTPSERVER_PKGS))
889 #############################################################
890 #
891 # mgmtdocs
892 #
894 ALL_OTHER_TARGETS += mgmtdocs
896 MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension
897 MGMT2COREAPI := ../../$(JDKJRE2COREAPI)
898 JVM_MIB_NAME := JVM-MANAGEMENT-MIB.mib
899 JVM_MIB_SRC := $(JDK_TOPDIR)/src/closed/share/classes/sun/management/snmp/$(JVM_MIB_NAME)
900 MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform
901 MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform
902 MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong>
903 MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR))
904 MGMT_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/management/mgmt-overview.html
905 # MGMT_PKGS is located in NON_CORE_PKGS.gmk
907 # The index.html, options, and packages files
908 MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html
909 MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options
910 MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages
912 mgmtdocs: $(MGMT_INDEX_FILE)
914 # Set relative location to core api document root
915 $(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/..
917 # Run javadoc if the index file is out of date or missing
918 $(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) coredocs
919 $(prep-javadoc)
920 @if [ -f $(JVM_MIB_SRC) ] ; then \
921 $(ECHO) "$(CP) $(JVM_MIB_SRC) $(@D)/.."; \
922 $(CP) $(JVM_MIB_SRC) $(@D)/.. ; \
923 else \
924 $(ECHO) "WARNING: File $(JVM_MIB_NAME) not available."; \
925 fi
926 $(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE))
927 $(JAVADOC_CMD) -d $(@D) \
928 @$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE)
930 # Create file with javadoc options in it
931 $(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW)
932 $(prep-target)
933 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
934 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
935 $(call OptionPair,-encoding,ascii) ; \
936 $(call OptionOnly,-nodeprecatedlist) ; \
937 $(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \
938 $(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \
939 $(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \
940 $(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \
941 $(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \
942 $(call OptionTrip,-linkoffline,$(MGMT2COREAPI),$(COREAPI_DOCSDIR)/); \
943 ) >> $@
945 # Create a file with the package names in it
946 $(MGMT_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(MGMT_PKGS))
947 $(prep-target)
948 $(call PackageFilter,$(MGMT_PKGS))
950 #############################################################
951 #
952 # attachdocs
953 #
955 ALL_OTHER_TARGETS += attachdocs
957 ATTACH_DOCDIR := $(JDK_API_DOCSDIR)/attach/spec
958 ATTACH2COREAPI := ../../$(JDKJRE2COREAPI)
959 ATTACH_DOCTITLE := Attach API
960 ATTACH_WINDOWTITLE := Attach API
961 ATTACH_HEADER := <strong>Attach API</strong>
962 ATTACH_BOTTOM := $(call CommonBottom,$(ATTACH_FIRST_COPYRIGHT_YEAR))
963 # ATTACH_PKGS is located in NON_CORE_PKGS.gmk
965 ATTACH_INDEX_HTML = $(ATTACH_DOCDIR)/index.html
966 ATTACH_OPTIONS_FILE = $(DOCSTMPDIR)/attach.options
967 ATTACH_PACKAGES_FILE = $(DOCSTMPDIR)/attach.packages
969 attachdocs: $(ATTACH_INDEX_HTML)
971 # Set relative location to core api document root
972 $(ATTACH_INDEX_HTML): GET2DOCSDIR=$(ATTACH2COREAPI)/..
974 # Run javadoc if the index file is out of date or missing
975 $(ATTACH_INDEX_HTML): $(ATTACH_OPTIONS_FILE) $(ATTACH_PACKAGES_FILE) coredocs
976 $(prep-javadoc)
977 $(call JavadocSummary,$(ATTACH_OPTIONS_FILE),$(ATTACH_PACKAGES_FILE))
978 $(JAVADOC_CMD) -d $(@D) \
979 @$(ATTACH_OPTIONS_FILE) @$(ATTACH_PACKAGES_FILE)
981 # Create file with javadoc options in it
982 $(ATTACH_OPTIONS_FILE):
983 $(prep-target)
984 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
985 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
986 $(call OptionPair,-encoding,ascii) ; \
987 $(call OptionOnly,-nodeprecatedlist) ; \
988 $(call OptionPair,-doctitle,$(ATTACH_DOCTITLE)) ; \
989 $(call OptionPair,-windowtitle,$(ATTACH_WINDOWTITLE) $(DRAFT_WINTITLE)); \
990 $(call OptionPair,-header,$(ATTACH_HEADER)$(DRAFT_HEADER)) ; \
991 $(call OptionPair,-bottom,$(ATTACH_BOTTOM)$(DRAFT_BOTTOM)) ; \
992 $(call OptionTrip,-linkoffline,$(ATTACH2COREAPI),$(COREAPI_DOCSDIR)/); \
993 ) >> $@
995 # Create a file with the package names in it
996 $(ATTACH_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(ATTACH_PKGS))
997 $(prep-target)
998 $(call PackageFilter,$(ATTACH_PKGS))
1000 #############################################################
1001 #
1002 # jconsoledocs
1003 #
1005 ALL_OTHER_TARGETS += jconsoledocs
1007 JCONSOLE_DOCDIR := $(JDK_API_DOCSDIR)/jconsole/spec
1008 JCONSOLE2COREAPI := ../../$(JDKJRE2COREAPI)
1009 JCONSOLE_DOCTITLE := JConsole API
1010 JCONSOLE_WINDOWTITLE := JConsole API
1011 JCONSOLE_HEADER := <strong>JConsole API</strong>
1012 JCONSOLE_BOTTOM := $(call CommonBottom,$(JCONSOLE_FIRST_COPYRIGHT_YEAR))
1013 # JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk
1015 JCONSOLE_INDEX_HTML = $(JCONSOLE_DOCDIR)/index.html
1016 JCONSOLE_OPTIONS_FILE = $(DOCSTMPDIR)/jconsole.options
1017 JCONSOLE_PACKAGES_FILE = $(DOCSTMPDIR)/jconsole.packages
1019 jconsoledocs: $(JCONSOLE_INDEX_HTML)
1021 # Set relative location to core api document root
1022 $(JCONSOLE_INDEX_HTML): GET2DOCSDIR=$(JCONSOLE2COREAPI)/..
1024 # Run javadoc if the index file is out of date or missing
1025 $(JCONSOLE_INDEX_HTML): $(JCONSOLE_OPTIONS_FILE) $(JCONSOLE_PACKAGES_FILE) coredocs
1026 $(prep-javadoc)
1027 $(call JavadocSummary,$(JCONSOLE_OPTIONS_FILE),$(JCONSOLE_PACKAGES_FILE))
1028 $(JAVADOC_CMD) -d $(@D) \
1029 @$(JCONSOLE_OPTIONS_FILE) @$(JCONSOLE_PACKAGES_FILE)
1031 # Create file with javadoc options in it
1032 $(JCONSOLE_OPTIONS_FILE):
1033 $(prep-target)
1034 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1035 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1036 $(call OptionPair,-encoding,ascii) ; \
1037 $(call OptionOnly,-nodeprecatedlist) ; \
1038 $(call OptionPair,-doctitle,$(JCONSOLE_DOCTITLE)) ; \
1039 $(call OptionPair,-windowtitle,$(JCONSOLE_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1040 $(call OptionPair,-header,$(JCONSOLE_HEADER)$(DRAFT_HEADER)) ; \
1041 $(call OptionPair,-bottom,$(JCONSOLE_BOTTOM)$(DRAFT_BOTTOM)) ; \
1042 $(call OptionTrip,-linkoffline,$(JCONSOLE2COREAPI),$(COREAPI_DOCSDIR)/); \
1043 ) >> $@
1045 # Create a file with the package names in it
1046 $(JCONSOLE_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JCONSOLE_PKGS))
1047 $(prep-target)
1048 $(call PackageFilter,$(JCONSOLE_PKGS))
1050 #############################################################
1051 #
1052 # treeapidocs
1053 #
1055 ALL_OTHER_TARGETS += treeapidocs
1057 TREEAPI_DOCDIR := $(JDK_API_DOCSDIR)/javac/tree
1058 TREEAPI2COREAPI := ../../$(JDKJRE2COREAPI)
1059 TREEAPI_DOCTITLE := Compiler Tree API
1060 TREEAPI_WINDOWTITLE := Compiler Tree API
1061 TREEAPI_HEADER := <strong>Compiler Tree API</strong>
1062 TREEAPI_BOTTOM := $(call CommonBottom,$(TREEAPI_FIRST_COPYRIGHT_YEAR))
1063 TREEAPI_GROUPNAME := Packages
1064 TREEAPI_REGEXP := com.sun.source.*
1065 # TREEAPI_PKGS is located in NON_CORE_PKGS.gmk
1067 TREEAPI_INDEX_HTML = $(TREEAPI_DOCDIR)/index.html
1068 TREEAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options
1069 TREEAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages
1071 treeapidocs: $(TREEAPI_INDEX_HTML)
1073 # Set relative location to core api document root
1074 $(TREEAPI_INDEX_HTML): GET2DOCSDIR=$(TREEAPI2COREAPI)/..
1076 # Run javadoc if the index file is out of date or missing
1077 $(TREEAPI_INDEX_HTML): $(TREEAPI_OPTIONS_FILE) $(TREEAPI_PACKAGES_FILE) coredocs
1078 $(prep-javadoc)
1079 $(call JavadocSummary,$(TREEAPI_OPTIONS_FILE),$(TREEAPI_PACKAGES_FILE))
1080 $(JAVADOC_CMD) -d $(@D) \
1081 @$(TREEAPI_OPTIONS_FILE) @$(TREEAPI_PACKAGES_FILE)
1083 # Create file with javadoc options in it
1084 $(TREEAPI_OPTIONS_FILE):
1085 $(prep-target)
1086 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1087 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1088 $(call OptionPair,-encoding,ascii) ; \
1089 $(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \
1090 $(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1091 $(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \
1092 $(call OptionPair,-tag,$(TAG_JLS)) ; \
1093 $(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1094 $(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \
1095 $(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1096 ) >> $@
1098 # Create a file with the package names in it
1099 $(TREEAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TREEAPI_PKGS))
1100 $(prep-target)
1101 $(call PackageFilter,$(TREEAPI_PKGS))
1103 #############################################################
1104 #
1105 # sctpdocs
1106 #
1108 ALL_OTHER_TARGETS += sctpdocs
1110 SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec
1111 SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
1112 SCTPAPI_DOCTITLE := SCTP API
1113 SCTPAPI_WINDOWTITLE := SCTP API
1114 SCTPAPI_HEADER := <strong>SCTP API</strong>
1115 SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR))
1116 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk
1118 SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html
1119 SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options
1120 SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages
1122 sctpdocs: $(SCTPAPI_INDEX_HTML)
1124 # Set relative location to core api document root
1125 $(SCTPAPI_INDEX_HTML): GET2DOCSDIR=$(SCTPAPI2COREAPI)/..
1127 # Run javadoc if the index file is out of date or missing
1128 $(SCTPAPI_INDEX_HTML): $(SCTPAPI_OPTIONS_FILE) $(SCTPAPI_PACKAGES_FILE) coredocs
1129 $(prep-javadoc)
1130 $(call JavadocSummary,$(SCTPAPI_OPTIONS_FILE),$(SCTPAPI_PACKAGES_FILE))
1131 $(JAVADOC_CMD) -d $(@D) \
1132 @$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE)
1134 # Create file with javadoc options in it
1135 $(SCTPAPI_OPTIONS_FILE):
1136 $(prep-target)
1137 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1138 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1139 $(call OptionPair,-encoding,ascii) ; \
1140 $(call OptionOnly,-nodeprecatedlist) ; \
1141 $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \
1142 $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1143 $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \
1144 $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1145 $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1146 ) >> $@
1148 # Create a file with the package names in it
1149 $(SCTPAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SCTPAPI_PKGS))
1150 $(prep-target)
1151 $(call PackageFilter,$(SCTPAPI_PKGS))
1153 #############################################################
1154 #
1155 # jdk.net docs
1156 #
1158 ALL_OTHER_TARGETS += jdknetdocs
1160 JDKNET_DOCDIR := $(JRE_API_DOCSDIR)/net/socketoptions/spec
1161 JDKNET2COREAPI := ../../../$(JDKJRE2COREAPI)
1162 JDKNET_DOCTITLE := jdk.net API
1163 JDKNET_WINDOWTITLE := jdk.net API
1164 JDKNET_HEADER := <strong>jdk.net API</strong>
1165 JDKNET_BOTTOM := $(call CommonBottom,$(JDKNET_FIRST_COPYRIGHT_YEAR))
1166 JDKNET_PKGS := jdk.net
1168 JDKNET_INDEX_HTML = $(JDKNET_DOCDIR)/index.html
1169 JDKNET_OPTIONS_FILE = $(DOCSTMPDIR)/jdknet.options
1170 JDKNET_PACKAGES_FILE = $(DOCSTMPDIR)/jdknet.packages
1172 jdknetdocs: $(JDKNET_INDEX_HTML)
1174 # Set relative location to core api document root
1175 $(JDKNET_INDEX_HTML): GET2DOCSDIR=$(JDKNET2COREAPI)/..
1177 # Run javadoc if the index file is out of date or missing
1178 $(JDKNET_INDEX_HTML): $(JDKNET_OPTIONS_FILE) $(JDKNET_PACKAGES_FILE) coredocs
1179 $(prep-javadoc)
1180 $(call JavadocSummary,$(JDKNET_OPTIONS_FILE),$(JDKNET_PACKAGES_FILE))
1181 $(JAVADOC_CMD) -d $(@D) \
1182 @$(JDKNET_OPTIONS_FILE) @$(JDKNET_PACKAGES_FILE)
1184 # Create file with javadoc options in it
1185 $(JDKNET_OPTIONS_FILE):
1186 $(prep-target)
1187 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1188 $(call OptionOnly,-Xdoclint:none) ; \
1189 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1190 $(call OptionPair,-encoding,ascii) ; \
1191 $(call OptionOnly,-nodeprecatedlist) ; \
1192 $(call OptionPair,-doctitle,$(JDKNET_DOCTITLE)) ; \
1193 $(call OptionPair,-windowtitle,$(JDKNET_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1194 $(call OptionPair,-header,$(JDKNET_HEADER)$(DRAFT_HEADER)); \
1195 $(call OptionPair,-bottom,$(JDKNET_BOTTOM)$(DRAFT_BOTTOM)); \
1196 $(call OptionTrip,-linkoffline,$(JDKNET2COREAPI),$(COREAPI_DOCSDIR)/); \
1197 ) >> $@
1199 # Create a file with the package names in it
1200 $(JDKNET_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JDKNET_PKGS))
1201 $(prep-target)
1202 $(call PackageFilter,$(JDKNET_PKGS))
1204 #############################################################
1205 #
1206 # Get a cache of all the directories
1208 $(DIRECTORY_CACHE): $(ALL_EXISTING_SOURCE_DIRS)
1209 $(prep-target)
1210 @for cp in $(ALL_EXISTING_SOURCE_DIRS) ; do \
1211 $(ECHO) "$(FIND) $${cp} -type f >> $@"; \
1212 $(FIND) $${cp} -type f >> $@; \
1213 done
1215 #############################################################
1216 #release version of core packages ########
1218 # The rel-coredocs and rel-docs targets were added by Eric Armstrong. rel-coredocs
1219 # assumes the kind of large, 32-bit machine used in the javapubs group's docs-release
1220 # process. It specifies memory settings accordingly to maximize performance.
1221 #
1222 # The performance settings, like the sanity check, are most important for the core
1223 # docs--the platform APIs. Running javadoc on those APIs takes a significant amount
1224 # of time and memory. Setting the initial heap size as large as possible is important
1225 # to prevent thrashing as the heap grows. Setting the maximum as large as necessary
1226 # is also important to keep the job from failing.
1227 #
1228 # -J-Xmx512 sets a maximum of 512, which became necessary in 6.0
1229 # -J-Xms256 sets starting size to 256 (default is 8)
1230 #
1231 # rel-coredocs also includes a sanity check to help ensure that BUILD_NUMBER and
1232 # MILESTONE are specified properly when docs are built outside of the normal release
1233 # engineering process, with the intention of releasing them on the web or in a downloaded
1234 # docs bundle. (When invoked in release engineering's control build, the values are always
1235 # set properly. But when the targets are run by themselves, they default to b00 and
1236 # "internal"--which silently sabotage the result of a build that can take many hours
1237 # to complete.
1239 # Maximize performance and ensure that build number & milestone are set.
1241 rel-coredocs: sanitycheckcoredocs
1242 $(MAKE) coredocs
1244 rel-docs: rel-coredocs $(ALL_OTHER_TARGETS)
1245 #
1246 # end of production targets
1248 otherdocs: $(ALL_OTHER_TARGETS)
1250 clean:
1251 $(RM) -r $(DOCSDIR) $(DOCSTMPDIR)
1253 #############################################################
1254 # DEBUG TARGET
1255 # List the values defined in the makefile hierarchy, to make sure everything
1256 # is set properly, and to help identify values we can use instead of making new ones.
1257 # (Most of them come from common/shared/Defs.gmk)
1258 #
1259 # Notes:
1260 # * BUILD_NUMBER defaults to b00 if not set on command line with BUILD_NUMBER=<value>
1261 # * MILESTONE defaults to internal unless set to beta, rc, or fcs on command line
1262 #
1264 #############################################################
1265 .PHONY: all docs coredocs rel-docs otherdocs rel-coredocs \
1266 sanitycheckcoredocs $(ALL_OTHER_TARGETS)
