< prev index next >

make/Javadoc.gmk

Print this page




 401 
 402 # Create a file with the package names in it
 403 $(COREAPI_PACKAGES_FILE): $(call PackageDependencies,$(CORE_PKGS))
 404         $(prep-target)
 405         $(call PackageFilter,$(CORE_PKGS))
 406 
 407 #############################################################
 408 #
 409 # docletapidocs
 410 #
 411 
 412 ALL_OTHER_TARGETS += docletapidocs
 413 
 414 DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet
 415 DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
 416 DOCLETAPI_DOCTITLE := Doclet API
 417 DOCLETAPI_WINDOWTITLE := Doclet API
 418 DOCLETAPI_HEADER := <strong>Doclet API</strong>
 419 DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
 420 DOCLETAPI_GROUPNAME := Packages
 421 DOCLETAPI_REGEXP := com.sun.javadoc
 422 # DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
 423 
 424 # The index.html, options, and packages files
 425 DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html
 426 DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options
 427 DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages
 428 
 429 docletapidocs: $(DOCLETAPI_INDEX_FILE)
 430 
 431 # Set relative location to core api document root
 432 $(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/..
 433 
 434 # Run javadoc if the index file is out of date or missing
 435 $(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
 436         $(prep-javadoc)
 437         $(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE))
 438         $(JAVADOC_CMD_SMALL) -d $(@D) \
 439             @$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE)
 440 
 441 # Create file with javadoc options in it


 445           $(call COMMON_JAVADOCTAGS) ; \
 446           $(call OptionOnly,-Xdoclint:all) ; \
 447           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
 448           $(call OptionPair,-encoding,ascii) ; \
 449           $(call OptionOnly,-breakiterator) ; \
 450           $(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \
 451           $(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
 452           $(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \
 453           $(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
 454           $(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \
 455           $(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
 456         ) >> $@
 457 
 458 # Create a file with the package names in it
 459 $(DOCLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(DOCLETAPI_PKGS))
 460         $(prep-target)
 461         $(call PackageFilter,$(DOCLETAPI_PKGS))
 462 
 463 #############################################################
 464 #

























































 465 # tagletapidocs
 466 #
 467 
 468 ALL_OTHER_TARGETS += tagletapidocs
 469 TAGLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/taglet
 470 TAGLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
 471 TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR))
 472 # TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk
 473 
 474 # Temporary directory (special generation rules)
 475 TAGLETAPI_TEMPDIR = $(DOCSTMPDIR)/taglets_temp
 476 
 477 # The index.html, options, and packages files
 478 TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/com/sun/tools/doclets/Taglet.html
 479 TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options
 480 TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages
 481 
 482 tagletapidocs: $(TAGLETAPI_INDEX_FILE)
 483 
 484 # Set relative location to core api document root
 485 $(TAGLETAPI_INDEX_FILE): GET2DOCSDIR=$(TAGLETAPI2COREAPI)/..
 486 
 487 # Run javadoc if the index file is out of date or missing
 488 $(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
 489         $(prep-javadoc)
 490         $(RM) -r $(TAGLETAPI_TEMPDIR)




 401 
 402 # Create a file with the package names in it
 403 $(COREAPI_PACKAGES_FILE): $(call PackageDependencies,$(CORE_PKGS))
 404         $(prep-target)
 405         $(call PackageFilter,$(CORE_PKGS))
 406 
 407 #############################################################
 408 #
 409 # docletapidocs
 410 #
 411 
 412 ALL_OTHER_TARGETS += docletapidocs
 413 
 414 DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet
 415 DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
 416 DOCLETAPI_DOCTITLE := Doclet API
 417 DOCLETAPI_WINDOWTITLE := Doclet API
 418 DOCLETAPI_HEADER := <strong>Doclet API</strong>
 419 DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
 420 DOCLETAPI_GROUPNAME := Packages
 421 DOCLETAPI_REGEXP := jdk.javadoc.doclet.*
 422 # DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
 423 
 424 # The index.html, options, and packages files
 425 DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html
 426 DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options
 427 DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages
 428 
 429 docletapidocs: $(DOCLETAPI_INDEX_FILE)
 430 
 431 # Set relative location to core api document root
 432 $(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/..
 433 
 434 # Run javadoc if the index file is out of date or missing
 435 $(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
 436         $(prep-javadoc)
 437         $(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE))
 438         $(JAVADOC_CMD_SMALL) -d $(@D) \
 439             @$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE)
 440 
 441 # Create file with javadoc options in it


 445           $(call COMMON_JAVADOCTAGS) ; \
 446           $(call OptionOnly,-Xdoclint:all) ; \
 447           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
 448           $(call OptionPair,-encoding,ascii) ; \
 449           $(call OptionOnly,-breakiterator) ; \
 450           $(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \
 451           $(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
 452           $(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \
 453           $(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
 454           $(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \
 455           $(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
 456         ) >> $@
 457 
 458 # Create a file with the package names in it
 459 $(DOCLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(DOCLETAPI_PKGS))
 460         $(prep-target)
 461         $(call PackageFilter,$(DOCLETAPI_PKGS))
 462 
 463 #############################################################
 464 #
 465 # old docletapidocs
 466 #
 467 
 468 ALL_OTHER_TARGETS += olddocletapidocs
 469 
 470 OLD_DOCLET_DIR := $(JDK_API_DOCSDIR)/javadoc/old
 471 OLD_DOCLETAPI_DOCDIR := $(OLD_DOCLET_DIR)/doclet
 472 OLD_DOCLETAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
 473 OLD_DOCLETAPI_DOCTITLE := Doclet API
 474 OLD_DOCLETAPI_WINDOWTITLE := Doclet API
 475 OLD_DOCLETAPI_HEADER := <strong>Doclet API</strong>
 476 OLD_DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
 477 OLD_DOCLETAPI_GROUPNAME := Packages
 478 OLD_DOCLETAPI_REGEXP := com.sun.javadoc
 479 # OLD_DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
 480 
 481 # The index.html, options, and packages files
 482 OLD_DOCLETAPI_INDEX_FILE = $(OLD_DOCLETAPI_DOCDIR)/index.html
 483 OLD_DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/old-docletapi.options
 484 OLD_DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/old-docletapi.packages
 485 
 486 olddocletapidocs: $(OLD_DOCLETAPI_INDEX_FILE)
 487 
 488 # Set relative location to core api document root
 489 $(OLD_DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(OLD_DOCLETAPI2COREAPI)/..
 490 
 491 # Run javadoc if the index file is out of date or missing
 492 $(OLD_DOCLETAPI_INDEX_FILE): $(OLD_DOCLETAPI_OPTIONS_FILE) $(OLD_DOCLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
 493         $(prep-javadoc)
 494         $(call JavadocSummary,$(OLD_DOCLETAPI_OPTIONS_FILE),$(OLD_DOCLETAPI_PACKAGES_FILE))
 495         $(JAVADOC_CMD_SMALL) -d $(@D) \
 496             @$(OLD_DOCLETAPI_OPTIONS_FILE) @$(OLD_DOCLETAPI_PACKAGES_FILE)
 497 
 498 # Create file with javadoc options in it
 499 $(OLD_DOCLETAPI_OPTIONS_FILE):
 500         $(prep-target)
 501         @($(call COMMON_JAVADOCFLAGS) ; \
 502           $(call COMMON_JAVADOCTAGS) ; \
 503           $(call OptionOnly,-Xdoclint:all) ; \
 504           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH)) ; \
 505           $(call OptionPair,-encoding,ascii) ; \
 506           $(call OptionOnly,-breakiterator) ; \
 507           $(call OptionPair,-doctitle,$(OLD_DOCLETAPI_DOCTITLE)) ; \
 508           $(call OptionPair,-windowtitle,$(OLD_DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
 509           $(call OptionPair,-header,$(OLD_DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \
 510           $(call OptionPair,-bottom,$(OLD_DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
 511           $(call OptionTrip,-group,$(OLD_DOCLETAPI_GROUPNAME),$(OLD_DOCLETAPI_REGEXP)); \
 512           $(call OptionTrip,-linkoffline,$(OLD_DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
 513         ) >> $@
 514 
 515 # Create a file with the package names in it
 516 $(OLD_DOCLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(OLD_DOCLETAPI_PKGS))
 517         $(prep-target)
 518         $(call PackageFilter,$(OLD_DOCLETAPI_PKGS))
 519 
 520 #############################################################
 521 #
 522 # tagletapidocs
 523 #
 524 
 525 ALL_OTHER_TARGETS += tagletapidocs
 526 TAGLETAPI_DOCDIR := $(OLD_DOCLET_DIR)/taglet
 527 TAGLETAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
 528 TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR))
 529 # TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk
 530 
 531 # Temporary directory (special generation rules)
 532 TAGLETAPI_TEMPDIR = $(DOCSTMPDIR)/taglets_temp
 533 
 534 # The index.html, options, and packages files
 535 TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/com/sun/tools/doclets/Taglet.html
 536 TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options
 537 TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages
 538 
 539 tagletapidocs: $(TAGLETAPI_INDEX_FILE)
 540 
 541 # Set relative location to core api document root
 542 $(TAGLETAPI_INDEX_FILE): GET2DOCSDIR=$(TAGLETAPI2COREAPI)/..
 543 
 544 # Run javadoc if the index file is out of date or missing
 545 $(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
 546         $(prep-javadoc)
 547         $(RM) -r $(TAGLETAPI_TEMPDIR)


< prev index next >