Print this page
| Split |
Close |
| Expand all |
| Collapse all |
--- old/make/Javadoc.gmk
+++ new/make/Javadoc.gmk
1 1 # Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
2 2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 3 #
4 4 # This code is free software; you can redistribute it and/or modify it
5 5 # under the terms of the GNU General Public License version 2 only, as
6 6 # published by the Free Software Foundation. Oracle designates this
7 7 # particular file as subject to the "Classpath" exception as provided
8 8 # by Oracle in the LICENSE file that accompanied this code.
9 9 #
10 10 # This code is distributed in the hope that it will be useful, but WITHOUT
11 11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 13 # version 2 for more details (a copy is included in the LICENSE file that
14 14 # accompanied this code).
15 15 #
16 16 # You should have received a copy of the GNU General Public License version
17 17 # 2 along with this work; if not, write to the Free Software Foundation,
18 18 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 19 #
20 20 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 21 # or visit www.oracle.com if you need additional information or have any
22 22 # questions.
23 23 #
24 24
25 25 include $(SPEC)
26 26 include MakeBase.gmk
27 27
28 28 .SUFFIXES: # Delete the default suffixes
29 29 .SUFFIXES: .java
30 30
31 31 #
32 32 # Definitions for $(DOCSDIR), $(MKDIR), $(BINDIR), etc.
33 33 #
34 34
35 35 DOCSDIR=$(OUTPUT_ROOT)/docs
36 36 TEMPDIR=$(OUTPUT_ROOT)/docstemp
37 37
38 38 JDK_SHARE_SRC=$(JDK_TOPDIR)/src/share
39 39 JDK_SHARE_CLASSES=$(JDK_SHARE_SRC)/classes
40 40
41 41 JDK_IMPSRC = $(JDK_OUTPUTDIR)/impsrc
42 42
43 43 JDK_GENSRC = $(JDK_OUTPUTDIR)/gensrc
44 44
45 45 HOTSPOT_DOCS_IMPORT_PATH=$(HOTSPOT_OUTPUTDIR)/docs
46 46
47 47 BUILD_NUMBER=$(JDK_BUILD_NUMBER)
48 48
49 49 JAVADOC_CMD = $(JAVA) \
50 50 -Xmx1024m \
51 51 -Djava.awt.headless=true \
52 52 $(NEW_JAVADOC) \
53 53 -bootclasspath $(JDK_OUTPUTDIR)/classes
54 54
55 55 # Copyright year for beginning of Java and some of the apis
56 56 # (Needed when creating the javadocs)
57 57 FIRST_COPYRIGHT_YEAR = 1993
58 58 DOMAPI_FIRST_COPYRIGHT_YEAR = 2005
59 59 MIRROR_FIRST_COPYRIGHT_YEAR = 2004
60 60 DOCLETAPI_FIRST_COPYRIGHT_YEAR = 1993
61 61 TAGLETAPI_FIRST_COPYRIGHT_YEAR = 1993
62 62 JDI_FIRST_COPYRIGHT_YEAR = 1999
63 63 JAAS_FIRST_COPYRIGHT_YEAR = 1998
64 64 JGSS_FIRST_COPYRIGHT_YEAR = 2000
65 65 SMARTCARDIO_FIRST_COPYRIGHT_YEAR = 2005
66 66 HTTPSERVER_FIRST_COPYRIGHT_YEAR = 2005
67 67 MGMT_FIRST_COPYRIGHT_YEAR = 2003
68 68 ATTACH_FIRST_COPYRIGHT_YEAR = 2005
69 69 JCONSOLE_FIRST_COPYRIGHT_YEAR = 2006
70 70 SCTPAPI_FIRST_COPYRIGHT_YEAR = 2009
71 71 TRACING_FIRST_COPYRIGHT_YEAR = 2008
72 72 TREEAPI_FIRST_COPYRIGHT_YEAR = 2005
73 73 NASHORNAPI_FIRST_COPYRIGHT_YEAR = 2014
74 74 JNLP_FIRST_COPYRIGHT_YEAR = 1998
75 75 PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007
76 76 JDKNET_FIRST_COPYRIGHT_YEAR = 2014
77 77
78 78 # Oracle name
79 79 FULL_COMPANY_NAME = Oracle and/or its affiliates
80 80
81 81 # Copyright address
82 82 COMPANY_ADDRESS = 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA.
83 83
84 84 # The trademark symbol
85 85 TRADEMARK = ™
86 86
87 87 # Common copyright lines used
88 88 # The word "Copyright" might optionally be a link to the file cpyr.html.
89 89 # The first year of copyright may vary or not be available.
90 90 # The address to the company might be optional.
91 91 COMMA:= ,
92 92 EMPTY:=
93 93 SPACE:=$(EMPTY) $(EMPTY)
94 94 COPYRIGHT_SYMBOL = &\#x00a9;
95 95 # Macro to construct the copyright line
96 96 # (The GNU make 3.78.1 "if" conditional is broken, fixed in GNU make 3.81)
97 97 define CopyrightLine # optionalurl optionalfirstyear optionaladdress
98 98 $(if $(strip $1),<a href="$(strip $1)">Copyright</a>,Copyright) \
99 99 $(COPYRIGHT_SYMBOL) $(if $2,$2${COMMA},) $(COPYRIGHT_YEAR),\
100 100 $(FULL_COMPANY_NAME). $3 All rights reserved.
101 101 endef
102 102
103 103 # Url to root of documents
104 104 DOCSDIR_URL = {@docroot}/$(GET2DOCSDIR)
105 105
106 106 # Url to copyright html file
|
↓ open down ↓ |
106 lines elided |
↑ open up ↑ |
107 107 COPYRIGHT_URL = $(DOCSDIR_URL)/legal/cpyr.html
108 108
109 109 # Url to bug filing site
110 110 BUG_SUBMIT_URL = http://bugreport.sun.com/bugreport/
111 111
112 112 # Common line for how to submit a bug or rfe
113 113 BUG_SUBMIT_LINE = <a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a>
114 114
115 115 # Url to devdocs page
116 116 # Was: http://java.sun.com/javase/6/webnotes/devdocs-vs-specs.html
117 -DEV_DOCS_URL-7 = http://download.oracle.com/javase/7/docs/index.html
118 -DEV_DOCS_URL-8 = http://download.oracle.com/javase/8/docs/index.html
117 +DEV_DOCS_URL-7 = https://docs.oracle.com/javase/7/docs/index.html
118 +DEV_DOCS_URL-8 = https://docs.oracle.com/javase/8/docs/index.html
119 119 DEV_DOCS_URL = $(DEV_DOCS_URL-$(JDK_MINOR_VERSION))
120 -DOCS_BASE_URL = http://download.oracle.com/javase/7/docs
120 +DOCS_BASE_URL = https://docs.oracle.com/javase/7/docs
121 121
122 122 # Common Java trademark line
123 123 JAVA_TRADEMARK_LINE = Java is a trademark or registered trademark of \
124 124 $(FULL_COMPANY_NAME) in the US and other countries.
125 125
126 126 #################################################################
127 127 # Macros:
128 128
129 129
130 130 # List of all possible directories for javadoc to look for sources
131 131 # NOTE: Quotes are required around sourcepath argument only on Windows.
132 132 # Otherwise, you get "No packages or classes specified." due
133 133 # to $(PATH_SEP) being interpreted as an end of
134 134 # command (newline or shell ; character)
135 135 ALL_SOURCE_DIRS = $(JDK_SHARE_CLASSES) \
136 136 $(JDK_IMPSRC) \
137 137 $(JDK_GENSRC) \
138 138 $(JDK_OUTPUTDIR)/gendocsrc_rmic \
139 139 $(JDK_TOPDIR)/src/solaris/classes \
140 140 $(JDK_TOPDIR)/src/windows/classes \
141 141 $(NASHORN_TOPDIR)/src/ \
142 142 $(JDK_SHARE_SRC)/doc/stub
143 143
144 144 # List of directories that actually exist
145 145 ALL_EXISTING_SOURCE_DIRS := $(wildcard $(ALL_SOURCE_DIRS))
146 146
147 147 # List with classpath separator between them
148 148 EMPTY:=
149 149 SPACE:= $(EMPTY) $(EMPTY)
150 150 RELEASEDOCS_SOURCEPATH = \
151 151 $(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_SOURCE_DIRS)))
152 152
153 153 define prep-target
154 154 $(MKDIR) -p $(@D)
155 155 $(RM) $@
156 156 endef
157 157
158 158 # Prep for javadoc creation, assumes $@ is an index.html file
159 159 define prep-javadoc
160 160 @if [ -f "$@" -a "$?" != "" ] ; then \
161 161 $(ECHO) "# Dependencies have changed: $?"; \
162 162 fi
163 163 $(RM) -r $(@D)
164 164 $(MKDIR) -p $(@D)
165 165 endef
166 166
167 167 # A cache of the directories in ALL_SOURCE_DIRS
168 168 DIRECTORY_CACHE = $(DOCSTMPDIR)/directory.cache
169 169
170 170 # Given a list of packages, return a list of files or dirs to be dependent on
171 171 # (Currently only returning a list of directories)
172 172 define PackageDependencies # packages
173 173 $(shell \
174 174 if [ "$1" != "" -a -f $(DIRECTORY_CACHE) ] ; then \
175 175 for p in $1 ; do \
176 176 pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \
177 177 $(CAT) $(DIRECTORY_CACHE) | $(GREP) "/$${pd}/" ; \
178 178 done; \
179 179 fi \
180 180 )
181 181 endef
182 182
183 183 # Given a list of packages, add packages that exist to $@, print summary
184 184 define PackageFilter # packages
185 185 @if [ "$1" != "" ] ; then \
186 186 for p in $1 ; do \
187 187 pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \
188 188 found="false"; \
189 189 for cp in $(ALL_SOURCE_DIRS) ; do \
190 190 if [ -d $${cp}/$${pd} ] ; then \
191 191 $(ECHO) "$${p}" >> $@; \
192 192 found="true"; \
193 193 break; \
194 194 fi; \
195 195 done; \
196 196 if [ "$${found}" = "false" ] ; then \
197 197 $(ECHO) "WARNING: Package not found: $${p}"; \
198 198 fi; \
199 199 done; \
200 200 fi
201 201 endef
202 202
203 203 # Print out a summary of the javadoc command about to be run
204 204 define JavadocSummary # optionsfile packagesfile
205 205 @$(ECHO) "# Summary for $@"; \
206 206 $(ECHO) "# Options (`$(BASENAME) $1`):"; $(SED) -e 's@^@# @' $1; \
207 207 $(ECHO) "# Packages (`$(BASENAME) $2`):";$(SED) -e 's@^@# @' $2
208 208 endef
209 209
210 210 #
211 211 # Temporary directory for javadoc creation
212 212 #
213 213 DOCSTMPDIR = $(TEMPDIR)/doctmp
214 214
215 215 #
216 216 # Different api directories created from root directory
217 217 #
218 218 COREAPI_DOCSDIR = $(DOCSDIR)/api
219 219 JDK_API_DOCSDIR = $(DOCSDIR)/jdk/api
220 220 JRE_API_DOCSDIR = $(DOCSDIR)/jre/api
221 221 PLATFORM_DOCSDIR = $(DOCSDIR)/platform
222 222
223 223 # The non-core api javadocs need to be able to access the root of the core
224 224 # api directory, so for jdk/api or jre/api to get to the core api/
225 225 # directory we would use this:
226 226 JDKJRE2COREAPI = ../../api
227 227
228 228 # Common bottom argument
229 229 define CommonBottom # year
230 230 <font size="-1"><br> $(call CopyrightLine,,$1,)</font>
231 231 endef
232 232
233 233 # Common trademark bottom argument (Not sure why this is used sometimes)
234 234 define CommonTrademarkBottom # year
235 235 <font size="-1">\
236 236 $(BUG_SUBMIT_LINE)<br>$(JAVA_TRADEMARK_LINE)<br>\
237 237 $(call CopyrightLine,,$1,$(COMPANY_ADDRESS))\
238 238 </font>
239 239 endef
240 240
241 241 # Common echo of option
242 242 define OptionOnly # opt
243 243 $(PRINTF) "%s\n" "$1"
244 244 endef
245 245 define OptionPair # opt arg
246 246 $(PRINTF) "%s '%s'\n" "$1" '$2'
247 247 endef
248 248 define OptionTrip # opt arg arg
249 249 $(PRINTF) "%s '%s' '%s'\n" "$1" '$2' '$3'
250 250 endef
251 251
252 252 # Core api bottom argument (with special sauce)
253 253 COREAPI_BOTTOM = <font size="-1"> $(BUG_SUBMIT_LINE)\
254 254 <br>For further API reference and developer documentation, \
255 255 see <a href="$(DEV_DOCS_URL)" target="_blank">Java SE Documentation</a>. \
256 256 That documentation contains more detailed, developer-targeted descriptions, \
257 257 with conceptual overviews, definitions of terms, workarounds, \
258 258 and working code examples.<br>\
259 259 $(call CopyrightLine,$(COPYRIGHT_URL),$(FIRST_COPYRIGHT_YEAR),)\
260 260 </font>
261 261
262 262 # Common javadoc options used by all
263 263 COMMON_JAVADOCFLAGS = \
264 264 -XDignore.symbol.file=true \
265 265 -quiet \
266 266 -use \
267 267 -keywords \
268 268 -Xdoclint:none \
269 269 -Xprofilespath $(JDK_TOPDIR)/make/profile-rtjar-includes.txt \
270 270 $(ADDITIONAL_JAVADOCFLAGS)
271 271
272 272 ifdef OPENJDK
273 273 ADDITIONAL_JAVADOCFLAGS = \
274 274 -Xdocrootparent $(DOCS_BASE_URL)
275 275 else
276 276 ADDITIONAL_JAVADOCFLAGS =
277 277 endif
278 278
279 279 # Draft used for non-fcs documents
280 280 DRAFT_HEADER =
281 281 ifneq ($(MILESTONE), fcs)
282 282 DRAFT_HEADER = <br><strong>DRAFT $(MILESTONE)-$(BUILD_NUMBER)</strong>
283 283 DRAFT_BOTTOM = <br><strong>DRAFT $(MILESTONE)-$(BUILD_NUMBER)</strong>
284 284 DRAFT_WINTITLE = $(BUILD_NUMBER)
285 285 # Early access top text (not used in FCS releases)
286 286 COREAPI_TOP_EARLYACCESS = \
287 287 <div style="background-color: \#EEEEEE"> \
288 288 <div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; \
289 289 margin-left: 6px; margin-right: 6px; text-align: justify; \
290 290 font-size: 80%; font-family: Helvetica, Arial, sans-serif; \
291 291 font-weight: normal;"> \
292 292 Please note that the specifications and other information \
293 293 contained herein are not final and are subject to change. \
294 294 The information is being made available to you solely for purpose of \
295 295 evaluation. \
296 296 </div> </div>
297 297
298 298 endif
299 299
300 300 #################################################################
301 301
302 302 #
303 303 # CORE_PKGS environment variable has been moved to the following file
304 304 #
305 305 include CORE_PKGS.gmk
306 306
307 307 #
308 308 # Load environment variables for API package names that are not part of
309 309 # the Java SE platform
310 310 #
311 311 include NON_CORE_PKGS.gmk
312 312
313 313 #################################################################
314 314
315 315 #
316 316 # Load custom Javadoc rules, if present
317 317 #
318 318 -include $(CUSTOM_MAKE_DIR)/Javadoc.gmk
319 319
320 320 #################################################################
321 321
322 322 #
323 323 # Default target is same as docs target, create core api and all others it can
324 324 #
325 325
326 326 all: docs
327 327 docs: coredocs otherdocs
328 328
329 329 #################################################################
330 330 # Production Targets -- USE THESE TARGETS WHEN:
331 331 # a) You're generating docs outside of release engineering's
332 332 # standard control build.
333 333 # b) The docs will be pushed to the web and/or included in
334 334 # the downloaded doc bundle.
335 335 #
336 336 # See: Notes.html#releaseTargets
337 337 # Note: Spaces precede ifdef/ifndef indents. Tabs precede target commands (!)
338 338 #
339 339
340 340 sanitycheckcoredocs:
341 341 @$(ECHO) ""
342 342 @$(ECHO) "Building core api docs with these values:"
343 343 @$(ECHO) " BUILD_NUMBER = $(BUILD_NUMBER)"
344 344 @$(ECHO) " MILESTONE = $(MILESTONE)"
345 345 @$(ECHO) ""
346 346 ifeq ($(BUILD_NUMBER), b00)
347 347 @$(ECHO) "ERROR: Build number must be defined"
348 348 @$(ECHO) "MILESTONE is set to $(MILESTONE)"
349 349 @$(ECHO) ""
350 350 exit 1
351 351 endif
352 352
353 353 #############################################################
354 354 #
355 355 # coredocs
356 356 #
357 357 COREAPI_DOCTITLE = Java$(TRADEMARK) Platform, Standard Edition \
358 358 $(JDK_MINOR_VERSION)<br>API Specification
359 359 COREAPI_WINDOWTITLE = Java Platform SE $(JDK_MINOR_VERSION)
360 360 COREAPI_HEADER = \
361 361 <strong>Java$(TRADEMARK) Platform<br>Standard Ed. $(JDK_MINOR_VERSION)</strong>
362 362
363 363 # Java language specification cite
364 364 TAG_JLS = jls:a:See <cite> \
365 365 The Java™ Language Specification</cite>:
366 366
367 367 # Overview file for core apis
368 368 COREAPI_OVERVIEW = $(JDK_SHARE_CLASSES)/overview-core.html
369 369
370 370 # The index.html, options, and packages files
371 371 COREAPI_INDEX_FILE = $(COREAPI_DOCSDIR)/index.html
372 372 COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options
373 373 COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages
374 374
375 375 coredocs: $(COREAPI_INDEX_FILE)
376 376
377 377 # Set relative location to core api document root
378 378 $(COREAPI_INDEX_FILE): GET2DOCSDIR=..
379 379
380 380 # Run javadoc if the index file is out of date or missing
381 381 $(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE)
382 382 $(prep-javadoc)
383 383 $(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE))
384 384 $(JAVADOC_CMD) -d $(@D) \
385 385 @$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE)
386 386
387 387 # Create file with javadoc options in it
388 388 $(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW)
389 389 $(prep-target)
390 390 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
391 391 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
392 392 $(call OptionPair,-encoding,ISO-8859-1) ; \
393 393 $(call OptionPair,-tag,beaninfo:X) ; \
394 394 $(call OptionPair,-tag,revised:X) ; \
395 395 $(call OptionPair,-tag,since.unbundled:X) ; \
396 396 $(call OptionPair,-tag,spec:X) ; \
397 397 $(call OptionPair,-tag,specdefault:X) ; \
398 398 $(call OptionPair,-tag,Note:X) ; \
399 399 $(call OptionPair,-tag,ToDo:X) ; \
400 400 $(call OptionPair,-tag,apiNote:a:API Note:) ; \
401 401 $(call OptionPair,-tag,implSpec:a:Implementation Requirements:) ; \
402 402 $(call OptionPair,-tag,implNote:a:Implementation Note:) ; \
403 403 $(call OptionPair,-tag,param) ; \
404 404 $(call OptionPair,-tag,return) ; \
405 405 $(call OptionPair,-tag,throws) ; \
406 406 $(call OptionPair,-tag,since) ; \
407 407 $(call OptionPair,-tag,version) ; \
408 408 $(call OptionPair,-tag,serialData) ; \
409 409 $(call OptionPair,-tag,factory) ; \
410 410 $(call OptionPair,-tag,see) ; \
411 411 $(call OptionPair,-tag,$(TAG_JLS)) ; \
412 412 $(call OptionOnly,-splitIndex) ; \
413 413 $(call OptionPair,-overview,$(COREAPI_OVERVIEW)) ; \
414 414 $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE)) ; \
415 415 $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ; \
416 416 $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER)) ; \
417 417 $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
418 418 ) >> $@
419 419 ifdef COREAPI_TOP_EARLYACCESS
420 420 @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@
421 421 endif
422 422
423 423 # Create a file with the package names in it
424 424 $(COREAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(CORE_PKGS))
425 425 $(prep-target)
426 426 $(call PackageFilter,$(CORE_PKGS))
427 427
428 428 #############################################################
429 429 #
430 430 # docletapidocs
431 431 #
432 432
433 433 ALL_OTHER_TARGETS += docletapidocs
434 434
435 435 DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet
436 436 DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
437 437 DOCLETAPI_DOCTITLE := Doclet API
438 438 DOCLETAPI_WINDOWTITLE := Doclet API
439 439 DOCLETAPI_HEADER := <strong>Doclet API</strong>
440 440 DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
441 441 DOCLETAPI_GROUPNAME := Packages
442 442 DOCLETAPI_REGEXP := com.sun.javadoc
443 443 # DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
444 444
445 445 # The index.html, options, and packages files
446 446 DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html
447 447 DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options
448 448 DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages
449 449
450 450 docletapidocs: $(DOCLETAPI_INDEX_FILE)
451 451
452 452 # Set relative location to core api document root
453 453 $(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/..
454 454
455 455 # Run javadoc if the index file is out of date or missing
456 456 $(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) coredocs
457 457 $(prep-javadoc)
458 458 $(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE))
459 459 $(JAVADOC_CMD) -d $(@D) \
460 460 @$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE)
461 461
462 462 # Create file with javadoc options in it
463 463 $(DOCLETAPI_OPTIONS_FILE):
464 464 $(prep-target)
465 465 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
466 466 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
467 467 $(call OptionPair,-encoding,ascii) ; \
468 468 $(call OptionOnly,-breakiterator) ; \
469 469 $(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \
470 470 $(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
471 471 $(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \
472 472 $(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
473 473 $(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \
474 474 $(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
475 475 ) >> $@
476 476
477 477 # Create a file with the package names in it
478 478 $(DOCLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOCLETAPI_PKGS))
479 479 $(prep-target)
480 480 $(call PackageFilter,$(DOCLETAPI_PKGS))
481 481
482 482 #############################################################
483 483 #
484 484 # tagletapidocs
485 485 #
486 486
487 487 ALL_OTHER_TARGETS += tagletapidocs
488 488 TAGLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/taglet
489 489 TAGLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
490 490 TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR))
491 491 # TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk
492 492
493 493 # Temporary directory (special generation rules)
494 494 TAGLETAPI_TEMPDIR = $(DOCSTMPDIR)/taglets_temp
495 495
496 496 # The index.html, options, and packages files
497 497 TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/index.html
498 498 TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options
499 499 TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages
500 500
501 501 tagletapidocs: $(TAGLETAPI_INDEX_FILE)
502 502
503 503 # Set relative location to core api document root
504 504 $(TAGLETAPI_INDEX_FILE): GET2DOCSDIR=$(TAGLETAPI2COREAPI)/..
505 505
506 506 # Run javadoc if the index file is out of date or missing
507 507 $(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) coredocs
508 508 $(prep-javadoc)
509 509 $(RM) -r $(TAGLETAPI_TEMPDIR)
510 510 $(MKDIR) -p $(TAGLETAPI_TEMPDIR)
511 511 $(call JavadocSummary,$(TAGLETAPI_OPTIONS_FILE),$(TAGLETAPI_PACKAGES_FILE))
512 512 $(JAVADOC_CMD) -d $(TAGLETAPI_TEMPDIR) \
513 513 @$(TAGLETAPI_OPTIONS_FILE) @$(TAGLETAPI_PACKAGES_FILE)
514 514 cp -r $(TAGLETAPI_TEMPDIR)/com $(@D)
515 515 cp $(TAGLETAPI_TEMPDIR)/stylesheet.css $(@D)
516 516 $(RM) -r $(TAGLETAPI_TEMPDIR)
517 517
518 518 # Create file with javadoc options in it
519 519 $(TAGLETAPI_OPTIONS_FILE):
520 520 $(prep-target)
521 521 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
522 522 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
523 523 $(call OptionPair,-encoding,ascii) ; \
524 524 $(call OptionOnly,-nonavbar) ; \
525 525 $(call OptionOnly,-noindex) ; \
526 526 $(call OptionPair,-bottom,$(TAGLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
527 527 $(call OptionTrip,-linkoffline,$(TAGLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
528 528 ) >> $@
529 529
530 530 # Create a file with the package names in it
531 531 $(TAGLETAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TAGLETAPI_PKGS))
532 532 $(prep-target)
533 533 @($(ECHO) "$(JDK_IMPSRC)/$(TAGLETAPI_FILE)" ) > $@
534 534
535 535 #############################################################
536 536 #
537 537 # domapidocs
538 538 #
539 539
540 540 ALL_OTHER_TARGETS += domapidocs
541 541
542 542 DOMAPI_DOCDIR := $(JRE_API_DOCSDIR)/plugin/dom
543 543 DOMAPI2COREAPI := ../../$(JDKJRE2COREAPI)
544 544 DOMAPI_DOCTITLE := Common DOM API
545 545 DOMAPI_WINDOWTITLE := Common DOM API
546 546 DOMAPI_HEADER := <strong>Common DOM API</strong>
547 547 DOMAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOMAPI_FIRST_COPYRIGHT_YEAR))
548 548 DOMAPI_GROUPNAME := Packages
549 549 DOMAPI_REGEXP := com.sun.java.browser.dom:org.w3c.dom*
550 550 # DOMAPI_PKGS is located in NON_CORE_PKGS.gmk
551 551
552 552 # The index.html, options, and packages files
553 553 DOMAPI_INDEX_FILE = $(DOMAPI_DOCDIR)/index.html
554 554 DOMAPI_OPTIONS_FILE = $(DOCSTMPDIR)/domapi.options
555 555 DOMAPI_PACKAGES_FILE = $(DOCSTMPDIR)/domapi.packages
556 556
557 557 domapidocs: $(DOMAPI_INDEX_FILE)
558 558
559 559 # Set relative location to core api document root
560 560 $(DOMAPI_INDEX_FILE): GET2DOCSDIR=$(DOMAPI2COREAPI)/..
561 561
562 562 # Run javadoc if the index file is out of date or missing
563 563 $(DOMAPI_INDEX_FILE): $(DOMAPI_OPTIONS_FILE) $(DOMAPI_PACKAGES_FILE) coredocs
564 564 $(prep-javadoc)
565 565 $(call JavadocSummary,$(DOMAPI_OPTIONS_FILE),$(DOMAPI_PACKAGES_FILE))
566 566 $(JAVADOC_CMD) -d $(@D) \
567 567 @$(DOMAPI_OPTIONS_FILE) @$(DOMAPI_PACKAGES_FILE)
568 568
569 569 # Create file with javadoc options in it
570 570 $(DOMAPI_OPTIONS_FILE):
571 571 $(prep-target)
572 572 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
573 573 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
574 574 $(call OptionPair,-encoding,ascii) ; \
575 575 $(call OptionOnly,-splitIndex) ; \
576 576 $(call OptionPair,-doctitle,$(DOMAPI_DOCTITLE)) ; \
577 577 $(call OptionPair,-windowtitle,$(DOMAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
578 578 $(call OptionPair,-header,$(DOMAPI_HEADER)$(DRAFT_HEADER)) ; \
579 579 $(call OptionPair,-bottom,$(DOMAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
580 580 $(call OptionTrip,-group,$(DOMAPI_GROUPNAME),$(DOMAPI_REGEXP)); \
581 581 $(call OptionTrip,-linkoffline,$(DOMAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
582 582 ) >> $@
583 583
584 584 # Create a file with the package names in it
585 585 $(DOMAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(DOMAPI_PKGS))
586 586 $(prep-target)
587 587 $(call PackageFilter,$(DOMAPI_PKGS))
588 588
589 589 #############################################################
590 590 #
591 591 # jpdadocs
592 592 #
593 593
594 594 ALL_OTHER_TARGETS += jpdadocs
595 595
596 596 jpdadocs: jdidocs jdwpdocs jvmtidocs
597 597
598 598 #############################################################
599 599 #
600 600 # jdidocs
601 601 #
602 602
603 603 ALL_OTHER_TARGETS += jdidocs
604 604
605 605 JDI_DOCDIR := $(JDK_API_DOCSDIR)/jpda/jdi
606 606 JDI2COREAPI := ../../$(JDKJRE2COREAPI)
607 607 JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface
608 608 JDI_WINDOWTITLE := Java Debug Interface
609 609 JDI_HEADER := <strong>Java Debug Interface</strong>
610 610 JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR))
611 611 JDI_OVERVIEW := $(JDK_SHARE_CLASSES)/jdi-overview.html
612 612 # JDI_PKGS is located in NON_CORE_PKGS.gmk
613 613
614 614 # The index.html, options, and packages files
615 615 JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html
616 616 JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options
617 617 JDI_PACKAGES_FILE = $(DOCSTMPDIR)/jdi.packages
618 618
619 619 jdidocs: $(JDI_INDEX_FILE)
620 620
621 621 # Set relative location to core api document root
622 622 $(JDI_INDEX_FILE): GET2DOCSDIR=$(JDI2COREAPI)/..
623 623
624 624 # Run javadoc if the index file is out of date or missing
625 625 $(JDI_INDEX_FILE): $(JDI_OPTIONS_FILE) $(JDI_PACKAGES_FILE) coredocs
626 626 $(prep-javadoc)
627 627 $(call JavadocSummary,$(JDI_OPTIONS_FILE),$(JDI_PACKAGES_FILE))
628 628 $(JAVADOC_CMD) -d $(@D) \
629 629 @$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE)
630 630
631 631 # Create file with javadoc options in it
632 632 $(JDI_OPTIONS_FILE): $(JDI_OVERVIEW)
633 633 $(prep-target)
634 634 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
635 635 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
636 636 $(call OptionPair,-encoding,ascii) ; \
637 637 $(call OptionPair,-overview,$(JDI_OVERVIEW)) ; \
638 638 $(call OptionPair,-doctitle,$(JDI_DOCTITLE)) ; \
639 639 $(call OptionPair,-windowtitle,$(JDI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
640 640 $(call OptionPair,-header,$(JDI_HEADER)$(DRAFT_HEADER)) ; \
641 641 $(call OptionPair,-bottom,$(JDI_BOTTOM)$(DRAFT_BOTTOM)) ; \
642 642 $(call OptionTrip,-linkoffline,$(JDI2COREAPI),$(COREAPI_DOCSDIR)/); \
643 643 ) >> $@
644 644
645 645 # Create a file with the package names in it
646 646 $(JDI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JDI_PKGS))
647 647 $(prep-target)
648 648 $(call PackageFilter,$(JDI_PKGS))
649 649
650 650 #############################################################
651 651 #
652 652 # jdwpdocs
653 653 #
654 654
655 655 ALL_OTHER_TARGETS += jdwpdocs
656 656
657 657 JDWP_DOCDIR = $(PLATFORM_DOCSDIR)/jpda/jdwp
658 658
659 659 jdwpdocs: $(JDWP_DOCDIR)/jdwp-protocol.html
660 660 $(JDWP_DOCDIR)/jdwp-protocol.html : $(JDK_OUTPUTDIR)/gensrc_jdwp_doc/jdwp-protocol.html
661 661 $(MKDIR) -p $(@D)
662 662 $(RM) $@
663 663 $(CP) $< $@
664 664
665 665 #############################################################
666 666 #
667 667 # jvmtidocs
668 668 #
669 669
670 670 ALL_OTHER_TARGETS += jvmtidocs
671 671
672 672 JVMTI_DOCDIR = $(PLATFORM_DOCSDIR)/jvmti
673 673 JVMTI_HTML = $(HOTSPOT_DIST)/docs/platform/jvmti/jvmti.html
674 674
675 675 jvmtidocs: $(JVMTI_DOCDIR)/jvmti.html
676 676 $(JVMTI_DOCDIR)/jvmti.html:
677 677 @$(prep-javadoc)
678 678 @if [ -f $(JVMTI_HTML) ] ; then \
679 679 $(ECHO) "$(CP) $(JVMTI_HTML) $@"; \
680 680 $(CP) $(JVMTI_HTML) $@; \
681 681 else \
682 682 $(ECHO) "WARNING: Generated file does not exist: $(JVMTI_HTML)"; \
683 683 fi
684 684
685 685 #############################################################
686 686 #
687 687 # jaasdocs
688 688 #
689 689
690 690 ALL_OTHER_TARGETS += jaasdocs
691 691
692 692 JAAS_DOCDIR := $(JRE_API_DOCSDIR)/security/jaas/spec
693 693 JAAS2COREAPI := ../../../$(JDKJRE2COREAPI)
694 694 JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service
695 695 JAAS_WINDOWTITLE := Java Authentication and Authorization Service
696 696 JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong>
697 697 JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR))
698 698 # JAAS_PKGS is located in NON_CORE_PKGS.gmk
699 699 JAAS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/auth/jaas-overview.html
700 700
701 701 # The index.html, options, and packages files
702 702 JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html
703 703 JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options
704 704 JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages
705 705
706 706 jaasdocs: $(JAAS_INDEX_FILE)
707 707
708 708 # Set relative location to core api document root
709 709 $(JAAS_INDEX_FILE): GET2DOCSDIR=$(JAAS2COREAPI)/..
710 710
711 711 # Run javadoc if the index file is out of date or missing
712 712 $(JAAS_INDEX_FILE): $(JAAS_OPTIONS_FILE) $(JAAS_PACKAGES_FILE) coredocs
713 713 $(prep-javadoc)
714 714 $(call JavadocSummary,$(JAAS_OPTIONS_FILE),$(JAAS_PACKAGES_FILE))
715 715 $(JAVADOC_CMD) -d $(@D) \
716 716 @$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE)
717 717
718 718 # Create file with javadoc options in it
719 719 $(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW)
720 720 $(prep-target)
721 721 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
722 722 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
723 723 $(call OptionPair,-encoding,ascii) ; \
724 724 $(call OptionPair,-overview,$(JAAS_OVERVIEW)) ; \
725 725 $(call OptionPair,-doctitle,$(JAAS_DOCTITLE)) ; \
726 726 $(call OptionPair,-windowtitle,$(JAAS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
727 727 $(call OptionPair,-header,$(JAAS_HEADER)$(DRAFT_HEADER)) ; \
728 728 $(call OptionPair,-bottom,$(JAAS_BOTTOM)$(DRAFT_BOTTOM)) ; \
729 729 $(call OptionTrip,-linkoffline,$(JAAS2COREAPI),$(COREAPI_DOCSDIR)/); \
730 730 ) >> $@
731 731
732 732 # Create a file with the package names in it
733 733 $(JAAS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JAAS_PKGS))
734 734 $(prep-target)
735 735 $(call PackageFilter,$(JAAS_PKGS))
736 736
737 737 #############################################################
738 738 #
739 739 # jgssdocs
740 740 #
741 741
742 742 ALL_OTHER_TARGETS += jgssdocs
743 743
744 744 JGSS_DOCDIR := $(JRE_API_DOCSDIR)/security/jgss/spec
745 745 JGSS2COREAPI := ../../../$(JDKJRE2COREAPI)
746 746 JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities
747 747 JGSS_WINDOWTITLE := Java GSS-API Utilities
748 748 JGSS_HEADER := <strong>Java GSS-API Utilities</strong>
749 749 JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR))
750 750 JGSS_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/security/jgss/jgss-overview.html
751 751 # JGSS_PKGS is located in NON_CORE_PKGS.gmk
752 752
753 753 # The index.html, options, and packages files
754 754 JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html
755 755 JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options
756 756 JGSS_PACKAGES_FILE = $(DOCSTMPDIR)/jgss.packages
757 757
758 758 jgssdocs: $(JGSS_INDEX_FILE)
759 759
760 760 # Set relative location to core api document root
761 761 $(JGSS_INDEX_FILE): GET2DOCSDIR=$(JGSS2COREAPI)/..
762 762
763 763 # Run javadoc if the index file is out of date or missing
764 764 $(JGSS_INDEX_FILE): $(JGSS_OPTIONS_FILE) $(JGSS_PACKAGES_FILE) coredocs
765 765 $(prep-javadoc)
766 766 $(call JavadocSummary,$(JGSS_OPTIONS_FILE),$(JGSS_PACKAGES_FILE))
767 767 $(JAVADOC_CMD) -d $(@D) \
768 768 @$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE)
769 769
770 770 # Create file with javadoc options in it
771 771 $(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW)
772 772 $(prep-target)
773 773 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
774 774 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
775 775 $(call OptionPair,-encoding,ascii) ; \
776 776 $(call OptionOnly,-nodeprecatedlist) ; \
777 777 $(call OptionPair,-overview,$(JGSS_OVERVIEW)) ; \
778 778 $(call OptionPair,-doctitle,$(JGSS_DOCTITLE)) ; \
779 779 $(call OptionPair,-windowtitle,$(JGSS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
780 780 $(call OptionPair,-header,$(JGSS_HEADER)$(DRAFT_HEADER)) ; \
781 781 $(call OptionPair,-bottom,$(JGSS_BOTTOM)$(DRAFT_BOTTOM)) ; \
782 782 $(call OptionTrip,-linkoffline,$(JGSS2COREAPI),$(COREAPI_DOCSDIR)/); \
783 783 ) >> $@
784 784
785 785 # Create a file with the package names in it
786 786 $(JGSS_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JGSS_PKGS))
787 787 $(prep-target)
788 788 $(call PackageFilter,$(JGSS_PKGS))
789 789
790 790 #############################################################
791 791 #
792 792 # smartcardiodocs
793 793 #
794 794
795 795 ALL_OTHER_TARGETS += smartcardiodocs
796 796
797 797 SMARTCARDIO_DOCDIR := $(JRE_API_DOCSDIR)/security/smartcardio/spec
798 798 SMARTCARDIO2COREAPI := ../../../$(JDKJRE2COREAPI)
799 799 SMARTCARDIO_DOCTITLE := Java$(TRADEMARK) Smart Card I/O
800 800 SMARTCARDIO_WINDOWTITLE := Java Smart Card I/O
801 801 SMARTCARDIO_HEADER := <strong>Java Smart Card I/O</strong>
802 802 SMARTCARDIO_BOTTOM := $(call CommonBottom,$(SMARTCARDIO_FIRST_COPYRIGHT_YEAR))
803 803 # SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk
804 804
805 805 # The index.html, options, and packages files
806 806 SMARTCARDIO_INDEX_FILE = $(SMARTCARDIO_DOCDIR)/index.html
807 807 SMARTCARDIO_OPTIONS_FILE = $(DOCSTMPDIR)/smartcardio.options
808 808 SMARTCARDIO_PACKAGES_FILE = $(DOCSTMPDIR)/smartcardio.packages
809 809
810 810 smartcardiodocs: $(SMARTCARDIO_INDEX_FILE)
811 811
812 812 # Set relative location to core api document root
813 813 $(SMARTCARDIO_INDEX_FILE): GET2DOCSDIR=$(SMARTCARDIO2COREAPI)/..
814 814
815 815 # Run javadoc if the index file is out of date or missing
816 816 $(SMARTCARDIO_INDEX_FILE): $(SMARTCARDIO_OPTIONS_FILE) $(SMARTCARDIO_PACKAGES_FILE) coredocs
817 817 $(prep-javadoc)
818 818 $(call JavadocSummary,$(SMARTCARDIO_OPTIONS_FILE),$(SMARTCARDIO_PACKAGES_FILE))
819 819 $(JAVADOC_CMD) -d $(@D) \
820 820 @$(SMARTCARDIO_OPTIONS_FILE) @$(SMARTCARDIO_PACKAGES_FILE)
821 821
822 822 # Create file with javadoc options in it
823 823 $(SMARTCARDIO_OPTIONS_FILE):
824 824 $(prep-target)
825 825 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
826 826 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
827 827 $(call OptionPair,-encoding,ascii) ; \
828 828 $(call OptionOnly,-nodeprecatedlist) ; \
829 829 $(call OptionPair,-doctitle,$(SMARTCARDIO_DOCTITLE)) ; \
830 830 $(call OptionPair,-windowtitle,$(SMARTCARDIO_WINDOWTITLE) $(DRAFT_WINTITLE)); \
831 831 $(call OptionPair,-header,$(SMARTCARDIO_HEADER)$(DRAFT_HEADER)); \
832 832 $(call OptionPair,-bottom,$(SMARTCARDIO_BOTTOM)$(DRAFT_BOTTOM)); \
833 833 $(call OptionTrip,-linkoffline,$(SMARTCARDIO2COREAPI),$(COREAPI_DOCSDIR)/); \
834 834 ) >> $@
835 835
836 836 # Create a file with the package names in it
837 837 $(SMARTCARDIO_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SMARTCARDIO_PKGS))
838 838 $(prep-target)
839 839 $(call PackageFilter,$(SMARTCARDIO_PKGS))
840 840
841 841 #############################################################
842 842 #
843 843 # httpserverdocs
844 844 #
845 845
846 846 ALL_OTHER_TARGETS += httpserverdocs
847 847
848 848 HTTPSERVER_DOCDIR := $(JRE_API_DOCSDIR)/net/httpserver/spec
849 849 HTTPSERVER2COREAPI := ../../../$(JDKJRE2COREAPI)
850 850 HTTPSERVER_DOCTITLE := Java$(TRADEMARK) HTTP Server
851 851 HTTPSERVER_WINDOWTITLE := Java HTTP Server
852 852 HTTPSERVER_HEADER := <strong>Java HTTP Server</strong>
853 853 HTTPSERVER_BOTTOM := $(call CommonBottom,$(HTTPSERVER_FIRST_COPYRIGHT_YEAR))
854 854 # HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk
855 855
856 856 HTTPSERVER_INDEX_HTML = $(HTTPSERVER_DOCDIR)/index.html
857 857 HTTPSERVER_OPTIONS_FILE = $(DOCSTMPDIR)/httpserver.options
858 858 HTTPSERVER_PACKAGES_FILE = $(DOCSTMPDIR)/httpserver.packages
859 859
860 860 httpserverdocs: $(HTTPSERVER_INDEX_HTML)
861 861
862 862 # Set relative location to core api document root
863 863 $(HTTPSERVER_INDEX_HTML): GET2DOCSDIR=$(HTTPSERVER2COREAPI)/..
864 864
865 865 # Run javadoc if the index file is out of date or missing
866 866 $(HTTPSERVER_INDEX_HTML): $(HTTPSERVER_OPTIONS_FILE) $(HTTPSERVER_PACKAGES_FILE) coredocs
867 867 $(prep-javadoc)
868 868 $(call JavadocSummary,$(HTTPSERVER_OPTIONS_FILE),$(HTTPSERVER_PACKAGES_FILE))
869 869 $(JAVADOC_CMD) -d $(@D) \
870 870 @$(HTTPSERVER_OPTIONS_FILE) @$(HTTPSERVER_PACKAGES_FILE)
871 871
872 872 # Create file with javadoc options in it
873 873 $(HTTPSERVER_OPTIONS_FILE):
874 874 $(prep-target)
875 875 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
876 876 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
877 877 $(call OptionPair,-encoding,ascii) ; \
878 878 $(call OptionOnly,-nodeprecatedlist) ; \
879 879 $(call OptionPair,-doctitle,$(HTTPSERVER_DOCTITLE)) ; \
880 880 $(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE)); \
881 881 $(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \
882 882 $(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \
883 883 $(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \
884 884 ) >> $@
885 885
886 886 # Create a file with the package names in it
887 887 $(HTTPSERVER_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(HTTPSERVER_PKGS))
888 888 $(prep-target)
889 889 $(call PackageFilter,$(HTTPSERVER_PKGS))
890 890
891 891 #############################################################
892 892 #
893 893 # mgmtdocs
894 894 #
895 895
896 896 ALL_OTHER_TARGETS += mgmtdocs
897 897
898 898 MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension
899 899 MGMT2COREAPI := ../../$(JDKJRE2COREAPI)
900 900 JVM_MIB_NAME := JVM-MANAGEMENT-MIB.mib
901 901 JVM_MIB_SRC := $(JDK_TOPDIR)/src/closed/share/classes/sun/management/snmp/$(JVM_MIB_NAME)
902 902 MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform
903 903 MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform
904 904 MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong>
905 905 MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR))
906 906 MGMT_OVERVIEW := $(JDK_SHARE_CLASSES)/com/sun/management/mgmt-overview.html
907 907 # MGMT_PKGS is located in NON_CORE_PKGS.gmk
908 908
909 909 # The index.html, options, and packages files
910 910 MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html
911 911 MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options
912 912 MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages
913 913
914 914 mgmtdocs: $(MGMT_INDEX_FILE)
915 915
916 916 # Set relative location to core api document root
917 917 $(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/..
918 918
919 919 # Run javadoc if the index file is out of date or missing
920 920 $(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) coredocs
921 921 $(prep-javadoc)
922 922 @if [ -f $(JVM_MIB_SRC) ] ; then \
923 923 $(ECHO) "$(CP) $(JVM_MIB_SRC) $(@D)/.."; \
924 924 $(CP) $(JVM_MIB_SRC) $(@D)/.. ; \
925 925 else \
926 926 $(ECHO) "WARNING: File $(JVM_MIB_NAME) not available."; \
927 927 fi
928 928 $(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE))
929 929 $(JAVADOC_CMD) -d $(@D) \
930 930 @$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE)
931 931
932 932 # Create file with javadoc options in it
933 933 $(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW)
934 934 $(prep-target)
935 935 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
936 936 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
937 937 $(call OptionPair,-encoding,ascii) ; \
938 938 $(call OptionOnly,-nodeprecatedlist) ; \
939 939 $(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \
940 940 $(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \
941 941 $(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \
942 942 $(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \
943 943 $(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \
944 944 $(call OptionTrip,-linkoffline,$(MGMT2COREAPI),$(COREAPI_DOCSDIR)/); \
945 945 ) >> $@
946 946
947 947 # Create a file with the package names in it
948 948 $(MGMT_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(MGMT_PKGS))
949 949 $(prep-target)
950 950 $(call PackageFilter,$(MGMT_PKGS))
951 951
952 952 #############################################################
953 953 #
954 954 # attachdocs
955 955 #
956 956
957 957 ALL_OTHER_TARGETS += attachdocs
958 958
959 959 ATTACH_DOCDIR := $(JDK_API_DOCSDIR)/attach/spec
960 960 ATTACH2COREAPI := ../../$(JDKJRE2COREAPI)
961 961 ATTACH_DOCTITLE := Attach API
962 962 ATTACH_WINDOWTITLE := Attach API
963 963 ATTACH_HEADER := <strong>Attach API</strong>
964 964 ATTACH_BOTTOM := $(call CommonBottom,$(ATTACH_FIRST_COPYRIGHT_YEAR))
965 965 # ATTACH_PKGS is located in NON_CORE_PKGS.gmk
966 966
967 967 ATTACH_INDEX_HTML = $(ATTACH_DOCDIR)/index.html
968 968 ATTACH_OPTIONS_FILE = $(DOCSTMPDIR)/attach.options
969 969 ATTACH_PACKAGES_FILE = $(DOCSTMPDIR)/attach.packages
970 970
971 971 attachdocs: $(ATTACH_INDEX_HTML)
972 972
973 973 # Set relative location to core api document root
974 974 $(ATTACH_INDEX_HTML): GET2DOCSDIR=$(ATTACH2COREAPI)/..
975 975
976 976 # Run javadoc if the index file is out of date or missing
977 977 $(ATTACH_INDEX_HTML): $(ATTACH_OPTIONS_FILE) $(ATTACH_PACKAGES_FILE) coredocs
978 978 $(prep-javadoc)
979 979 $(call JavadocSummary,$(ATTACH_OPTIONS_FILE),$(ATTACH_PACKAGES_FILE))
980 980 $(JAVADOC_CMD) -d $(@D) \
981 981 @$(ATTACH_OPTIONS_FILE) @$(ATTACH_PACKAGES_FILE)
982 982
983 983 # Create file with javadoc options in it
984 984 $(ATTACH_OPTIONS_FILE):
985 985 $(prep-target)
986 986 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
987 987 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
988 988 $(call OptionPair,-encoding,ascii) ; \
989 989 $(call OptionOnly,-nodeprecatedlist) ; \
990 990 $(call OptionPair,-doctitle,$(ATTACH_DOCTITLE)) ; \
991 991 $(call OptionPair,-windowtitle,$(ATTACH_WINDOWTITLE) $(DRAFT_WINTITLE)); \
992 992 $(call OptionPair,-header,$(ATTACH_HEADER)$(DRAFT_HEADER)) ; \
993 993 $(call OptionPair,-bottom,$(ATTACH_BOTTOM)$(DRAFT_BOTTOM)) ; \
994 994 $(call OptionTrip,-linkoffline,$(ATTACH2COREAPI),$(COREAPI_DOCSDIR)/); \
995 995 ) >> $@
996 996
997 997 # Create a file with the package names in it
998 998 $(ATTACH_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(ATTACH_PKGS))
999 999 $(prep-target)
1000 1000 $(call PackageFilter,$(ATTACH_PKGS))
1001 1001
1002 1002 #############################################################
1003 1003 #
1004 1004 # jconsoledocs
1005 1005 #
1006 1006
1007 1007 ALL_OTHER_TARGETS += jconsoledocs
1008 1008
1009 1009 JCONSOLE_DOCDIR := $(JDK_API_DOCSDIR)/jconsole/spec
1010 1010 JCONSOLE2COREAPI := ../../$(JDKJRE2COREAPI)
1011 1011 JCONSOLE_DOCTITLE := JConsole API
1012 1012 JCONSOLE_WINDOWTITLE := JConsole API
1013 1013 JCONSOLE_HEADER := <strong>JConsole API</strong>
1014 1014 JCONSOLE_BOTTOM := $(call CommonBottom,$(JCONSOLE_FIRST_COPYRIGHT_YEAR))
1015 1015 # JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk
1016 1016
1017 1017 JCONSOLE_INDEX_HTML = $(JCONSOLE_DOCDIR)/index.html
1018 1018 JCONSOLE_OPTIONS_FILE = $(DOCSTMPDIR)/jconsole.options
1019 1019 JCONSOLE_PACKAGES_FILE = $(DOCSTMPDIR)/jconsole.packages
1020 1020
1021 1021 jconsoledocs: $(JCONSOLE_INDEX_HTML)
1022 1022
1023 1023 # Set relative location to core api document root
1024 1024 $(JCONSOLE_INDEX_HTML): GET2DOCSDIR=$(JCONSOLE2COREAPI)/..
1025 1025
1026 1026 # Run javadoc if the index file is out of date or missing
1027 1027 $(JCONSOLE_INDEX_HTML): $(JCONSOLE_OPTIONS_FILE) $(JCONSOLE_PACKAGES_FILE) coredocs
1028 1028 $(prep-javadoc)
1029 1029 $(call JavadocSummary,$(JCONSOLE_OPTIONS_FILE),$(JCONSOLE_PACKAGES_FILE))
1030 1030 $(JAVADOC_CMD) -d $(@D) \
1031 1031 @$(JCONSOLE_OPTIONS_FILE) @$(JCONSOLE_PACKAGES_FILE)
1032 1032
1033 1033 # Create file with javadoc options in it
1034 1034 $(JCONSOLE_OPTIONS_FILE):
1035 1035 $(prep-target)
1036 1036 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1037 1037 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1038 1038 $(call OptionPair,-encoding,ascii) ; \
1039 1039 $(call OptionOnly,-nodeprecatedlist) ; \
1040 1040 $(call OptionPair,-doctitle,$(JCONSOLE_DOCTITLE)) ; \
1041 1041 $(call OptionPair,-windowtitle,$(JCONSOLE_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1042 1042 $(call OptionPair,-header,$(JCONSOLE_HEADER)$(DRAFT_HEADER)) ; \
1043 1043 $(call OptionPair,-bottom,$(JCONSOLE_BOTTOM)$(DRAFT_BOTTOM)) ; \
1044 1044 $(call OptionTrip,-linkoffline,$(JCONSOLE2COREAPI),$(COREAPI_DOCSDIR)/); \
1045 1045 ) >> $@
1046 1046
1047 1047 # Create a file with the package names in it
1048 1048 $(JCONSOLE_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JCONSOLE_PKGS))
1049 1049 $(prep-target)
1050 1050 $(call PackageFilter,$(JCONSOLE_PKGS))
1051 1051
1052 1052 #############################################################
1053 1053 #
1054 1054 # treeapidocs
1055 1055 #
1056 1056
1057 1057 ALL_OTHER_TARGETS += treeapidocs
1058 1058
1059 1059 TREEAPI_DOCDIR := $(JDK_API_DOCSDIR)/javac/tree
1060 1060 TREEAPI2COREAPI := ../../$(JDKJRE2COREAPI)
1061 1061 TREEAPI_DOCTITLE := Compiler Tree API
1062 1062 TREEAPI_WINDOWTITLE := Compiler Tree API
1063 1063 TREEAPI_HEADER := <strong>Compiler Tree API</strong>
1064 1064 TREEAPI_BOTTOM := $(call CommonBottom,$(TREEAPI_FIRST_COPYRIGHT_YEAR))
1065 1065 TREEAPI_GROUPNAME := Packages
1066 1066 TREEAPI_REGEXP := com.sun.source.*
1067 1067 # TREEAPI_PKGS is located in NON_CORE_PKGS.gmk
1068 1068
1069 1069 TREEAPI_INDEX_HTML = $(TREEAPI_DOCDIR)/index.html
1070 1070 TREEAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options
1071 1071 TREEAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages
1072 1072
1073 1073 treeapidocs: $(TREEAPI_INDEX_HTML)
1074 1074
1075 1075 # Set relative location to core api document root
1076 1076 $(TREEAPI_INDEX_HTML): GET2DOCSDIR=$(TREEAPI2COREAPI)/..
1077 1077
1078 1078 # Run javadoc if the index file is out of date or missing
1079 1079 $(TREEAPI_INDEX_HTML): $(TREEAPI_OPTIONS_FILE) $(TREEAPI_PACKAGES_FILE) coredocs
1080 1080 $(prep-javadoc)
1081 1081 $(call JavadocSummary,$(TREEAPI_OPTIONS_FILE),$(TREEAPI_PACKAGES_FILE))
1082 1082 $(JAVADOC_CMD) -d $(@D) \
1083 1083 @$(TREEAPI_OPTIONS_FILE) @$(TREEAPI_PACKAGES_FILE)
1084 1084
1085 1085 # Create file with javadoc options in it
1086 1086 $(TREEAPI_OPTIONS_FILE):
1087 1087 $(prep-target)
1088 1088 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1089 1089 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1090 1090 $(call OptionPair,-encoding,ascii) ; \
1091 1091 $(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \
1092 1092 $(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1093 1093 $(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \
1094 1094 $(call OptionPair,-tag,$(TAG_JLS)) ; \
1095 1095 $(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1096 1096 $(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \
1097 1097 $(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1098 1098 ) >> $@
1099 1099
1100 1100 # Create a file with the package names in it
1101 1101 $(TREEAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(TREEAPI_PKGS))
1102 1102 $(prep-target)
1103 1103 $(call PackageFilter,$(TREEAPI_PKGS))
1104 1104
1105 1105 #############################################################
1106 1106 #
1107 1107 # nashornapidocs
1108 1108 #
1109 1109
1110 1110 ALL_OTHER_TARGETS += nashornapidocs
1111 1111
1112 1112 NASHORNAPI_DOCDIR := $(JDK_API_DOCSDIR)/nashorn
1113 1113 NASHORNAPI2COREAPI := ../$(JDKJRE2COREAPI)
1114 1114 NASHORNAPI_DOCTITLE := Nashorn API
1115 1115 NASHORNAPI_WINDOWTITLE := Nashorn API
1116 1116 NASHORNAPI_HEADER := <strong>Nashorn API</strong>
1117 1117 NASHORNAPI_BOTTOM := $(call CommonBottom,$(NASHORNAPI_FIRST_COPYRIGHT_YEAR))
1118 1118 NASHORNAPI_GROUPNAME := Packages
1119 1119 NASHORNAPI_REGEXP := com.sun.source.*
1120 1120 # NASHORNAPI_PKGS is located in NON_CORE_PKGS.gmk
1121 1121
1122 1122 NASHORNAPI_INDEX_HTML = $(NASHORNAPI_DOCDIR)/index.html
1123 1123 NASHORNAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options
1124 1124 NASHORNAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages
1125 1125
1126 1126 treeapidocs: $(NASHORNAPI_INDEX_HTML)
1127 1127
1128 1128 # Set relative location to core api document root
1129 1129 $(NASHORNAPI_INDEX_HTML): GET2DOCSDIR=$(NASHORNAPI2COREAPI)/..
1130 1130
1131 1131 # Run javadoc if the index file is out of date or missing
1132 1132 $(NASHORNAPI_INDEX_HTML): $(NASHORNAPI_OPTIONS_FILE) $(NASHORNAPI_PACKAGES_FILE) coredocs
1133 1133 $(prep-javadoc)
1134 1134 $(call JavadocSummary,$(NASHORNAPI_OPTIONS_FILE),$(NASHORNAPI_PACKAGES_FILE))
1135 1135 $(JAVADOC_CMD) -d $(@D) \
1136 1136 @$(NASHORNAPI_OPTIONS_FILE) @$(NASHORNAPI_PACKAGES_FILE)
1137 1137
1138 1138 # Create file with javadoc options in it
1139 1139 $(NASHORNAPI_OPTIONS_FILE):
1140 1140 $(prep-target)
1141 1141 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1142 1142 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1143 1143 $(call OptionPair,-encoding,ascii) ; \
1144 1144 $(call OptionPair,-doctitle,$(NASHORNAPI_DOCTITLE)) ; \
1145 1145 $(call OptionPair,-windowtitle,$(NASHORNAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1146 1146 $(call OptionPair,-header,$(NASHORNAPI_HEADER)$(DRAFT_HEADER)) ; \
1147 1147 $(call OptionPair,-tag,$(TAG_JLS)) ; \
1148 1148 $(call OptionPair,-bottom,$(NASHORNAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1149 1149 $(call OptionTrip,-group,$(NASHORNAPI_GROUPNAME),$(NASHORNAPI_REGEXP)); \
1150 1150 $(call OptionTrip,-linkoffline,$(NASHORNAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1151 1151 ) >> $@
1152 1152
1153 1153 # Create a file with the package names in it
1154 1154 $(NASHORNAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(NASHORNAPI_PKGS))
1155 1155 $(prep-target)
1156 1156 $(call PackageFilter,$(NASHORNAPI_PKGS))
1157 1157
1158 1158 #############################################################
1159 1159 #
1160 1160 # sctpdocs
1161 1161 #
1162 1162
1163 1163 ALL_OTHER_TARGETS += sctpdocs
1164 1164
1165 1165 SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec
1166 1166 SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
1167 1167 SCTPAPI_DOCTITLE := SCTP API
1168 1168 SCTPAPI_WINDOWTITLE := SCTP API
1169 1169 SCTPAPI_HEADER := <strong>SCTP API</strong>
1170 1170 SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR))
1171 1171 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk
1172 1172
1173 1173 SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html
1174 1174 SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options
1175 1175 SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages
1176 1176
1177 1177 sctpdocs: $(SCTPAPI_INDEX_HTML)
1178 1178
1179 1179 # Set relative location to core api document root
1180 1180 $(SCTPAPI_INDEX_HTML): GET2DOCSDIR=$(SCTPAPI2COREAPI)/..
1181 1181
1182 1182 # Run javadoc if the index file is out of date or missing
1183 1183 $(SCTPAPI_INDEX_HTML): $(SCTPAPI_OPTIONS_FILE) $(SCTPAPI_PACKAGES_FILE) coredocs
1184 1184 $(prep-javadoc)
1185 1185 $(call JavadocSummary,$(SCTPAPI_OPTIONS_FILE),$(SCTPAPI_PACKAGES_FILE))
1186 1186 $(JAVADOC_CMD) -d $(@D) \
1187 1187 @$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE)
1188 1188
1189 1189 # Create file with javadoc options in it
1190 1190 $(SCTPAPI_OPTIONS_FILE):
1191 1191 $(prep-target)
1192 1192 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1193 1193 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1194 1194 $(call OptionPair,-encoding,ascii) ; \
1195 1195 $(call OptionOnly,-nodeprecatedlist) ; \
1196 1196 $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \
1197 1197 $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1198 1198 $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \
1199 1199 $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
1200 1200 $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
1201 1201 ) >> $@
1202 1202
1203 1203 # Create a file with the package names in it
1204 1204 $(SCTPAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(SCTPAPI_PKGS))
1205 1205 $(prep-target)
1206 1206 $(call PackageFilter,$(SCTPAPI_PKGS))
1207 1207
1208 1208 #############################################################
1209 1209 #
1210 1210 # jdk.net docs
1211 1211 #
1212 1212
1213 1213 ALL_OTHER_TARGETS += jdknetdocs
1214 1214
1215 1215 JDKNET_DOCDIR := $(JRE_API_DOCSDIR)/net/socketoptions/spec
1216 1216 JDKNET2COREAPI := ../../../$(JDKJRE2COREAPI)
1217 1217 JDKNET_DOCTITLE := jdk.net API
1218 1218 JDKNET_WINDOWTITLE := jdk.net API
1219 1219 JDKNET_HEADER := <strong>jdk.net API</strong>
1220 1220 JDKNET_BOTTOM := $(call CommonBottom,$(JDKNET_FIRST_COPYRIGHT_YEAR))
1221 1221 JDKNET_PKGS := jdk.net
1222 1222
1223 1223 JDKNET_INDEX_HTML = $(JDKNET_DOCDIR)/index.html
1224 1224 JDKNET_OPTIONS_FILE = $(DOCSTMPDIR)/jdknet.options
1225 1225 JDKNET_PACKAGES_FILE = $(DOCSTMPDIR)/jdknet.packages
1226 1226
1227 1227 jdknetdocs: $(JDKNET_INDEX_HTML)
1228 1228
1229 1229 # Set relative location to core api document root
1230 1230 $(JDKNET_INDEX_HTML): GET2DOCSDIR=$(JDKNET2COREAPI)/..
1231 1231
1232 1232 # Run javadoc if the index file is out of date or missing
1233 1233 $(JDKNET_INDEX_HTML): $(JDKNET_OPTIONS_FILE) $(JDKNET_PACKAGES_FILE) coredocs
1234 1234 $(prep-javadoc)
1235 1235 $(call JavadocSummary,$(JDKNET_OPTIONS_FILE),$(JDKNET_PACKAGES_FILE))
1236 1236 $(JAVADOC_CMD) -d $(@D) \
1237 1237 @$(JDKNET_OPTIONS_FILE) @$(JDKNET_PACKAGES_FILE)
1238 1238
1239 1239 # Create file with javadoc options in it
1240 1240 $(JDKNET_OPTIONS_FILE):
1241 1241 $(prep-target)
1242 1242 @($(call OptionOnly,$(COMMON_JAVADOCFLAGS)) ; \
1243 1243 $(call OptionOnly,-Xdoclint:none) ; \
1244 1244 $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
1245 1245 $(call OptionPair,-encoding,ascii) ; \
1246 1246 $(call OptionOnly,-nodeprecatedlist) ; \
1247 1247 $(call OptionPair,-doctitle,$(JDKNET_DOCTITLE)) ; \
1248 1248 $(call OptionPair,-windowtitle,$(JDKNET_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1249 1249 $(call OptionPair,-header,$(JDKNET_HEADER)$(DRAFT_HEADER)); \
1250 1250 $(call OptionPair,-bottom,$(JDKNET_BOTTOM)$(DRAFT_BOTTOM)); \
1251 1251 $(call OptionTrip,-linkoffline,$(JDKNET2COREAPI),$(COREAPI_DOCSDIR)/); \
1252 1252 ) >> $@
1253 1253
1254 1254 # Create a file with the package names in it
1255 1255 $(JDKNET_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(JDKNET_PKGS))
1256 1256 $(prep-target)
1257 1257 $(call PackageFilter,$(JDKNET_PKGS))
1258 1258
1259 1259 #############################################################
1260 1260 #
1261 1261 # Get a cache of all the directories
1262 1262
1263 1263 $(DIRECTORY_CACHE): $(ALL_EXISTING_SOURCE_DIRS)
1264 1264 $(prep-target)
1265 1265 @for cp in $(ALL_EXISTING_SOURCE_DIRS) ; do \
1266 1266 $(ECHO) "$(FIND) $${cp} -type f >> $@"; \
1267 1267 $(FIND) $${cp} -type f >> $@; \
1268 1268 done
1269 1269
1270 1270 #############################################################
1271 1271 #release version of core packages ########
1272 1272
1273 1273 # The rel-coredocs and rel-docs targets were added by Eric Armstrong. rel-coredocs
1274 1274 # assumes the kind of large, 32-bit machine used in the javapubs group's docs-release
1275 1275 # process. It specifies memory settings accordingly to maximize performance.
1276 1276 #
1277 1277 # The performance settings, like the sanity check, are most important for the core
1278 1278 # docs--the platform APIs. Running javadoc on those APIs takes a significant amount
1279 1279 # of time and memory. Setting the initial heap size as large as possible is important
1280 1280 # to prevent thrashing as the heap grows. Setting the maximum as large as necessary
1281 1281 # is also important to keep the job from failing.
1282 1282 #
1283 1283 # -J-Xmx512 sets a maximum of 512, which became necessary in 6.0
1284 1284 # -J-Xms256 sets starting size to 256 (default is 8)
1285 1285 #
1286 1286 # rel-coredocs also includes a sanity check to help ensure that BUILD_NUMBER and
1287 1287 # MILESTONE are specified properly when docs are built outside of the normal release
1288 1288 # engineering process, with the intention of releasing them on the web or in a downloaded
1289 1289 # docs bundle. (When invoked in release engineering's control build, the values are always
1290 1290 # set properly. But when the targets are run by themselves, they default to b00 and
1291 1291 # "internal"--which silently sabotage the result of a build that can take many hours
1292 1292 # to complete.
1293 1293
1294 1294 # Maximize performance and ensure that build number & milestone are set.
1295 1295
1296 1296 rel-coredocs: sanitycheckcoredocs
1297 1297 $(MAKE) coredocs
1298 1298
1299 1299 rel-docs: rel-coredocs $(ALL_OTHER_TARGETS)
1300 1300 #
1301 1301 # end of production targets
1302 1302
1303 1303 otherdocs: $(ALL_OTHER_TARGETS)
1304 1304
1305 1305 clean:
1306 1306 $(RM) -r $(DOCSDIR) $(DOCSTMPDIR)
1307 1307
1308 1308 #############################################################
1309 1309 # DEBUG TARGET
1310 1310 # List the values defined in the makefile hierarchy, to make sure everything
1311 1311 # is set properly, and to help identify values we can use instead of making new ones.
1312 1312 # (Most of them come from common/shared/Defs.gmk)
1313 1313 #
1314 1314 # Notes:
1315 1315 # * BUILD_NUMBER defaults to b00 if not set on command line with BUILD_NUMBER=<value>
1316 1316 # * MILESTONE defaults to internal unless set to beta, rc, or fcs on command line
1317 1317 #
1318 1318
1319 1319 #############################################################
1320 1320 .PHONY: all docs coredocs rel-docs otherdocs rel-coredocs \
1321 1321 sanitycheckcoredocs $(ALL_OTHER_TARGETS)
|
↓ open down ↓ |
1191 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX