make/docs/Makefile

Print this page




 307 
 308 HTTPSERVER_SOURCEPATH  = $(TOPDIR)/src/share/classes
 309 HTTPSERVER_DOCDIR        = $(DOCSDIR)/jre/api/net/httpserver/spec
 310 
 311 HTTPSERVER_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS)                        \
 312                    -encoding ascii                              \
 313                    -nodeprecatedlist                            \
 314                    -d $(HTTPSERVER_DOCDIR)                              \
 315                    -sourcepath $(HTTPSERVER_SOURCEPATH)               \
 316                    -windowtitle $(HTTPSERVER_WINDOWTITLE)             \
 317                    -doctitle $(HTTPSERVER_DOCTITLE)                   \
 318                    -header $(HTTPSERVER_JAVADOCHEADER)                \
 319                    -linkoffline ../../../../../api $(DOCSDIR)/api/
 320 
 321 HTTPSERVER_WINDOWTITLE = "Java HTTP Server"
 322 HTTPSERVER_DOCTITLE    = "Java$(TRADEMARK) HTTP Server"
 323 HTTPSERVER_JAVADOCHEADER      = "Java HTTP Server"
 324 # HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk
 325 
 326 #






















 327 # Variables used by jvmti target
 328 #
 329 JVMTI_DOCS_SUBDIR = platform/jvmti
 330 JVMTI_HTML        = $(HOTSPOT_DOCS_IMPORT_PATH)/$(JVMTI_DOCS_SUBDIR)/jvmti.html
 331 
 332 #
 333 # Variables used by mgmt target
 334 #
 335 MGMT_DOCDIR        = $(DOCSDIR)/jre/api/management/
 336 MGMT_EXT_DIR       = $(MGMT_DOCDIR)/extension
 337 MGMT_SOURCEPATH    = $(TOPDIR)/src/share/classes
 338 JVM_MIB_NAME       = JVM-MANAGEMENT-MIB.mib
 339 JVM_MIB_SRC        = $(CLOSED_SRC)/share/classes/sun/management/snmp/$(JVM_MIB_NAME)
 340 
 341 ifdef OPENJDK
 342    COPY-MIB-TARGET =
 343 else
 344    COPY-MIB-TARGET = copy-mib
 345 endif
 346 MGMT_JAVADOCFLAGS  = $(COMMON_JAVADOCFLAGS)                        \


 434 include CORE_PKGS.gmk
 435 
 436 #
 437 # Load environment variables for API package names that are not part of
 438 # the Java SE platform
 439 #
 440 include NON_CORE_PKGS.gmk
 441 
 442 # Targets for all APIs other than the core platform APIs
 443 ALL_OTHER_TARGETS = \
 444     mirrordocs \
 445     docletapidocs \
 446     tagletapidocs \
 447     domapidocs \
 448     jpdadocs \
 449     jaasdocs \
 450     jgssdocs \
 451     smartcardiodocs \
 452     tracingdocs \
 453     httpserverdocs  \

 454     mgmtdocs \
 455     attachdocs \
 456     jconsoledocs \
 457     treeapidocs
 458 
 459 .PHONY: all docs
 460 all docs: coredocs otherdocs
 461 
 462 .PHONY: otherdocs
 463 otherdocs: ${ALL_OTHER_TARGETS}
 464 
 465 
 466 #################################################################
 467 # Production Targets -- USE THESE TARGETS WHEN:
 468 #    a) You're generating docs outside of release engineering's
 469 #       standard control build.
 470 #    b) The docs will be pushed to the web and/or included in
 471 #       the downloaded doc bundle.
 472 #
 473 # See:  Notes.html#releaseTargets


 614         $(MKDIR) -p $(SMARTCARDIO_DOCDIR)
 615         $(JAVADOC_CMD) $(SMARTCARDIO_JAVADOCFLAGS)                     \
 616                    $(SMARTCARDIO_PKGS)
 617 
 618 .PHONY: tracingdocs
 619 tracingdocs:
 620         @# ######## api-tracing ############################
 621         $(RM) -r $(TRACING_DOCDIR)
 622         $(MKDIR) -p $(TRACING_DOCDIR)
 623         $(JAVADOC) $(TRACING_JAVADOCFLAGS)                     \
 624                    $(TRACING_PKGS)
 625 
 626 .PHONY: httpserverdocs
 627 httpserverdocs:
 628         @# ######## api-httpserver #######################
 629         $(RM) -r $(HTTPSERVER_DOCDIR)
 630         $(MKDIR) -p $(HTTPSERVER_DOCDIR)
 631         $(JAVADOC_CMD) $(HTTPSERVER_JAVADOCFLAGS)                     \
 632                    $(HTTPSERVER_PKGS)
 633 








 634 .PHONY: mgmtdocs
 635 mgmtdocs: $(COPY-MIB-TARGET)
 636         @# ######## api-management ############################
 637         $(RM) -r $(MGMT_EXT_DIR)
 638         $(MKDIR) -p $(MGMT_EXT_DIR)
 639         $(JAVADOC_CMD) $(MGMT_JAVADOCFLAGS)                     \
 640                    $(MGMT_PKGS)
 641 
 642 copy-mib:
 643         @# ######## copy-snmp-mib ############################
 644         $(RM) $(MGMT_DOCDIR)/$(JVM_MIB_NAME)
 645         $(MKDIR) -p $(MGMT_DOCDIR)
 646         $(CP) $(JVM_MIB_SRC) $(MGMT_DOCDIR)
 647 
 648 .PHONY: attachdocs
 649 attachdocs:
 650         @# ######## api-attach ############################
 651         $(RM) -r $(ATTACH_DOCDIR)
 652         $(MKDIR) -p $(ATTACH_DOCDIR)
 653         $(JAVADOC_CMD) $(ATTACH_JAVADOCFLAGS)                     \




 307 
 308 HTTPSERVER_SOURCEPATH  = $(TOPDIR)/src/share/classes
 309 HTTPSERVER_DOCDIR        = $(DOCSDIR)/jre/api/net/httpserver/spec
 310 
 311 HTTPSERVER_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS)                        \
 312                    -encoding ascii                              \
 313                    -nodeprecatedlist                            \
 314                    -d $(HTTPSERVER_DOCDIR)                              \
 315                    -sourcepath $(HTTPSERVER_SOURCEPATH)               \
 316                    -windowtitle $(HTTPSERVER_WINDOWTITLE)             \
 317                    -doctitle $(HTTPSERVER_DOCTITLE)                   \
 318                    -header $(HTTPSERVER_JAVADOCHEADER)                \
 319                    -linkoffline ../../../../../api $(DOCSDIR)/api/
 320 
 321 HTTPSERVER_WINDOWTITLE = "Java HTTP Server"
 322 HTTPSERVER_DOCTITLE    = "Java$(TRADEMARK) HTTP Server"
 323 HTTPSERVER_JAVADOCHEADER      = "Java HTTP Server"
 324 # HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk
 325 
 326 #
 327 # Variables used by sctp target
 328 #
 329 
 330 SCTPAPI_SOURCEPATH  = $(TOPDIR)/src/share/classes
 331 SCTPAPI_DOCDIR   = $(DOCSDIR)/jre/api/nio/sctp/spec
 332 
 333 SCTPAPI_JAVADOCFLAGS = $(COMMON_JAVADOCFLAGS)                           \
 334                    -encoding ascii                                      \
 335                    -nodeprecatedlist                                    \
 336                    -d $(SCTPAPI_DOCDIR)                                 \
 337                    -sourcepath $(SCTPAPI_SOURCEPATH)                    \
 338                    -windowtitle $(SCTPAPI_WINDOWTITLE)                  \
 339                    -doctitle $(SCTPAPI_DOCTITLE)                        \
 340                    -header $(SCTPAPI_JAVADOCHEADER)                     \
 341                    -linkoffline ../../../../../api $(DOCSDIR)/api/
 342 
 343 SCTPAPI_WINDOWTITLE = "SCTP API"
 344 SCTPAPI_DOCTITLE    = "SCTP API"
 345 SCTPAPI_JAVADOCHEADER      = "SCTP API"
 346 # SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk
 347 
 348 #
 349 # Variables used by jvmti target
 350 #
 351 JVMTI_DOCS_SUBDIR = platform/jvmti
 352 JVMTI_HTML        = $(HOTSPOT_DOCS_IMPORT_PATH)/$(JVMTI_DOCS_SUBDIR)/jvmti.html
 353 
 354 #
 355 # Variables used by mgmt target
 356 #
 357 MGMT_DOCDIR        = $(DOCSDIR)/jre/api/management/
 358 MGMT_EXT_DIR       = $(MGMT_DOCDIR)/extension
 359 MGMT_SOURCEPATH    = $(TOPDIR)/src/share/classes
 360 JVM_MIB_NAME       = JVM-MANAGEMENT-MIB.mib
 361 JVM_MIB_SRC        = $(CLOSED_SRC)/share/classes/sun/management/snmp/$(JVM_MIB_NAME)
 362 
 363 ifdef OPENJDK
 364    COPY-MIB-TARGET =
 365 else
 366    COPY-MIB-TARGET = copy-mib
 367 endif
 368 MGMT_JAVADOCFLAGS  = $(COMMON_JAVADOCFLAGS)                        \


 456 include CORE_PKGS.gmk
 457 
 458 #
 459 # Load environment variables for API package names that are not part of
 460 # the Java SE platform
 461 #
 462 include NON_CORE_PKGS.gmk
 463 
 464 # Targets for all APIs other than the core platform APIs
 465 ALL_OTHER_TARGETS = \
 466     mirrordocs \
 467     docletapidocs \
 468     tagletapidocs \
 469     domapidocs \
 470     jpdadocs \
 471     jaasdocs \
 472     jgssdocs \
 473     smartcardiodocs \
 474     tracingdocs \
 475     httpserverdocs  \
 476     sctpdocs \
 477     mgmtdocs \
 478     attachdocs \
 479     jconsoledocs \
 480     treeapidocs
 481 
 482 .PHONY: all docs
 483 all docs: coredocs otherdocs
 484 
 485 .PHONY: otherdocs
 486 otherdocs: ${ALL_OTHER_TARGETS}
 487 
 488 
 489 #################################################################
 490 # Production Targets -- USE THESE TARGETS WHEN:
 491 #    a) You're generating docs outside of release engineering's
 492 #       standard control build.
 493 #    b) The docs will be pushed to the web and/or included in
 494 #       the downloaded doc bundle.
 495 #
 496 # See:  Notes.html#releaseTargets


 637         $(MKDIR) -p $(SMARTCARDIO_DOCDIR)
 638         $(JAVADOC_CMD) $(SMARTCARDIO_JAVADOCFLAGS)                     \
 639                    $(SMARTCARDIO_PKGS)
 640 
 641 .PHONY: tracingdocs
 642 tracingdocs:
 643         @# ######## api-tracing ############################
 644         $(RM) -r $(TRACING_DOCDIR)
 645         $(MKDIR) -p $(TRACING_DOCDIR)
 646         $(JAVADOC) $(TRACING_JAVADOCFLAGS)                     \
 647                    $(TRACING_PKGS)
 648 
 649 .PHONY: httpserverdocs
 650 httpserverdocs:
 651         @# ######## api-httpserver #######################
 652         $(RM) -r $(HTTPSERVER_DOCDIR)
 653         $(MKDIR) -p $(HTTPSERVER_DOCDIR)
 654         $(JAVADOC_CMD) $(HTTPSERVER_JAVADOCFLAGS)                     \
 655                    $(HTTPSERVER_PKGS)
 656 
 657 .PHONY: sctpdocs
 658 sctpdocs:
 659         @# ######## api-sctp #######################
 660         $(RM) -r $(SCTPAPI_DOCDIR)
 661         $(MKDIR) -p $(SCTPAPI_DOCDIR)
 662         $(JAVADOC_CMD) $(SCTPAPI_JAVADOCFLAGS)                     \
 663                 $(SCTPAPI_PKGS)
 664 
 665 .PHONY: mgmtdocs
 666 mgmtdocs: $(COPY-MIB-TARGET)
 667         @# ######## api-management ############################
 668         $(RM) -r $(MGMT_EXT_DIR)
 669         $(MKDIR) -p $(MGMT_EXT_DIR)
 670         $(JAVADOC_CMD) $(MGMT_JAVADOCFLAGS)                     \
 671                    $(MGMT_PKGS)
 672 
 673 copy-mib:
 674         @# ######## copy-snmp-mib ############################
 675         $(RM) $(MGMT_DOCDIR)/$(JVM_MIB_NAME)
 676         $(MKDIR) -p $(MGMT_DOCDIR)
 677         $(CP) $(JVM_MIB_SRC) $(MGMT_DOCDIR)
 678 
 679 .PHONY: attachdocs
 680 attachdocs:
 681         @# ######## api-attach ############################
 682         $(RM) -r $(ATTACH_DOCDIR)
 683         $(MKDIR) -p $(ATTACH_DOCDIR)
 684         $(JAVADOC_CMD) $(ATTACH_JAVADOCFLAGS)                     \