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