make/docs/Makefile

Print this page


   1 # Copyright (c) 1997, 2011, 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


 338           $(call OptionPair,-tag,spec:X)                                ; \
 339           $(call OptionPair,-tag,specdefault:X)                         ; \
 340           $(call OptionPair,-tag,Note:X)                                ; \
 341           $(call OptionPair,-tag,ToDo:X)                                ; \
 342           $(call OptionPair,-tag,$(TAG_JLS))                            ; \
 343           $(call OptionOnly,-splitIndex)                                ; \
 344           $(call OptionPair,-overview,$(COREAPI_OVERVIEW))              ; \
 345           $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE))              ; \
 346           $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ;\
 347           $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER))   ; \
 348           $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM))   ; \
 349         ) >> $@
 350 ifdef COREAPI_TOP_EARLYACCESS
 351         @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@
 352 endif
 353 
 354 # Create a file with the package names in it
 355 $(COREAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(CORE_PKGS))
 356         $(prep-target)
 357         $(call PackageFilter,$(CORE_PKGS))
 358 
 359 #############################################################
 360 #
 361 # mirrordocs
 362 #
 363 
 364 # Part of langtools
 365 ifdef LANGTOOLS_DIST
 366   ALL_OTHER_TARGETS += mirrordocs
 367 endif
 368 
 369 MIRROR_DOCDIR      := $(JDK_API_DOCSDIR)/apt/mirror
 370 MIRROR2COREAPI     := ../../$(JDKJRE2COREAPI)
 371 MIRROR_DOCTITLE    := Mirror API
 372 MIRROR_WINDOWTITLE := Mirror API
 373 MIRROR_HEADER      := <strong>Mirror API</strong>
 374 MIRROR_BOTTOM      := $(call CommonBottom,$(MIRROR_FIRST_COPYRIGHT_YEAR))
 375 MIRROR_GROUPNAME   := Packages
 376 MIRROR_OVERVIEW    := $(IMPORTSRCDIR)/com/sun/mirror/overview.html
 377 MIRROR_REGEXP      := com.sun.mirror.*
 378 # MIRROR_PKGS is located in NON_CORE_PKGS.gmk
 379 
 380 # The index.html, options, and packages files
 381 MIRROR_INDEX_FILE    = $(MIRROR_DOCDIR)/index.html
 382 MIRROR_OPTIONS_FILE  = $(DOCSTMPDIR)/mirror.options
 383 MIRROR_PACKAGES_FILE = $(DOCSTMPDIR)/mirror.packages
 384 
 385 mirrordocs: $(MIRROR_INDEX_FILE)
 386 
 387 # Set relative location to core api document root
 388 $(MIRROR_INDEX_FILE): GET2DOCSDIR=$(MIRROR2COREAPI)/..
 389 
 390 # Run javadoc if the index file is out of date or missing
 391 $(MIRROR_INDEX_FILE): $(MIRROR_OPTIONS_FILE) $(MIRROR_PACKAGES_FILE)
 392         $(prep-javadoc)
 393         $(call JavadocSummary,$(MIRROR_OPTIONS_FILE),$(MIRROR_PACKAGES_FILE))
 394         $(JAVADOC_CMD) $(JAVADOC_VM_MEMORY_FLAGS) -d $(@D) \
 395           @$(MIRROR_OPTIONS_FILE) @$(MIRROR_PACKAGES_FILE)
 396 
 397 # Create file with javadoc options in it
 398 $(MIRROR_OPTIONS_FILE): $(MIRROR_OVERVIEW)
 399         $(prep-target)
 400         @($(call OptionOnly,$(COMMON_JAVADOCFLAGS))                     ; \
 401           $(call OptionPair,-sourcepath,$(RELEASEDOCS_SOURCEPATH))      ; \
 402           $(call OptionPair,-encoding,ascii)                            ; \
 403           $(call OptionPair,-overview,$(MIRROR_OVERVIEW))               ; \
 404           $(call OptionPair,-doctitle,$(MIRROR_DOCTITLE))               ; \
 405           $(call OptionPair,-windowtitle,$(MIRROR_WINDOWTITLE) $(DRAFT_WINTITLE));\
 406           $(call OptionPair,-header,$(MIRROR_HEADER)$(DRAFT_HEADER))    ; \
 407           $(call OptionPair,-bottom,$(MIRROR_BOTTOM)$(DRAFT_BOTTOM))    ; \
 408           $(call OptionTrip,-group,$(MIRROR_GROUPNAME),$(MIRROR_REGEXP)); \
 409           $(call OptionTrip,-linkoffline,$(MIRROR2COREAPI),$(COREAPI_DOCSDIR)); \
 410         ) >> $@
 411 
 412 # Create a file with the package names in it
 413 $(MIRROR_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(MIRROR_PKGS))
 414         $(prep-target)
 415         $(call PackageFilter,$(MIRROR_PKGS))
 416 
 417 #############################################################
 418 #
 419 # docletapidocs
 420 #
 421 
 422 # Part of langtools
 423 ifdef LANGTOOLS_DIST
 424   ALL_OTHER_TARGETS += docletapidocs
 425 endif
 426 
 427 DOCLETAPI_DOCDIR       := $(JDK_API_DOCSDIR)/javadoc/doclet
 428 DOCLETAPI2COREAPI      := ../../$(JDKJRE2COREAPI)
 429 DOCLETAPI_DOCTITLE     := Doclet API
 430 DOCLETAPI_WINDOWTITLE  := Doclet API
 431 DOCLETAPI_HEADER       := <strong>Doclet API</strong>
 432 DOCLETAPI_BOTTOM       := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
 433 DOCLETAPI_GROUPNAME    := Packages
 434 DOCLETAPI_REGEXP       := com.sun.javadoc
 435 # DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk


   1 # Copyright (c) 1997, 2012, 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


 338           $(call OptionPair,-tag,spec:X)                                ; \
 339           $(call OptionPair,-tag,specdefault:X)                         ; \
 340           $(call OptionPair,-tag,Note:X)                                ; \
 341           $(call OptionPair,-tag,ToDo:X)                                ; \
 342           $(call OptionPair,-tag,$(TAG_JLS))                            ; \
 343           $(call OptionOnly,-splitIndex)                                ; \
 344           $(call OptionPair,-overview,$(COREAPI_OVERVIEW))              ; \
 345           $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE))              ; \
 346           $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ;\
 347           $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER))   ; \
 348           $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM))   ; \
 349         ) >> $@
 350 ifdef COREAPI_TOP_EARLYACCESS
 351         @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@
 352 endif
 353 
 354 # Create a file with the package names in it
 355 $(COREAPI_PACKAGES_FILE): $(DIRECTORY_CACHE) $(call PackageDependencies,$(CORE_PKGS))
 356         $(prep-target)
 357         $(call PackageFilter,$(CORE_PKGS))


























































 358 
 359 #############################################################
 360 #
 361 # docletapidocs
 362 #
 363 
 364 # Part of langtools
 365 ifdef LANGTOOLS_DIST
 366   ALL_OTHER_TARGETS += docletapidocs
 367 endif
 368 
 369 DOCLETAPI_DOCDIR       := $(JDK_API_DOCSDIR)/javadoc/doclet
 370 DOCLETAPI2COREAPI      := ../../$(JDKJRE2COREAPI)
 371 DOCLETAPI_DOCTITLE     := Doclet API
 372 DOCLETAPI_WINDOWTITLE  := Doclet API
 373 DOCLETAPI_HEADER       := <strong>Doclet API</strong>
 374 DOCLETAPI_BOTTOM       := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
 375 DOCLETAPI_GROUPNAME    := Packages
 376 DOCLETAPI_REGEXP       := com.sun.javadoc
 377 # DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk