make/Javadoc.gmk
author neugens
Fri, 15 Apr 2016 14:57:53 +0200
changeset 37034 b63fd4af003e
parent 36792 09d2e1165981
child 37650 ef6c24163cb2
permissions -rw-r--r--
8154313: Generated javadoc scattered all over the place Summary: Added new top level target zip-docs which scans all generated javadocs and prepare zip-archive in way understandable to most IDEs Reviewed-by: erikj Contributed-by: Jiri Vanek <jvanek@redhat.com>
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
     1
# Copyright (c) 1997, 2016, Oracle and/or its affiliates. All rights reserved.
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
     2
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
     3
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
     4
# This code is free software; you can redistribute it and/or modify it
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
     5
# under the terms of the GNU General Public License version 2 only, as
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
     6
# published by the Free Software Foundation.  Oracle designates this
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
     7
# particular file as subject to the "Classpath" exception as provided
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
     8
# by Oracle in the LICENSE file that accompanied this code.
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
     9
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    10
# This code is distributed in the hope that it will be useful, but WITHOUT
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    11
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    12
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    13
# version 2 for more details (a copy is included in the LICENSE file that
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    14
# accompanied this code).
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    15
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    16
# You should have received a copy of the GNU General Public License version
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    17
# 2 along with this work; if not, write to the Free Software Foundation,
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    18
# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    19
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    20
# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    21
# or visit www.oracle.com if you need additional information or have any
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    22
# questions.
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    23
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    24
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    25
include $(SPEC)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    26
include MakeBase.gmk
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    27
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
    28
#################################################################
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
    29
#
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
    30
# CORE_PKGS environment variable has been moved to the following file
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
    31
#
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
    32
include CORE_PKGS.gmk
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
    33
#
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
    34
# Load environment variables for API package names that are not part of
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
    35
# the Java SE platform
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
    36
#
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
    37
include NON_CORE_PKGS.gmk
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
    38
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
    39
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    40
.SUFFIXES: # Delete the default suffixes
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    41
.SUFFIXES: .java
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    42
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    43
#
25854
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
    44
# Definitions for directories
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    45
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    46
27560
adc258b13e2c 8049367: Modular Run-Time Images
chegar
parents: 27328
diff changeset
    47
DOCSDIR := $(IMAGES_OUTPUTDIR)/docs
adc258b13e2c 8049367: Modular Run-Time Images
chegar
parents: 27328
diff changeset
    48
DOCSTMPDIR = $(SUPPORT_OUTPUTDIR)/docs
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    49
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    50
HOTSPOT_DOCS_IMPORT_PATH=$(HOTSPOT_OUTPUTDIR)/docs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    51
15393
e3761cf4e010 8006872: Stop creating four jars with identical content in the new build system.
ohrstrom
parents: 15172
diff changeset
    52
JAVADOC_CMD = $(JAVA) \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    53
    -Djava.awt.headless=true \
28010
2d111f17cbb4 8067829: Remove setting -bootclasspath $(JDK_OUTPUTDIR)/classes from Javadoc.gmk
mchung
parents: 28007
diff changeset
    54
    $(NEW_JAVADOC)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    55
29176
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
    56
JAVADOC_CMD_SMALL = $(JAVA_SMALL) \
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
    57
    -Djava.awt.headless=true \
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
    58
    $(NEW_JAVADOC)
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
    59
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    60
# Copyright year for beginning of Java and some of the apis
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    61
# (Needed when creating the javadocs)
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    62
FIRST_COPYRIGHT_YEAR = 1993
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    63
DOMAPI_FIRST_COPYRIGHT_YEAR = 2005
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    64
MIRROR_FIRST_COPYRIGHT_YEAR = 2004
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    65
DOCLETAPI_FIRST_COPYRIGHT_YEAR = 1993
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    66
TAGLETAPI_FIRST_COPYRIGHT_YEAR = 1993
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    67
JDI_FIRST_COPYRIGHT_YEAR = 1999
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    68
JAAS_FIRST_COPYRIGHT_YEAR = 1998
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    69
JGSS_FIRST_COPYRIGHT_YEAR = 2000
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    70
SMARTCARDIO_FIRST_COPYRIGHT_YEAR = 2005
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    71
HTTPSERVER_FIRST_COPYRIGHT_YEAR = 2005
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    72
MGMT_FIRST_COPYRIGHT_YEAR = 2003
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    73
ATTACH_FIRST_COPYRIGHT_YEAR = 2005
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    74
JCONSOLE_FIRST_COPYRIGHT_YEAR = 2006
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    75
SCTPAPI_FIRST_COPYRIGHT_YEAR = 2009
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    76
TRACING_FIRST_COPYRIGHT_YEAR = 2008
36792
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
    77
JSHELLAPI_FIRST_COPYRIGHT_YEAR = 2015
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    78
TREEAPI_FIRST_COPYRIGHT_YEAR = 2005
27596
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
    79
NASHORNAPI_FIRST_COPYRIGHT_YEAR = 2014
35369
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
    80
DYNALINKAPI_FIRST_COPYRIGHT_YEAR = 2015
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    81
JNLP_FIRST_COPYRIGHT_YEAR = 1998
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    82
PLUGIN2_FIRST_COPYRIGHT_YEAR = 2007
23836
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
    83
JDKNET_FIRST_COPYRIGHT_YEAR = 2014
29851
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
    84
JACCESSAPI_FIRST_COPYRIGHT_YEAR = 2002
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
    85
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    86
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    87
# Oracle name
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    88
FULL_COMPANY_NAME = Oracle and/or its affiliates
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    89
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    90
# Copyright address
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    91
COMPANY_ADDRESS = 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA.
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    92
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    93
# The trademark symbol
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    94
TRADEMARK = &trade;
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    95
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    96
# Common copyright lines used
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    97
# The word "Copyright" might optionally be a link to the file cpyr.html.
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    98
# The first year of copyright may vary or not be available.
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
    99
# The address to the company might be optional.
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   100
COMMA:= ,
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   101
EMPTY:=
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   102
SPACE:=$(EMPTY) $(EMPTY)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   103
COPYRIGHT_SYMBOL = &\#x00a9;
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   104
# Macro to construct the copyright line
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   105
# (The GNU make 3.78.1 "if" conditional is broken, fixed in GNU make 3.81)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   106
define CopyrightLine # optionalurl optionalfirstyear optionaladdress
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   107
$(if $(strip $1),<a href="$(strip $1)">Copyright</a>,Copyright) \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   108
$(COPYRIGHT_SYMBOL) $(if $2,$2${COMMA},) $(COPYRIGHT_YEAR),\
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   109
$(FULL_COMPANY_NAME). $3 All rights reserved.
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   110
endef
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   111
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   112
# Url to root of documents
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   113
DOCSDIR_URL = {@docroot}/$(GET2DOCSDIR)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   114
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   115
# Url to copyright html file
24232
ddfae175a8d2 8042348: Copyright link in Javadoc page for Java SE 8
erikj
parents: 23986
diff changeset
   116
COPYRIGHT_URL = $(DOCSDIR_URL)/legal/cpyr.html
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   117
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   118
# Url to bug filing site
25043
b5598c2ddf6f 8048302: Update bug reporting URL in make/Javadoc.gmk
darcy
parents: 24232
diff changeset
   119
BUG_SUBMIT_URL = http://bugreport.java.com/bugreport/
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   120
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   121
# Common line for how to submit a bug or rfe
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   122
BUG_SUBMIT_LINE = <a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a>
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   123
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   124
# Url to devdocs page
33926
3a19edba4808 8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents: 30416
diff changeset
   125
DOCS_BASE_URL = http://docs.oracle.com/javase/$(VERSION_SPECIFICATION)/docs
3a19edba4808 8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents: 30416
diff changeset
   126
DEV_DOCS_URL = $(DOCS_BASE_URL)/index.html
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   127
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   128
# Common Java trademark line
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   129
JAVA_TRADEMARK_LINE = Java is a trademark or registered trademark of \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   130
$(FULL_COMPANY_NAME) in the US and other countries.
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   131
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   132
#################################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   133
# Macros:
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   134
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   135
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   136
# List of all possible directories for javadoc to look for sources
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   137
# NOTE: Quotes are required around sourcepath argument only on Windows.
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   138
# Otherwise, you get "No packages or classes specified." due
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   139
# to $(PATH_SEP) being interpreted as an end of
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   140
# command (newline or shell ; character)
25854
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
   141
ALL_SOURCE_DIRS := $(wildcard \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   142
      $(SUPPORT_OUTPUTDIR)/gensrc/j* \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   143
      $(if $(IMPORT_MODULES_SRC), $(IMPORT_MODULES_SRC)/*) \
27586
e7cfdc266a70 8058631: Rename posix to unix in build system to match file name changes
ihse
parents: 27328
diff changeset
   144
      $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS)/classes \
e7cfdc266a70 8058631: Rename posix to unix in build system to match file name changes
ihse
parents: 27328
diff changeset
   145
      $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS_TYPE)/classes \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   146
      $(JDK_TOPDIR)/src/*/share/classes \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   147
      $(HOTSPOT_TOPDIR)/src/*/share/classes \
25854
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
   148
      $(LANGTOOLS_TOPDIR)/src/*/share/classes \
27596
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
   149
      $(NASHORN_TOPDIR)/src/*/share/classes \
25854
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
   150
      $(CORBA_TOPDIR)/src/*/share/classes \
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
   151
      $(JAXP_TOPDIR)/src/*/share/classes \
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
   152
      $(JAXWS_TOPDIR)/src/*/share/classes \
27560
adc258b13e2c 8049367: Modular Run-Time Images
chegar
parents: 27328
diff changeset
   153
      $(SUPPORT_OUTPUTDIR)/rmic/j* \
25854
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
   154
      $(JDK_TOPDIR)/src/*/share/doc/stub \
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
   155
      ) \
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
   156
      #
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   157
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   158
ALL_MODULE_SOURCE_DIRS := \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   159
      $(SUPPORT_OUTPUTDIR)/gensrc/* \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   160
      $(if $(IMPORT_MODULES_SRC), $(IMPORT_MODULES_SRC)/*) \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   161
      $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS)/classes \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   162
      $(JDK_TOPDIR)/src/*/$(OPENJDK_TARGET_OS_TYPE)/classes \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   163
      $(JDK_TOPDIR)/src/*/share/classes \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   164
      $(HOTSPOT_TOPDIR)/src/*/share/classes \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   165
      $(LANGTOOLS_TOPDIR)/src/*/share/classes \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   166
      $(NASHORN_TOPDIR)/src/*/share/classes \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   167
      $(CORBA_TOPDIR)/src/*/share/classes \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   168
      $(JAXP_TOPDIR)/src/*/share/classes \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   169
      $(JAXWS_TOPDIR)/src/*/share/classes \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   170
      $(SUPPORT_OUTPUTDIR)/rmic/* \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   171
      $(JDK_TOPDIR)/src/*/share/doc/stub \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   172
      #
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   173
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   174
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   175
# List with classpath separator between them
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   176
EMPTY:=
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   177
SPACE:= $(EMPTY) $(EMPTY)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   178
RELEASEDOCS_SOURCEPATH = \
15052
eed28ee0dbd6 8005548: build-infra: Fix docs target on windows
erikj
parents: 14466
diff changeset
   179
    $(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_SOURCE_DIRS)))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   180
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   181
RELEASEDOCS_MODULESOURCEPATH = \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   182
    $(subst $(SPACE),$(PATH_SEP),$(strip $(ALL_MODULE_SOURCE_DIRS)))
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   183
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   184
define prep-target
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   185
	$(MKDIR) -p $(@D)
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   186
	$(RM) $@
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   187
endef
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   188
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   189
# Prep for javadoc creation, assumes $@ is an index.html file
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   190
define prep-javadoc
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   191
	@if [ -f "$@" -a "$?" != "" ] ; then \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   192
	  $(ECHO) "# Dependencies have changed: $?"; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   193
	fi
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   194
	$(RM) -r $(@D)
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   195
	$(MKDIR) -p $(@D)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   196
endef
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   197
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   198
$(eval $(call FillCacheFind, $(ALL_SOURCE_DIRS)))
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   199
define PackageDependencies
25854
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
   200
  $(call CacheFind, $(wildcard $(foreach p, $(subst .,/,$1), $(addsuffix /$p, $(ALL_SOURCE_DIRS)))))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   201
endef
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   202
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   203
# Given a list of packages, add packages that exist to $@, print summary
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   204
define PackageFilter # packages
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   205
	@if [ "$1" != "" ] ; then \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   206
	  for p in $1 ; do \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   207
	    pd=`$(ECHO) $${p} | $(SED) -e 's@[.]@/@g'`; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   208
	    found="false"; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   209
	    for cp in $(ALL_SOURCE_DIRS) ; do \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   210
	      if [ -d $${cp}/$${pd} ] ; then \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   211
	        $(ECHO) "$${p}" >> $@; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   212
	        found="true"; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   213
	        break; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   214
	      fi; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   215
	    done; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   216
	    if [ "$${found}" = "false" ] ; then \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   217
	      $(ECHO) "WARNING: Package not found: $${p}"; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   218
	    fi; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   219
	  done; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   220
	fi
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   221
endef
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   222
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   223
# Print out a summary of the javadoc command about to be run
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   224
define JavadocSummary # optionsfile packagesfile
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   225
	@$(ECHO) "# Running javadoc for $(patsubst $(OUTPUT_ROOT)/%,%,$@)" $(LOG_WARN)
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   226
	@($(ECHO) "# Options (`$(BASENAME) $1`):"; $(SED) -e 's@^@#   @' $1) $(LOG_DEBUG)
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   227
	@($(ECHO) "# Packages (`$(BASENAME) $2`):";$(SED) -e 's@^@#   @' $2) $(LOG_DEBUG)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   228
endef
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   229
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   230
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   231
# Different api directories created from root directory
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   232
#
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   233
COREAPI_DOCSDIR = $(DOCSDIR)/api
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   234
JDK_API_DOCSDIR = $(DOCSDIR)/jdk/api
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   235
JRE_API_DOCSDIR = $(DOCSDIR)/jre/api
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   236
PLATFORM_DOCSDIR = $(DOCSDIR)/platform
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   237
37034
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
   238
JAVADOC_ARCHIVE_NAME := jdk-$(VERSION_STRING)-docs.zip
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
   239
JAVADOC_ARCHIVE_ASSEMBLY_DIR :=  $(DOCSTMPDIR)/zip-docs
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
   240
JAVADOC_ARCHIVE_DIR := $(OUTPUT_ROOT)/bundles
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
   241
JAVADOC_ARCHIVE := $(JAVADOC_ARCHIVE_DIR)/$(JAVADOC_ARCHIVE_NAME)
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
   242
35817
007e71c3b8c4 8149963: build errors during API docs build
erikj
parents: 35369
diff changeset
   243
# The core api index file is the target for the core api javadocs rule
007e71c3b8c4 8149963: build errors during API docs build
erikj
parents: 35369
diff changeset
   244
# and needs to be defined early so that all other javadoc rules may
007e71c3b8c4 8149963: build errors during API docs build
erikj
parents: 35369
diff changeset
   245
# depend on it.
007e71c3b8c4 8149963: build errors during API docs build
erikj
parents: 35369
diff changeset
   246
COREAPI_INDEX_FILE = $(COREAPI_DOCSDIR)/index.html
007e71c3b8c4 8149963: build errors during API docs build
erikj
parents: 35369
diff changeset
   247
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   248
# The non-core api javadocs need to be able to access the root of the core
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   249
# api directory, so for jdk/api or jre/api to get to the core api/
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   250
# directory we would use this:
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   251
JDKJRE2COREAPI = ../../api
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   252
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   253
# Common bottom argument
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   254
define CommonBottom # year
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   255
<font size="-1"><br> $(call CopyrightLine,,$1,)</font>
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   256
endef
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   257
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   258
# Common trademark bottom argument (Not sure why this is used sometimes)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   259
define CommonTrademarkBottom # year
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   260
<font size="-1">\
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   261
$(BUG_SUBMIT_LINE)<br>$(JAVA_TRADEMARK_LINE)<br>\
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   262
$(call CopyrightLine,,$1,$(COMPANY_ADDRESS))\
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   263
</font>
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   264
endef
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   265
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   266
# Common echo of option
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   267
define OptionOnly # opt
28007
877ab0d032b8 8066138: Trailing whitespace in title of javadoc: Overview (Java Platform SE 7 )
alundblad
parents: 27602
diff changeset
   268
	if [ "$(strip $1)" != "" ] ; then \
877ab0d032b8 8066138: Trailing whitespace in title of javadoc: Overview (Java Platform SE 7 )
alundblad
parents: 27602
diff changeset
   269
		$(PRINTF) "%s\n" "$(strip $1)"; \
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   270
	fi
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   271
endef
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   272
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   273
define OptionPair # opt arg
28007
877ab0d032b8 8066138: Trailing whitespace in title of javadoc: Overview (Java Platform SE 7 )
alundblad
parents: 27602
diff changeset
   274
	$(PRINTF) "%s '%s'\n" "$(strip $1)" '$(strip $2)'
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   275
endef
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   276
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   277
define OptionTrip # opt arg arg
28007
877ab0d032b8 8066138: Trailing whitespace in title of javadoc: Overview (Java Platform SE 7 )
alundblad
parents: 27602
diff changeset
   278
	$(PRINTF) "%s '%s' '%s'\n" "$(strip $1)" '$(strip $2)' '$(strip $3)'
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   279
endef
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   280
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   281
# Core api bottom argument (with special sauce)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   282
COREAPI_BOTTOM = <font size="-1"> $(BUG_SUBMIT_LINE)\
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   283
<br>For further API reference and developer documentation, \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   284
see <a href="$(DEV_DOCS_URL)" target="_blank">Java SE Documentation</a>. \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   285
That documentation contains more detailed, developer-targeted descriptions, \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   286
with conceptual overviews, definitions of terms, workarounds, \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   287
and working code examples.<br>\
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   288
$(call CopyrightLine,$(COPYRIGHT_URL),$(FIRST_COPYRIGHT_YEAR),)\
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   289
</font>
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   290
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   291
# Common javadoc options used by all bundles
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   292
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   293
ifdef OPENJDK
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   294
  ADDITIONAL_JAVADOCFLAGS = \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   295
      -Xdocrootparent $(DOCS_BASE_URL)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   296
else
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   297
  ADDITIONAL_JAVADOCFLAGS =
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   298
endif
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   299
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   300
define COMMON_JAVADOCFLAGS
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   301
    $(call OptionOnly,-XDignore.symbol.file=true) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   302
    $(call OptionOnly,-quiet) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   303
    $(call OptionOnly,-use) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   304
    $(call OptionOnly,-keywords) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   305
    $(call OptionOnly,$(ADDITIONAL_JAVADOCFLAGS))
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   306
endef
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   307
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   308
# Common javadoc tags used by all bundles
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   309
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   310
# Java language specification cite
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   311
TAG_JLS = jls:a:See <cite> \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   312
The Java&trade; Language Specification</cite>:
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   313
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   314
# Java virtual machine specification cite
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   315
TAG_JVMS = jvms:a:See <cite> \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   316
The Java&trade; Virtual Machine Specification</cite>:
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   317
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   318
# In order to get a specific ordering it's necessary to specify the total
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   319
# ordering of tags as the tags are otherwise ordered in order of definition.
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   320
define COMMON_JAVADOCTAGS
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   321
  $(call OptionPair,-tag,beaninfo:X) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   322
  $(call OptionPair,-tag,revised:X) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   323
  $(call OptionPair,-tag,since.unbundled:X) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   324
  $(call OptionPair,-tag,spec:X) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   325
  $(call OptionPair,-tag,specdefault:X) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   326
  $(call OptionPair,-tag,Note:X) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   327
  $(call OptionPair,-tag,ToDo:X) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   328
  $(call OptionPair,-tag,apiNote:a:API Note:) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   329
  $(call OptionPair,-tag,implSpec:a:Implementation Requirements:) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   330
  $(call OptionPair,-tag,implNote:a:Implementation Note:) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   331
  $(call OptionPair,-tag,param) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   332
  $(call OptionPair,-tag,return) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   333
  $(call OptionPair,-tag,throws) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   334
  $(call OptionPair,-tag,since) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   335
  $(call OptionPair,-tag,version) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   336
  $(call OptionPair,-tag,serialData) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   337
  $(call OptionPair,-tag,factory) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   338
  $(call OptionPair,-tag,see) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   339
  $(call OptionPair,-tag,$(TAG_JVMS)) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   340
  $(call OptionPair,-tag,$(TAG_JLS))
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   341
endef
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   342
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   343
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   344
33929
b6f2e71b26c5 8087329: Introduce VERSION_IS_GA
erikj
parents: 33926
diff changeset
   345
# Assume we need a draft format when the version string is not a GA version.
b6f2e71b26c5 8087329: Introduce VERSION_IS_GA
erikj
parents: 33926
diff changeset
   346
ifeq ($(VERSION_IS_GA), false)
33926
3a19edba4808 8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents: 30416
diff changeset
   347
  DRAFT_HEADER := <br><strong>DRAFT&nbsp;$(VERSION_STRING)</strong>
3a19edba4808 8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents: 30416
diff changeset
   348
  DRAFT_BOTTOM := <br><strong>DRAFT&nbsp;$(VERSION_STRING)</strong>
3a19edba4808 8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents: 30416
diff changeset
   349
  DRAFT_WINTITLE := $(VERSION_BUILD)
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   350
  # Early access top text (not used in FCS releases)
33926
3a19edba4808 8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents: 30416
diff changeset
   351
  COREAPI_TOP_EARLYACCESS := \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   352
<div style="background-color: \#EEEEEE"> \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   353
<div style="padding: 6px; margin-top: 2px; margin-bottom: 6px; \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   354
margin-left: 6px; margin-right: 6px; text-align: justify; \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   355
font-size: 80%; font-family: Helvetica, Arial, sans-serif; \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   356
font-weight: normal;"> \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   357
Please note that the specifications and other information \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   358
contained herein are not final and are subject to change. \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   359
The information is being made available to you solely for purpose of \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   360
evaluation. \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   361
</div> </div>
33926
3a19edba4808 8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents: 30416
diff changeset
   362
else
3a19edba4808 8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents: 30416
diff changeset
   363
  DRAFT_HEADER :=
3a19edba4808 8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents: 30416
diff changeset
   364
  DRAFT_BOTTOM :=
3a19edba4808 8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents: 30416
diff changeset
   365
  DRAFT_WINTITLE :=
3a19edba4808 8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents: 30416
diff changeset
   366
  COREAPI_TOP_EARLYACCESS :=
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   367
endif
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   368
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   369
#################################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   370
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   371
#
27328
17f2bc9cd16a 8062475: Enable hook for custom doc generation
rriggs
parents: 26119
diff changeset
   372
# Load custom Javadoc rules
17f2bc9cd16a 8062475: Enable hook for custom doc generation
rriggs
parents: 26119
diff changeset
   373
#
17f2bc9cd16a 8062475: Enable hook for custom doc generation
rriggs
parents: 26119
diff changeset
   374
17f2bc9cd16a 8062475: Enable hook for custom doc generation
rriggs
parents: 26119
diff changeset
   375
$(eval $(call IncludeCustomExtension, , Javadoc.gmk))
17f2bc9cd16a 8062475: Enable hook for custom doc generation
rriggs
parents: 26119
diff changeset
   376
17f2bc9cd16a 8062475: Enable hook for custom doc generation
rriggs
parents: 26119
diff changeset
   377
#################################################################
17f2bc9cd16a 8062475: Enable hook for custom doc generation
rriggs
parents: 26119
diff changeset
   378
17f2bc9cd16a 8062475: Enable hook for custom doc generation
rriggs
parents: 26119
diff changeset
   379
#
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   380
# Default target is same as docs target, create core api and all others it can
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   381
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   382
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   383
all: docs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   384
docs: coredocs otherdocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   385
37034
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
   386
#
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
   387
# Optional target which bundles all generated javadocs into a zip archive.
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
   388
# The dependency on docs is handled in Main.gmk.
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
   389
#
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
   390
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
   391
zip-docs: $(JAVADOC_ARCHIVE)
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
   392
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   393
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   394
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   395
# coredocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   396
#
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   397
COREAPI_DOCTITLE = Java$(TRADEMARK) Platform, Standard Edition \
33926
3a19edba4808 8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents: 30416
diff changeset
   398
$(VERSION_SPECIFICATION)<br>API Specification
3a19edba4808 8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents: 30416
diff changeset
   399
COREAPI_WINDOWTITLE = Java Platform SE $(VERSION_SPECIFICATION)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   400
COREAPI_HEADER = \
33926
3a19edba4808 8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents: 30416
diff changeset
   401
<strong>Java$(TRADEMARK)&nbsp;Platform<br>Standard&nbsp;Ed.&nbsp;$(VERSION_SPECIFICATION)</strong>
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   402
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   403
# Overview file for core apis
25854
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
   404
COREAPI_OVERVIEW = $(JDK_TOPDIR)/src/java.base/share/classes/overview-core.html
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   405
35817
007e71c3b8c4 8149963: build errors during API docs build
erikj
parents: 35369
diff changeset
   406
# The options and packages files
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   407
COREAPI_OPTIONS_FILE = $(DOCSTMPDIR)/coredocs.options
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   408
COREAPI_PACKAGES_FILE = $(DOCSTMPDIR)/coredocs.packages
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   409
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   410
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   411
COREAPI_MODULES = java.se.ee
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   412
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   413
coredocs: $(COREAPI_INDEX_FILE)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   414
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   415
# Set relative location to core api document root
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   416
$(COREAPI_INDEX_FILE): GET2DOCSDIR=..
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   417
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   418
# Run javadoc if the index file is out of date or missing
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   419
$(COREAPI_INDEX_FILE): $(COREAPI_OPTIONS_FILE) $(COREAPI_PACKAGES_FILE)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   420
	$(prep-javadoc)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   421
	$(call JavadocSummary,$(COREAPI_OPTIONS_FILE),$(COREAPI_PACKAGES_FILE))
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   422
	$(JAVADOC_CMD) -d $(@D) \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   423
	    @$(COREAPI_OPTIONS_FILE) @$(COREAPI_PACKAGES_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   424
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   425
# Create file with javadoc options in it
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   426
$(COREAPI_OPTIONS_FILE): $(COREAPI_OVERVIEW)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   427
	$(prep-target)
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   428
	@($(call COMMON_JAVADOCFLAGS) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   429
          $(call COMMON_JAVADOCTAGS) ; \
31567
626eeea487f8 8080722: Revisit how to check for doclint reference warning during the build
darcy
parents: 30416
diff changeset
   430
          $(call OptionOnly,-Xdoclint:reference) ; \
626eeea487f8 8080722: Revisit how to check for doclint reference warning during the build
darcy
parents: 30416
diff changeset
   431
          $(call OptionOnly,-Xdoclint/package:-org.omg.*) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   432
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   433
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   434
	  $(call OptionPair,-addmods,$(COREAPI_MODULES)) ; \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   435
	  $(call OptionPair,-encoding,ISO-8859-1) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   436
	  $(call OptionOnly,-splitIndex) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   437
	  $(call OptionPair,-overview,$(COREAPI_OVERVIEW)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   438
	  $(call OptionPair,-doctitle,$(COREAPI_DOCTITLE)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   439
	  $(call OptionPair,-windowtitle,$(COREAPI_WINDOWTITLE) $(DRAFT_WINTITLE)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   440
	  $(call OptionPair,-header,$(COREAPI_HEADER)$(DRAFT_HEADER)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   441
	  $(call OptionPair,-bottom,$(COREAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   442
	) >> $@
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   443
        ifdef COREAPI_TOP_EARLYACCESS
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   444
	  @$(call OptionPair,-top,$(COREAPI_TOP_EARLYACCESS)) >> $@
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   445
        endif
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   446
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   447
# Create a file with the package names in it
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   448
$(COREAPI_PACKAGES_FILE): $(call PackageDependencies,$(CORE_PKGS))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   449
	$(prep-target)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   450
	$(call PackageFilter,$(CORE_PKGS))
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   451
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   452
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   453
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   454
# docletapidocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   455
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   456
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   457
ALL_OTHER_TARGETS += docletapidocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   458
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   459
DOCLETAPI_DOCDIR := $(JDK_API_DOCSDIR)/javadoc/doclet
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   460
DOCLETAPI2COREAPI := ../../$(JDKJRE2COREAPI)
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   461
DOCLETAPI_DOCTITLE := Doclet API
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   462
DOCLETAPI_WINDOWTITLE := Doclet API
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   463
DOCLETAPI_HEADER := <strong>Doclet API</strong>
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   464
DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   465
DOCLETAPI_GROUPNAME := Packages
35367
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   466
DOCLETAPI_REGEXP := jdk.javadoc.doclet.*
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   467
# DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   468
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   469
# The index.html, options, and packages files
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   470
DOCLETAPI_INDEX_FILE = $(DOCLETAPI_DOCDIR)/index.html
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   471
DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/docletapi.options
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   472
DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/docletapi.packages
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   473
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   474
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   475
DOCLETAPI_MODULES = jdk.javadoc
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   476
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   477
docletapidocs: $(DOCLETAPI_INDEX_FILE)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   478
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   479
# Set relative location to core api document root
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   480
$(DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(DOCLETAPI2COREAPI)/..
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   481
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   482
# Run javadoc if the index file is out of date or missing
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   483
$(DOCLETAPI_INDEX_FILE): $(DOCLETAPI_OPTIONS_FILE) $(DOCLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   484
	$(prep-javadoc)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   485
	$(call JavadocSummary,$(DOCLETAPI_OPTIONS_FILE),$(DOCLETAPI_PACKAGES_FILE))
29176
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
   486
	$(JAVADOC_CMD_SMALL) -d $(@D) \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   487
	    @$(DOCLETAPI_OPTIONS_FILE) @$(DOCLETAPI_PACKAGES_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   488
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   489
# Create file with javadoc options in it
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   490
$(DOCLETAPI_OPTIONS_FILE):
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   491
	$(prep-target)
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   492
	@($(call COMMON_JAVADOCFLAGS) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   493
          $(call COMMON_JAVADOCTAGS) ; \
25043
b5598c2ddf6f 8048302: Update bug reporting URL in make/Javadoc.gmk
darcy
parents: 24232
diff changeset
   494
	  $(call OptionOnly,-Xdoclint:all) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   495
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   496
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   497
	  $(call OptionPair,-addmods,$(DOCLETAPI_MODULES)) ; \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   498
	  $(call OptionPair,-encoding,ascii) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   499
	  $(call OptionOnly,-breakiterator) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   500
	  $(call OptionPair,-doctitle,$(DOCLETAPI_DOCTITLE)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   501
	  $(call OptionPair,-windowtitle,$(DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   502
	  $(call OptionPair,-header,$(DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   503
	  $(call OptionPair,-bottom,$(DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   504
	  $(call OptionTrip,-group,$(DOCLETAPI_GROUPNAME),$(DOCLETAPI_REGEXP)); \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   505
	  $(call OptionTrip,-linkoffline,$(DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   506
	) >> $@
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   507
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   508
# Create a file with the package names in it
27595
cff167b3bfa2 8065914: Various improvements and cleanup of build system
ihse
parents: 27586
diff changeset
   509
$(DOCLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(DOCLETAPI_PKGS))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   510
	$(prep-target)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   511
	$(call PackageFilter,$(DOCLETAPI_PKGS))
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   512
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   513
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   514
#
35367
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   515
# old docletapidocs
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   516
#
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   517
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   518
ALL_OTHER_TARGETS += olddocletapidocs
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   519
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   520
OLD_DOCLET_DIR := $(JDK_API_DOCSDIR)/javadoc/old
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   521
OLD_DOCLETAPI_DOCDIR := $(OLD_DOCLET_DIR)/doclet
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   522
OLD_DOCLETAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   523
OLD_DOCLETAPI_DOCTITLE := Doclet API
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   524
OLD_DOCLETAPI_WINDOWTITLE := Doclet API
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   525
OLD_DOCLETAPI_HEADER := <strong>Doclet API</strong>
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   526
OLD_DOCLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOCLETAPI_FIRST_COPYRIGHT_YEAR))
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   527
OLD_DOCLETAPI_GROUPNAME := Packages
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   528
OLD_DOCLETAPI_REGEXP := com.sun.javadoc
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   529
# OLD_DOCLETAPI_PKGS is located in NON_CORE_PKGS.gmk
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   530
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   531
# The index.html, options, and packages files
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   532
OLD_DOCLETAPI_INDEX_FILE = $(OLD_DOCLETAPI_DOCDIR)/index.html
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   533
OLD_DOCLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/old-docletapi.options
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   534
OLD_DOCLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/old-docletapi.packages
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   535
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   536
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   537
OLD_DOCLETAPI_MODULES = jdk.javadoc
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   538
35367
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   539
olddocletapidocs: $(OLD_DOCLETAPI_INDEX_FILE)
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   540
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   541
# Set relative location to core api document root
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   542
$(OLD_DOCLETAPI_INDEX_FILE): GET2DOCSDIR=$(OLD_DOCLETAPI2COREAPI)/..
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   543
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   544
# Run javadoc if the index file is out of date or missing
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   545
$(OLD_DOCLETAPI_INDEX_FILE): $(OLD_DOCLETAPI_OPTIONS_FILE) $(OLD_DOCLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   546
	$(prep-javadoc)
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   547
	$(call JavadocSummary,$(OLD_DOCLETAPI_OPTIONS_FILE),$(OLD_DOCLETAPI_PACKAGES_FILE))
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   548
	$(JAVADOC_CMD_SMALL) -d $(@D) \
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   549
	    @$(OLD_DOCLETAPI_OPTIONS_FILE) @$(OLD_DOCLETAPI_PACKAGES_FILE)
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   550
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   551
# Create file with javadoc options in it
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   552
$(OLD_DOCLETAPI_OPTIONS_FILE):
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   553
	$(prep-target)
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   554
	@($(call COMMON_JAVADOCFLAGS) ; \
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   555
          $(call COMMON_JAVADOCTAGS) ; \
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   556
	  $(call OptionOnly,-Xdoclint:all) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   557
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   558
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   559
	  $(call OptionPair,-addmods,$(OLD_DOCLETAPI_MODULES)) ; \
35367
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   560
	  $(call OptionPair,-encoding,ascii) ; \
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   561
	  $(call OptionOnly,-breakiterator) ; \
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   562
	  $(call OptionPair,-doctitle,$(OLD_DOCLETAPI_DOCTITLE)) ; \
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   563
	  $(call OptionPair,-windowtitle,$(OLD_DOCLETAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   564
	  $(call OptionPair,-header,$(OLD_DOCLETAPI_HEADER)$(DRAFT_HEADER)) ; \
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   565
	  $(call OptionPair,-bottom,$(OLD_DOCLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   566
	  $(call OptionTrip,-group,$(OLD_DOCLETAPI_GROUPNAME),$(OLD_DOCLETAPI_REGEXP)); \
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   567
	  $(call OptionTrip,-linkoffline,$(OLD_DOCLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   568
	) >> $@
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   569
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   570
# Create a file with the package names in it
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   571
$(OLD_DOCLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(OLD_DOCLETAPI_PKGS))
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   572
	$(prep-target)
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   573
	$(call PackageFilter,$(OLD_DOCLETAPI_PKGS))
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   574
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   575
#############################################################
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   576
#
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   577
# tagletapidocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   578
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   579
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   580
ALL_OTHER_TARGETS += tagletapidocs
35367
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   581
TAGLETAPI_DOCDIR := $(OLD_DOCLET_DIR)/taglet
48968f91bab4 8035473: [javadoc] Revamp the existing Doclet APIs
ksrini
parents: 33934
diff changeset
   582
TAGLETAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   583
TAGLETAPI_BOTTOM := $(call CommonTrademarkBottom,$(TAGLETAPI_FIRST_COPYRIGHT_YEAR))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   584
# TAGLETAPI_FILE is located in NON_CORE_PKGS.gmk
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   585
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   586
# Temporary directory (special generation rules)
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   587
TAGLETAPI_TEMPDIR = $(DOCSTMPDIR)/taglets_temp
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   588
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   589
# The index.html, options, and packages files
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   590
TAGLETAPI_INDEX_FILE = $(TAGLETAPI_DOCDIR)/com/sun/tools/doclets/Taglet.html
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   591
TAGLETAPI_OPTIONS_FILE = $(DOCSTMPDIR)/tagletapi.options
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   592
TAGLETAPI_PACKAGES_FILE = $(DOCSTMPDIR)/tagletapi.packages
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   593
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   594
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   595
TAGLETAPI_MODULES = jdk.javadoc
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   596
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   597
tagletapidocs: $(TAGLETAPI_INDEX_FILE)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   598
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   599
# Set relative location to core api document root
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   600
$(TAGLETAPI_INDEX_FILE): GET2DOCSDIR=$(TAGLETAPI2COREAPI)/..
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   601
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   602
# Run javadoc if the index file is out of date or missing
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   603
$(TAGLETAPI_INDEX_FILE): $(TAGLETAPI_OPTIONS_FILE) $(TAGLETAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   604
	$(prep-javadoc)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   605
	$(RM) -r $(TAGLETAPI_TEMPDIR)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   606
	$(MKDIR) -p $(TAGLETAPI_TEMPDIR)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   607
	$(call JavadocSummary,$(TAGLETAPI_OPTIONS_FILE),$(TAGLETAPI_PACKAGES_FILE))
29176
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
   608
	$(JAVADOC_CMD_SMALL) -d $(TAGLETAPI_TEMPDIR) \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   609
	    @$(TAGLETAPI_OPTIONS_FILE) @$(TAGLETAPI_PACKAGES_FILE)
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   610
	cp -r $(TAGLETAPI_TEMPDIR)/com $(TAGLETAPI_DOCDIR)
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   611
	cp $(TAGLETAPI_TEMPDIR)/stylesheet.css $(TAGLETAPI_DOCDIR)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   612
	$(RM) -r $(TAGLETAPI_TEMPDIR)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   613
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   614
# Create file with javadoc options in it
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   615
$(TAGLETAPI_OPTIONS_FILE):
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   616
	$(prep-target)
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   617
	@($(call COMMON_JAVADOCFLAGS) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   618
          $(call COMMON_JAVADOCTAGS) ; \
25043
b5598c2ddf6f 8048302: Update bug reporting URL in make/Javadoc.gmk
darcy
parents: 24232
diff changeset
   619
	  $(call OptionOnly,-Xdoclint:all) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   620
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   621
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   622
	  $(call OptionPair,-addmods,$(TAGLETAPI_MODULES)) ; \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   623
	  $(call OptionPair,-encoding,ascii) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   624
	  $(call OptionOnly,-nonavbar) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   625
	  $(call OptionOnly,-noindex) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   626
	  $(call OptionPair,-bottom,$(TAGLETAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   627
	  $(call OptionTrip,-linkoffline,$(TAGLETAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   628
	) >> $@
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   629
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   630
# Create a file with the package names in it
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   631
$(TAGLETAPI_PACKAGES_FILE): $(call PackageDependencies,$(TAGLETAPI_PKGS))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   632
	$(prep-target)
25854
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
   633
	@($(ECHO) "$(LANGTOOLS_TOPDIR)/src/jdk.javadoc/share/classes/$(TAGLETAPI_FILE)" ) > $@
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   634
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   635
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   636
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   637
# domapidocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   638
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   639
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   640
ALL_OTHER_TARGETS += domapidocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   641
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   642
DOMAPI_DOCDIR := $(JRE_API_DOCSDIR)/plugin/dom
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   643
DOMAPI2COREAPI := ../../$(JDKJRE2COREAPI)
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   644
DOMAPI_DOCTITLE := Common DOM API
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   645
DOMAPI_WINDOWTITLE := Common DOM API
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   646
DOMAPI_HEADER := <strong>Common DOM API</strong>
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   647
DOMAPI_BOTTOM := $(call CommonTrademarkBottom,$(DOMAPI_FIRST_COPYRIGHT_YEAR))
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   648
DOMAPI_GROUPNAME := Packages
25045
7b8a6a85baa4 8044063: Remove com.sun.java.browser.* from jdk repo
mchung
parents: 24232
diff changeset
   649
DOMAPI_REGEXP := org.w3c.dom*
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   650
# DOMAPI_PKGS is located in NON_CORE_PKGS.gmk
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   651
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   652
# The index.html, options, and packages files
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   653
DOMAPI_INDEX_FILE = $(DOMAPI_DOCDIR)/index.html
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   654
DOMAPI_OPTIONS_FILE = $(DOCSTMPDIR)/domapi.options
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   655
DOMAPI_PACKAGES_FILE = $(DOCSTMPDIR)/domapi.packages
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   656
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   657
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   658
DOMAPI_MODULES = java.xml,jdk.xml.dom
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   659
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   660
domapidocs: $(DOMAPI_INDEX_FILE)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   661
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   662
# Set relative location to core api document root
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   663
$(DOMAPI_INDEX_FILE): GET2DOCSDIR=$(DOMAPI2COREAPI)/..
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   664
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   665
# Run javadoc if the index file is out of date or missing
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   666
$(DOMAPI_INDEX_FILE): $(DOMAPI_OPTIONS_FILE) $(DOMAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   667
	$(prep-javadoc)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   668
	$(call JavadocSummary,$(DOMAPI_OPTIONS_FILE),$(DOMAPI_PACKAGES_FILE))
29176
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
   669
	$(JAVADOC_CMD_SMALL) -d $(@D) \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   670
	    @$(DOMAPI_OPTIONS_FILE) @$(DOMAPI_PACKAGES_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   671
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   672
# Create file with javadoc options in it
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   673
$(DOMAPI_OPTIONS_FILE):
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   674
	$(prep-target)
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   675
	@($(call COMMON_JAVADOCFLAGS) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   676
          $(call COMMON_JAVADOCTAGS) ; \
22033
c323078abaf4 8031081: Use separate doclint flags for different doc bundles
darcy
parents: 21759
diff changeset
   677
	  $(call OptionOnly,-Xdoclint:none) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   678
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   679
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   680
	  $(call OptionPair,-addmods,$(DOMAPI_MODULES)) ; \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   681
	  $(call OptionPair,-encoding,ascii) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   682
	  $(call OptionOnly,-splitIndex) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   683
	  $(call OptionPair,-doctitle,$(DOMAPI_DOCTITLE)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   684
	  $(call OptionPair,-windowtitle,$(DOMAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   685
	  $(call OptionPair,-header,$(DOMAPI_HEADER)$(DRAFT_HEADER)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   686
	  $(call OptionPair,-bottom,$(DOMAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   687
	  $(call OptionTrip,-group,$(DOMAPI_GROUPNAME),$(DOMAPI_REGEXP)); \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   688
	  $(call OptionTrip,-linkoffline,$(DOMAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   689
	) >> $@
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   690
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   691
# Create a file with the package names in it
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   692
$(DOMAPI_PACKAGES_FILE): $(call PackageDependencies,$(DOMAPI_PKGS))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   693
	$(prep-target)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   694
	$(call PackageFilter,$(DOMAPI_PKGS))
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   695
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   696
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   697
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   698
# jpdadocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   699
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   700
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   701
ALL_OTHER_TARGETS += jpdadocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   702
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   703
jpdadocs: jdidocs jdwpdocs jvmtidocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   704
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   705
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   706
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   707
# jdidocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   708
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   709
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   710
ALL_OTHER_TARGETS += jdidocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   711
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   712
JDI_DOCDIR := $(JDK_API_DOCSDIR)/jpda/jdi
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   713
JDI2COREAPI := ../../$(JDKJRE2COREAPI)
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   714
JDI_DOCTITLE := Java$(TRADEMARK) Debug Interface
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   715
JDI_WINDOWTITLE := Java Debug Interface
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   716
JDI_HEADER := <strong>Java Debug Interface</strong>
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   717
JDI_BOTTOM := $(call CommonBottom,$(JDI_FIRST_COPYRIGHT_YEAR))
25854
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
   718
JDI_OVERVIEW := $(JDK_TOPDIR)/src/jdk.jdi/share/classes/jdi-overview.html
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   719
# JDI_PKGS is located in NON_CORE_PKGS.gmk
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   720
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   721
# The index.html, options, and packages files
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   722
JDI_INDEX_FILE = $(JDI_DOCDIR)/index.html
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   723
JDI_OPTIONS_FILE = $(DOCSTMPDIR)/jdi.options
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   724
JDI_PACKAGES_FILE = $(DOCSTMPDIR)/jdi.packages
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   725
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   726
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   727
JDI_MODULES = jdk.jdi
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   728
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   729
jdidocs: $(JDI_INDEX_FILE)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   730
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   731
# Set relative location to core api document root
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   732
$(JDI_INDEX_FILE): GET2DOCSDIR=$(JDI2COREAPI)/..
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   733
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   734
# Run javadoc if the index file is out of date or missing
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   735
$(JDI_INDEX_FILE): $(JDI_OPTIONS_FILE) $(JDI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   736
	$(prep-javadoc)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   737
	$(call JavadocSummary,$(JDI_OPTIONS_FILE),$(JDI_PACKAGES_FILE))
29176
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
   738
	$(JAVADOC_CMD_SMALL) -d $(@D) \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   739
	    @$(JDI_OPTIONS_FILE) @$(JDI_PACKAGES_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   740
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   741
# Create file with javadoc options in it
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   742
$(JDI_OPTIONS_FILE): $(JDI_OVERVIEW)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   743
	$(prep-target)
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   744
	@($(call COMMON_JAVADOCFLAGS) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   745
          $(call COMMON_JAVADOCTAGS) ; \
22033
c323078abaf4 8031081: Use separate doclint flags for different doc bundles
darcy
parents: 21759
diff changeset
   746
	  $(call OptionOnly,-Xdoclint:none) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   747
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   748
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   749
	  $(call OptionPair,-addmods,$(JDI_MODULES)) ; \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   750
	  $(call OptionPair,-encoding,ascii) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   751
	  $(call OptionPair,-overview,$(JDI_OVERVIEW)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   752
	  $(call OptionPair,-doctitle,$(JDI_DOCTITLE)) ; \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   753
	  $(call OptionPair,-windowtitle,$(JDI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   754
	  $(call OptionPair,-header,$(JDI_HEADER)$(DRAFT_HEADER)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   755
	  $(call OptionPair,-bottom,$(JDI_BOTTOM)$(DRAFT_BOTTOM)) ; \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   756
	  $(call OptionTrip,-linkoffline,$(JDI2COREAPI),$(COREAPI_DOCSDIR)/); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   757
	) >> $@
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   758
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   759
# Create a file with the package names in it
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   760
$(JDI_PACKAGES_FILE): $(call PackageDependencies,$(JDI_PKGS))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   761
	$(prep-target)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   762
	$(call PackageFilter,$(JDI_PKGS))
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   763
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   764
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   765
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   766
# jdwpdocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   767
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   768
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   769
ALL_OTHER_TARGETS += jdwpdocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   770
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   771
JDWP_DOCDIR = $(PLATFORM_DOCSDIR)/jpda/jdwp
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   772
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   773
jdwpdocs: $(JDWP_DOCDIR)/jdwp-protocol.html
27560
adc258b13e2c 8049367: Modular Run-Time Images
chegar
parents: 27328
diff changeset
   774
$(JDWP_DOCDIR)/jdwp-protocol.html : $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   775
	$(MKDIR) -p $(@D)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   776
	$(RM) $@
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   777
	$(CP) $< $@
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   778
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   779
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   780
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   781
# jvmtidocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   782
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   783
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   784
ALL_OTHER_TARGETS += jvmtidocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   785
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   786
JVMTI_DOCDIR = $(PLATFORM_DOCSDIR)/jvmti
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   787
JVMTI_HTML = $(HOTSPOT_DIST)/docs/platform/jvmti/jvmti.html
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   788
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   789
jvmtidocs: $(JVMTI_DOCDIR)/jvmti.html
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   790
$(JVMTI_DOCDIR)/jvmti.html:
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   791
	@$(prep-javadoc)
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   792
	@if [ -f $(JVMTI_HTML) ] ; then \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   793
	  $(CP) $(JVMTI_HTML) $@; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   794
	else \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   795
	  $(ECHO) "WARNING: Generated file does not exist: $(JVMTI_HTML)"; \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   796
	fi
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   797
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   798
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   799
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   800
# jaasdocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   801
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   802
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   803
ALL_OTHER_TARGETS += jaasdocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   804
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   805
JAAS_DOCDIR := $(JRE_API_DOCSDIR)/security/jaas/spec
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   806
JAAS2COREAPI := ../../../$(JDKJRE2COREAPI)
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   807
JAAS_DOCTITLE := Java$(TRADEMARK) Authentication and Authorization Service
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   808
JAAS_WINDOWTITLE := Java Authentication and Authorization Service
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   809
JAAS_HEADER := <strong>Java Authentication and Authorization Service</strong>
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   810
JAAS_BOTTOM := $(call CommonBottom,$(JAAS_FIRST_COPYRIGHT_YEAR))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   811
# JAAS_PKGS is located in NON_CORE_PKGS.gmk
25854
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
   812
JAAS_OVERVIEW := $(JDK_TOPDIR)/src/jdk.security.auth/share/classes/jaas-overview.html
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   813
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   814
# The index.html, options, and packages files
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   815
JAAS_INDEX_FILE = $(JAAS_DOCDIR)/index.html
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   816
JAAS_OPTIONS_FILE = $(DOCSTMPDIR)/jaas.options
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   817
JAAS_PACKAGES_FILE = $(DOCSTMPDIR)/jaas.packages
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   818
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   819
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   820
JAAS_MODULES = jdk.security.auth
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   821
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   822
jaasdocs: $(JAAS_INDEX_FILE)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   823
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   824
# Set relative location to core api document root
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   825
$(JAAS_INDEX_FILE): GET2DOCSDIR=$(JAAS2COREAPI)/..
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   826
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   827
# Run javadoc if the index file is out of date or missing
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   828
$(JAAS_INDEX_FILE): $(JAAS_OPTIONS_FILE) $(JAAS_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   829
	$(prep-javadoc)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   830
	$(call JavadocSummary,$(JAAS_OPTIONS_FILE),$(JAAS_PACKAGES_FILE))
29176
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
   831
	$(JAVADOC_CMD_SMALL) -d $(@D) \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   832
	    @$(JAAS_OPTIONS_FILE) @$(JAAS_PACKAGES_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   833
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   834
# Create file with javadoc options in it
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   835
$(JAAS_OPTIONS_FILE): $(JAAS_OVERVIEW)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   836
	$(prep-target)
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   837
	@($(call COMMON_JAVADOCFLAGS) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   838
          $(call COMMON_JAVADOCTAGS) ; \
22033
c323078abaf4 8031081: Use separate doclint flags for different doc bundles
darcy
parents: 21759
diff changeset
   839
	  $(call OptionOnly,-Xdoclint:none) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   840
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   841
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   842
	  $(call OptionPair,-addmods,$(JAAS_MODULES)) ; \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   843
	  $(call OptionPair,-encoding,ascii) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   844
	  $(call OptionPair,-overview,$(JAAS_OVERVIEW)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   845
	  $(call OptionPair,-doctitle,$(JAAS_DOCTITLE)) ; \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   846
	  $(call OptionPair,-windowtitle,$(JAAS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   847
	  $(call OptionPair,-header,$(JAAS_HEADER)$(DRAFT_HEADER)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   848
	  $(call OptionPair,-bottom,$(JAAS_BOTTOM)$(DRAFT_BOTTOM)) ; \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   849
	  $(call OptionTrip,-linkoffline,$(JAAS2COREAPI),$(COREAPI_DOCSDIR)/); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   850
	) >> $@
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   851
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   852
# Create a file with the package names in it
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   853
$(JAAS_PACKAGES_FILE): $(call PackageDependencies,$(JAAS_PKGS))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   854
	$(prep-target)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   855
	$(call PackageFilter,$(JAAS_PKGS))
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   856
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   857
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   858
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   859
# jgssdocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   860
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   861
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   862
ALL_OTHER_TARGETS += jgssdocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   863
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   864
JGSS_DOCDIR := $(JRE_API_DOCSDIR)/security/jgss/spec
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   865
JGSS2COREAPI := ../../../$(JDKJRE2COREAPI)
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   866
JGSS_DOCTITLE := Java$(TRADEMARK) GSS-API Utilities
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   867
JGSS_WINDOWTITLE := Java GSS-API Utilities
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   868
JGSS_HEADER := <strong>Java GSS-API Utilities</strong>
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   869
JGSS_BOTTOM := $(call CommonBottom,$(JGSS_FIRST_COPYRIGHT_YEAR))
25854
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
   870
JGSS_OVERVIEW := $(JDK_TOPDIR)/src/java.security.jgss/share/classes/jgss-overview.html
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   871
# JGSS_PKGS is located in NON_CORE_PKGS.gmk
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   872
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   873
# The index.html, options, and packages files
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   874
JGSS_INDEX_FILE = $(JGSS_DOCDIR)/index.html
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   875
JGSS_OPTIONS_FILE = $(DOCSTMPDIR)/jgss.options
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   876
JGSS_PACKAGES_FILE = $(DOCSTMPDIR)/jgss.packages
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   877
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   878
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   879
JGSS_MODULES = jdk.security.jgss
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   880
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   881
jgssdocs: $(JGSS_INDEX_FILE)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   882
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   883
# Set relative location to core api document root
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   884
$(JGSS_INDEX_FILE): GET2DOCSDIR=$(JGSS2COREAPI)/..
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   885
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   886
# Run javadoc if the index file is out of date or missing
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   887
$(JGSS_INDEX_FILE): $(JGSS_OPTIONS_FILE) $(JGSS_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   888
	$(prep-javadoc)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   889
	$(call JavadocSummary,$(JGSS_OPTIONS_FILE),$(JGSS_PACKAGES_FILE))
29176
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
   890
	$(JAVADOC_CMD_SMALL) -d $(@D) \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   891
	    @$(JGSS_OPTIONS_FILE) @$(JGSS_PACKAGES_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   892
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   893
# Create file with javadoc options in it
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   894
$(JGSS_OPTIONS_FILE): $(JGSS_OVERVIEW)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   895
	$(prep-target)
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   896
	@($(call COMMON_JAVADOCFLAGS) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   897
          $(call COMMON_JAVADOCTAGS) ; \
22033
c323078abaf4 8031081: Use separate doclint flags for different doc bundles
darcy
parents: 21759
diff changeset
   898
	  $(call OptionOnly,-Xdoclint:none) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   899
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   900
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   901
	  $(call OptionPair,-addmods,$(JGSS_MODULES)) ; \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   902
	  $(call OptionPair,-encoding,ascii) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   903
	  $(call OptionOnly,-nodeprecatedlist) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   904
	  $(call OptionPair,-overview,$(JGSS_OVERVIEW)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   905
	  $(call OptionPair,-doctitle,$(JGSS_DOCTITLE)) ; \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   906
	  $(call OptionPair,-windowtitle,$(JGSS_WINDOWTITLE) $(DRAFT_WINTITLE)); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   907
	  $(call OptionPair,-header,$(JGSS_HEADER)$(DRAFT_HEADER)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   908
	  $(call OptionPair,-bottom,$(JGSS_BOTTOM)$(DRAFT_BOTTOM)) ; \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   909
	  $(call OptionTrip,-linkoffline,$(JGSS2COREAPI),$(COREAPI_DOCSDIR)/); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   910
	) >> $@
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   911
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   912
# Create a file with the package names in it
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   913
$(JGSS_PACKAGES_FILE): $(call PackageDependencies,$(JGSS_PKGS))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   914
	$(prep-target)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   915
	$(call PackageFilter,$(JGSS_PKGS))
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   916
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   917
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   918
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   919
# smartcardiodocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   920
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   921
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   922
ALL_OTHER_TARGETS += smartcardiodocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   923
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   924
SMARTCARDIO_DOCDIR := $(JRE_API_DOCSDIR)/security/smartcardio/spec
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   925
SMARTCARDIO2COREAPI := ../../../$(JDKJRE2COREAPI)
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   926
SMARTCARDIO_DOCTITLE := Java$(TRADEMARK) Smart Card I/O
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   927
SMARTCARDIO_WINDOWTITLE := Java Smart Card I/O
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   928
SMARTCARDIO_HEADER := <strong>Java Smart Card I/O</strong>
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   929
SMARTCARDIO_BOTTOM := $(call CommonBottom,$(SMARTCARDIO_FIRST_COPYRIGHT_YEAR))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   930
# SMARTCARDIO_PKGS is located in NON_CORE_PKGS.gmk
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   931
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   932
# The index.html, options, and packages files
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   933
SMARTCARDIO_INDEX_FILE = $(SMARTCARDIO_DOCDIR)/index.html
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   934
SMARTCARDIO_OPTIONS_FILE = $(DOCSTMPDIR)/smartcardio.options
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   935
SMARTCARDIO_PACKAGES_FILE = $(DOCSTMPDIR)/smartcardio.packages
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   936
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   937
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   938
SMARTCARDIO_MODULES = java.smartcardio
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   939
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   940
smartcardiodocs: $(SMARTCARDIO_INDEX_FILE)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   941
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   942
# Set relative location to core api document root
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   943
$(SMARTCARDIO_INDEX_FILE): GET2DOCSDIR=$(SMARTCARDIO2COREAPI)/..
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   944
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   945
# Run javadoc if the index file is out of date or missing
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   946
$(SMARTCARDIO_INDEX_FILE): $(SMARTCARDIO_OPTIONS_FILE) $(SMARTCARDIO_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   947
	$(prep-javadoc)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   948
	$(call JavadocSummary,$(SMARTCARDIO_OPTIONS_FILE),$(SMARTCARDIO_PACKAGES_FILE))
29176
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
   949
	$(JAVADOC_CMD_SMALL) -d $(@D) \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   950
	    @$(SMARTCARDIO_OPTIONS_FILE) @$(SMARTCARDIO_PACKAGES_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   951
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   952
# Create file with javadoc options in it
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   953
$(SMARTCARDIO_OPTIONS_FILE):
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   954
	$(prep-target)
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   955
	@($(call COMMON_JAVADOCFLAGS) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
   956
          $(call COMMON_JAVADOCTAGS) ; \
22033
c323078abaf4 8031081: Use separate doclint flags for different doc bundles
darcy
parents: 21759
diff changeset
   957
	  $(call OptionOnly,-Xdoclint:none) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   958
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   959
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   960
	  $(call OptionPair,-addmods,$(SMARTCARDIO_MODULES)) ; \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   961
	  $(call OptionPair,-encoding,ascii) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   962
	  $(call OptionOnly,-nodeprecatedlist) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   963
	  $(call OptionPair,-doctitle,$(SMARTCARDIO_DOCTITLE)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   964
	  $(call OptionPair,-windowtitle,$(SMARTCARDIO_WINDOWTITLE) $(DRAFT_WINTITLE)); \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   965
	  $(call OptionPair,-header,$(SMARTCARDIO_HEADER)$(DRAFT_HEADER)); \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   966
	  $(call OptionPair,-bottom,$(SMARTCARDIO_BOTTOM)$(DRAFT_BOTTOM)); \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   967
	  $(call OptionTrip,-linkoffline,$(SMARTCARDIO2COREAPI),$(COREAPI_DOCSDIR)/); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   968
	) >> $@
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   969
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   970
# Create a file with the package names in it
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
   971
$(SMARTCARDIO_PACKAGES_FILE): $(call PackageDependencies,$(SMARTCARDIO_PKGS))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   972
	$(prep-target)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   973
	$(call PackageFilter,$(SMARTCARDIO_PKGS))
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   974
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   975
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   976
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   977
# httpserverdocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   978
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   979
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   980
ALL_OTHER_TARGETS += httpserverdocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   981
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   982
HTTPSERVER_DOCDIR := $(JRE_API_DOCSDIR)/net/httpserver/spec
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   983
HTTPSERVER2COREAPI := ../../../$(JDKJRE2COREAPI)
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   984
HTTPSERVER_DOCTITLE := Java$(TRADEMARK) HTTP Server
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   985
HTTPSERVER_WINDOWTITLE := Java HTTP Server
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   986
HTTPSERVER_HEADER := <strong>Java HTTP Server</strong>
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   987
HTTPSERVER_BOTTOM := $(call CommonBottom,$(HTTPSERVER_FIRST_COPYRIGHT_YEAR))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   988
# HTTPSERVER_PKGS is located in NON_CORE_PKGS.gmk
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   989
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   990
HTTPSERVER_INDEX_HTML = $(HTTPSERVER_DOCDIR)/index.html
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
   991
HTTPSERVER_OPTIONS_FILE = $(DOCSTMPDIR)/httpserver.options
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   992
HTTPSERVER_PACKAGES_FILE = $(DOCSTMPDIR)/httpserver.packages
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   993
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   994
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   995
HTTPSERVER_MODULES = jdk.httpserver
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   996
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   997
httpserverdocs: $(HTTPSERVER_INDEX_HTML)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   998
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   999
# Set relative location to core api document root
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1000
$(HTTPSERVER_INDEX_HTML): GET2DOCSDIR=$(HTTPSERVER2COREAPI)/..
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1001
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1002
# Run javadoc if the index file is out of date or missing
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
  1003
$(HTTPSERVER_INDEX_HTML): $(HTTPSERVER_OPTIONS_FILE) $(HTTPSERVER_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1004
	$(prep-javadoc)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1005
	$(call JavadocSummary,$(HTTPSERVER_OPTIONS_FILE),$(HTTPSERVER_PACKAGES_FILE))
29176
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
  1006
	$(JAVADOC_CMD_SMALL) -d $(@D) \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1007
	    @$(HTTPSERVER_OPTIONS_FILE) @$(HTTPSERVER_PACKAGES_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1008
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1009
# Create file with javadoc options in it
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1010
$(HTTPSERVER_OPTIONS_FILE):
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1011
	$(prep-target)
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
  1012
	@($(call COMMON_JAVADOCFLAGS) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
  1013
          $(call COMMON_JAVADOCTAGS) ; \
22033
c323078abaf4 8031081: Use separate doclint flags for different doc bundles
darcy
parents: 21759
diff changeset
  1014
	  $(call OptionOnly,-Xdoclint:none) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1015
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1016
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1017
	  $(call OptionPair,-addmods,$(HTTPSERVER_MODULES)) ; \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1018
	  $(call OptionPair,-encoding,ascii) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1019
	  $(call OptionOnly,-nodeprecatedlist) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1020
	  $(call OptionPair,-doctitle,$(HTTPSERVER_DOCTITLE)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1021
	  $(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE)); \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1022
	  $(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1023
	  $(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1024
	  $(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1025
	) >> $@
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1026
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1027
# Create a file with the package names in it
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
  1028
$(HTTPSERVER_PACKAGES_FILE): $(call PackageDependencies,$(HTTPSERVER_PKGS))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1029
	$(prep-target)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1030
	$(call PackageFilter,$(HTTPSERVER_PKGS))
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1031
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1032
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1033
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1034
# mgmtdocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1035
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1036
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1037
ALL_OTHER_TARGETS += mgmtdocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1038
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1039
MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1040
MGMT2COREAPI := ../../$(JDKJRE2COREAPI)
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1041
JVM_MIB_NAME := JVM-MANAGEMENT-MIB.mib
25854
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
  1042
JVM_MIB_SRC := $(JDK_TOPDIR)/src/closed/jdk.snmp/share/classes/sun/management/snmp/$(JVM_MIB_NAME)
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1043
MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1044
MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1045
MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong>
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1046
MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR))
25854
98ce0879ab4c 8054834: Modular Source Code
chegar
parents: 25614
diff changeset
  1047
MGMT_OVERVIEW := $(JDK_TOPDIR)/src/java.management/share/classes/mgmt-overview.html
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1048
# MGMT_PKGS is located in NON_CORE_PKGS.gmk
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1049
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1050
# The index.html, options, and packages files
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1051
MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1052
MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1053
MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1054
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1055
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1056
MGMT_MODULES = jdk.management
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1057
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1058
mgmtdocs: $(MGMT_INDEX_FILE)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1059
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1060
# Set relative location to core api document root
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1061
$(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/..
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1062
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1063
# Run javadoc if the index file is out of date or missing
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
  1064
$(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1065
	$(prep-javadoc)
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1066
	@if [ -f $(JVM_MIB_SRC) ] ; then \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1067
	  $(CP) $(JVM_MIB_SRC) $(@D)/.. ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1068
	else \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1069
	  $(ECHO) "WARNING: File $(JVM_MIB_NAME) not available."; \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1070
	fi
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1071
	$(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE))
29176
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
  1072
	$(JAVADOC_CMD_SMALL) -d $(@D) \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1073
	    @$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1074
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1075
# Create file with javadoc options in it
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1076
$(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1077
	$(prep-target)
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
  1078
	@($(call COMMON_JAVADOCFLAGS) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
  1079
          $(call COMMON_JAVADOCTAGS) ; \
22033
c323078abaf4 8031081: Use separate doclint flags for different doc bundles
darcy
parents: 21759
diff changeset
  1080
	  $(call OptionOnly,-Xdoclint:none) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1081
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1082
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1083
	  $(call OptionPair,-addmods,$(MGMT_MODULES)) ; \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1084
	  $(call OptionPair,-encoding,ascii) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1085
	  $(call OptionOnly,-nodeprecatedlist) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1086
	  $(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1087
	  $(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1088
	  $(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1089
	  $(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1090
	  $(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1091
	  $(call OptionTrip,-linkoffline,$(MGMT2COREAPI),$(COREAPI_DOCSDIR)/); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1092
	) >> $@
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1093
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1094
# Create a file with the package names in it
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
  1095
$(MGMT_PACKAGES_FILE): $(call PackageDependencies,$(MGMT_PKGS))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1096
	$(prep-target)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1097
	$(call PackageFilter,$(MGMT_PKGS))
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1098
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1099
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1100
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1101
# attachdocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1102
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1103
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1104
ALL_OTHER_TARGETS += attachdocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1105
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1106
ATTACH_DOCDIR := $(JDK_API_DOCSDIR)/attach/spec
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1107
ATTACH2COREAPI := ../../$(JDKJRE2COREAPI)
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1108
ATTACH_DOCTITLE := Attach API
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1109
ATTACH_WINDOWTITLE := Attach API
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1110
ATTACH_HEADER := <strong>Attach API</strong>
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1111
ATTACH_BOTTOM := $(call CommonBottom,$(ATTACH_FIRST_COPYRIGHT_YEAR))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1112
# ATTACH_PKGS is located in NON_CORE_PKGS.gmk
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1113
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1114
ATTACH_INDEX_HTML = $(ATTACH_DOCDIR)/index.html
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1115
ATTACH_OPTIONS_FILE = $(DOCSTMPDIR)/attach.options
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1116
ATTACH_PACKAGES_FILE = $(DOCSTMPDIR)/attach.packages
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1117
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1118
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1119
ATTACH_MODULES = jdk.attach
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1120
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1121
attachdocs: $(ATTACH_INDEX_HTML)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1122
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1123
# Set relative location to core api document root
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1124
$(ATTACH_INDEX_HTML): GET2DOCSDIR=$(ATTACH2COREAPI)/..
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1125
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1126
# Run javadoc if the index file is out of date or missing
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
  1127
$(ATTACH_INDEX_HTML): $(ATTACH_OPTIONS_FILE) $(ATTACH_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1128
	$(prep-javadoc)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1129
	$(call JavadocSummary,$(ATTACH_OPTIONS_FILE),$(ATTACH_PACKAGES_FILE))
29176
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
  1130
	$(JAVADOC_CMD_SMALL) -d $(@D) \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1131
	    @$(ATTACH_OPTIONS_FILE) @$(ATTACH_PACKAGES_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1132
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1133
# Create file with javadoc options in it
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1134
$(ATTACH_OPTIONS_FILE):
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1135
	$(prep-target)
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
  1136
	@($(call COMMON_JAVADOCFLAGS) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
  1137
          $(call COMMON_JAVADOCTAGS) ; \
22033
c323078abaf4 8031081: Use separate doclint flags for different doc bundles
darcy
parents: 21759
diff changeset
  1138
	  $(call OptionOnly,-Xdoclint:none) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1139
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1140
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1141
	  $(call OptionPair,-addmods,$(ATTACH_MODULES)) ; \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1142
	  $(call OptionPair,-encoding,ascii) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1143
	  $(call OptionOnly,-nodeprecatedlist) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1144
	  $(call OptionPair,-doctitle,$(ATTACH_DOCTITLE)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1145
	  $(call OptionPair,-windowtitle,$(ATTACH_WINDOWTITLE) $(DRAFT_WINTITLE)); \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1146
	  $(call OptionPair,-header,$(ATTACH_HEADER)$(DRAFT_HEADER)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1147
	  $(call OptionPair,-bottom,$(ATTACH_BOTTOM)$(DRAFT_BOTTOM)) ; \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1148
	  $(call OptionTrip,-linkoffline,$(ATTACH2COREAPI),$(COREAPI_DOCSDIR)/); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1149
	) >> $@
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1150
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1151
# Create a file with the package names in it
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
  1152
$(ATTACH_PACKAGES_FILE): $(call PackageDependencies,$(ATTACH_PKGS))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1153
	$(prep-target)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1154
	$(call PackageFilter,$(ATTACH_PKGS))
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1155
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1156
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1157
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1158
# jconsoledocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1159
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1160
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1161
ALL_OTHER_TARGETS += jconsoledocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1162
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1163
JCONSOLE_DOCDIR := $(JDK_API_DOCSDIR)/jconsole/spec
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1164
JCONSOLE2COREAPI := ../../$(JDKJRE2COREAPI)
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1165
JCONSOLE_DOCTITLE := JConsole API
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1166
JCONSOLE_WINDOWTITLE := JConsole API
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1167
JCONSOLE_HEADER := <strong>JConsole API</strong>
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1168
JCONSOLE_BOTTOM := $(call CommonBottom,$(JCONSOLE_FIRST_COPYRIGHT_YEAR))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1169
# JCONSOLE_PKGS is located in NON_CORE_PKGS.gmk
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1170
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1171
JCONSOLE_INDEX_HTML = $(JCONSOLE_DOCDIR)/index.html
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1172
JCONSOLE_OPTIONS_FILE = $(DOCSTMPDIR)/jconsole.options
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1173
JCONSOLE_PACKAGES_FILE = $(DOCSTMPDIR)/jconsole.packages
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1174
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1175
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1176
JCONSOLE_MODULES = jdk.jconsole
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1177
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1178
jconsoledocs: $(JCONSOLE_INDEX_HTML)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1179
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1180
# Set relative location to core api document root
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1181
$(JCONSOLE_INDEX_HTML): GET2DOCSDIR=$(JCONSOLE2COREAPI)/..
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1182
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1183
# Run javadoc if the index file is out of date or missing
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
  1184
$(JCONSOLE_INDEX_HTML): $(JCONSOLE_OPTIONS_FILE) $(JCONSOLE_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1185
	$(prep-javadoc)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1186
	$(call JavadocSummary,$(JCONSOLE_OPTIONS_FILE),$(JCONSOLE_PACKAGES_FILE))
29176
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
  1187
	$(JAVADOC_CMD_SMALL) -d $(@D) \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1188
	    @$(JCONSOLE_OPTIONS_FILE) @$(JCONSOLE_PACKAGES_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1189
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1190
# Create file with javadoc options in it
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1191
$(JCONSOLE_OPTIONS_FILE):
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1192
	$(prep-target)
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
  1193
	@($(call COMMON_JAVADOCFLAGS) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
  1194
          $(call COMMON_JAVADOCTAGS) ; \
22033
c323078abaf4 8031081: Use separate doclint flags for different doc bundles
darcy
parents: 21759
diff changeset
  1195
	  $(call OptionOnly,-Xdoclint:none) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1196
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1197
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1198
	  $(call OptionPair,-addmods,$(JCONSOLE_MODULES)) ; \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1199
	  $(call OptionPair,-encoding,ascii) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1200
	  $(call OptionOnly,-nodeprecatedlist) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1201
	  $(call OptionPair,-doctitle,$(JCONSOLE_DOCTITLE)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1202
	  $(call OptionPair,-windowtitle,$(JCONSOLE_WINDOWTITLE) $(DRAFT_WINTITLE)); \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1203
	  $(call OptionPair,-header,$(JCONSOLE_HEADER)$(DRAFT_HEADER)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1204
	  $(call OptionPair,-bottom,$(JCONSOLE_BOTTOM)$(DRAFT_BOTTOM)) ; \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1205
	  $(call OptionTrip,-linkoffline,$(JCONSOLE2COREAPI),$(COREAPI_DOCSDIR)/); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1206
	) >> $@
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1207
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1208
# Create a file with the package names in it
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
  1209
$(JCONSOLE_PACKAGES_FILE): $(call PackageDependencies,$(JCONSOLE_PKGS))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1210
	$(prep-target)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1211
	$(call PackageFilter,$(JCONSOLE_PKGS))
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1212
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1213
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1214
#
36792
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1215
# jshellapidocs
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1216
#
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1217
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1218
ALL_OTHER_TARGETS += jshellapidocs
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1219
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1220
JSHELLAPI_DOCDIR := $(JDK_API_DOCSDIR)/jshell
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1221
JSHELLAPI2COREAPI := ../../$(JDKJRE2COREAPI)
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1222
JSHELLAPI_DOCTITLE := JShell API
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1223
JSHELLAPI_WINDOWTITLE := JShell API
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1224
JSHELLAPI_HEADER := <strong>JSHELL API</strong>
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1225
JSHELLAPI_BOTTOM := $(call CommonBottom,$(JSHELLAPI_FIRST_COPYRIGHT_YEAR))
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1226
JSHELLAPI_GROUPNAME := Packages
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1227
JSHELLAPI_REGEXP := jdk.jshell.*
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1228
# JSHELLAPI_PKGS is located in NON_CORE_PKGS.gmk
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1229
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1230
JSHELLAPI_INDEX_HTML = $(JSHELLAPI_DOCDIR)/index.html
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1231
JSHELLAPI_OPTIONS_FILE = $(DOCSTMPDIR)/jshellapi.options
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1232
JSHELLAPI_PACKAGES_FILE = $(DOCSTMPDIR)/jshellapi.packages
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1233
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1234
# The modules required to be documented
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1235
JSHELLAPI_MODULES = jdk.jshell
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1236
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1237
jshellapidocs: $(JSHELLAPI_INDEX_HTML)
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1238
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1239
# Set relative location to core api document root
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1240
$(JSHELLAPI_INDEX_HTML): GET2DOCSDIR=$(JSHELLAPI2COREAPI)/..
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1241
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1242
# Run javadoc if the index file is out of date or missing
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1243
$(JSHELLAPI_INDEX_HTML): $(JSHELLAPI_OPTIONS_FILE) $(JSHELLAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1244
	$(prep-javadoc)
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1245
	$(call JavadocSummary,$(JSHELLAPI_OPTIONS_FILE),$(JSHELLAPI_PACKAGES_FILE))
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1246
	$(JAVADOC_CMD_SMALL) -d $(@D) \
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1247
	    @$(JSHELLAPI_OPTIONS_FILE) @$(JSHELLAPI_PACKAGES_FILE)
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1248
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1249
# Create file with javadoc options in it
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1250
$(JSHELLAPI_OPTIONS_FILE):
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1251
	$(prep-target)
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1252
	@($(call COMMON_JAVADOCFLAGS) ; \
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1253
          $(call COMMON_JAVADOCTAGS) ; \
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1254
	  $(call OptionOnly,-Xdoclint:all) ; \
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1255
          $(call OptionPair,-system,none) ; \
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1256
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1257
	  $(call OptionPair,-addmods,$(JSHELLAPI_MODULES)) ; \
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1258
	  $(call OptionPair,-encoding,ascii) ; \
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1259
	  $(call OptionPair,-doctitle,$(JSHELLAPI_DOCTITLE)) ; \
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1260
	  $(call OptionPair,-windowtitle,$(JSHELLAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1261
	  $(call OptionPair,-header,$(JSHELLAPI_HEADER)$(DRAFT_HEADER)) ; \
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1262
	  $(call OptionPair,-bottom,$(JSHELLAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1263
	  $(call OptionTrip,-group,$(JSHELLAPI_GROUPNAME),$(JSHELLAPI_REGEXP)); \
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1264
	  $(call OptionTrip,-linkoffline,$(JSHELLAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1265
	) >> $@
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1266
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1267
# Create a file with the package names in it
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1268
$(JSHELLAPI_PACKAGES_FILE): $(call PackageDependencies,$(JSHELLAPI_PKGS))
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1269
	$(prep-target)
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1270
	$(call PackageFilter,$(JSHELLAPI_PKGS))
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1271
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1272
#############################################################
09d2e1165981 8153243: make docs should generate JShell API docs
jlahoda
parents: 36506
diff changeset
  1273
#
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1274
# treeapidocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1275
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1276
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1277
ALL_OTHER_TARGETS += treeapidocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1278
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1279
TREEAPI_DOCDIR := $(JDK_API_DOCSDIR)/javac/tree
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1280
TREEAPI2COREAPI := ../../$(JDKJRE2COREAPI)
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1281
TREEAPI_DOCTITLE := Compiler Tree API
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1282
TREEAPI_WINDOWTITLE := Compiler Tree API
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1283
TREEAPI_HEADER := <strong>Compiler Tree API</strong>
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1284
TREEAPI_BOTTOM := $(call CommonBottom,$(TREEAPI_FIRST_COPYRIGHT_YEAR))
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1285
TREEAPI_GROUPNAME := Packages
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1286
TREEAPI_REGEXP := com.sun.source.*
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1287
# TREEAPI_PKGS is located in NON_CORE_PKGS.gmk
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1288
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1289
TREEAPI_INDEX_HTML = $(TREEAPI_DOCDIR)/index.html
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1290
TREEAPI_OPTIONS_FILE = $(DOCSTMPDIR)/treeapi.options
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1291
TREEAPI_PACKAGES_FILE = $(DOCSTMPDIR)/treeapi.packages
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1292
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1293
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1294
TREEAPI_MODULES = jdk.compiler
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1295
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1296
treeapidocs: $(TREEAPI_INDEX_HTML)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1297
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1298
# Set relative location to core api document root
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1299
$(TREEAPI_INDEX_HTML): GET2DOCSDIR=$(TREEAPI2COREAPI)/..
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1300
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1301
# Run javadoc if the index file is out of date or missing
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
  1302
$(TREEAPI_INDEX_HTML): $(TREEAPI_OPTIONS_FILE) $(TREEAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1303
	$(prep-javadoc)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1304
	$(call JavadocSummary,$(TREEAPI_OPTIONS_FILE),$(TREEAPI_PACKAGES_FILE))
29176
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
  1305
	$(JAVADOC_CMD_SMALL) -d $(@D) \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1306
	    @$(TREEAPI_OPTIONS_FILE) @$(TREEAPI_PACKAGES_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1307
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1308
# Create file with javadoc options in it
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1309
$(TREEAPI_OPTIONS_FILE):
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1310
	$(prep-target)
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
  1311
	@($(call COMMON_JAVADOCFLAGS) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
  1312
          $(call COMMON_JAVADOCTAGS) ; \
25043
b5598c2ddf6f 8048302: Update bug reporting URL in make/Javadoc.gmk
darcy
parents: 24232
diff changeset
  1313
	  $(call OptionOnly,-Xdoclint:all) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1314
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1315
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1316
	  $(call OptionPair,-addmods,$(TREEAPI_MODULES)) ; \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1317
	  $(call OptionPair,-encoding,ascii) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1318
	  $(call OptionPair,-doctitle,$(TREEAPI_DOCTITLE)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1319
	  $(call OptionPair,-windowtitle,$(TREEAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1320
	  $(call OptionPair,-header,$(TREEAPI_HEADER)$(DRAFT_HEADER)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1321
	  $(call OptionPair,-bottom,$(TREEAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1322
	  $(call OptionTrip,-group,$(TREEAPI_GROUPNAME),$(TREEAPI_REGEXP)); \
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1323
	  $(call OptionTrip,-linkoffline,$(TREEAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1324
	) >> $@
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1325
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1326
# Create a file with the package names in it
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
  1327
$(TREEAPI_PACKAGES_FILE): $(call PackageDependencies,$(TREEAPI_PKGS))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1328
	$(prep-target)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1329
	$(call PackageFilter,$(TREEAPI_PKGS))
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1330
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1331
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1332
#
27596
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1333
# nashornapidocs
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1334
#
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1335
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1336
ALL_OTHER_TARGETS += nashornapidocs
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1337
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1338
NASHORNAPI_DOCDIR := $(JDK_API_DOCSDIR)/nashorn
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1339
NASHORNAPI2COREAPI := ../$(JDKJRE2COREAPI)
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1340
NASHORNAPI_DOCTITLE := Nashorn API
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1341
NASHORNAPI_WINDOWTITLE := Nashorn API
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1342
NASHORNAPI_HEADER := <strong>Nashorn API</strong>
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1343
NASHORNAPI_BOTTOM := $(call CommonBottom,$(NASHORNAPI_FIRST_COPYRIGHT_YEAR))
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1344
NASHORNAPI_GROUPNAME := Packages
30416
6216eb71e929 8079900: javadoc is missing for jdk.nashorn.api.tree package
sundar
parents: 29851
diff changeset
  1345
NASHORNAPI_REGEXP := jdk.nashorn.api.*
27596
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1346
# NASHORNAPI_PKGS is located in NON_CORE_PKGS.gmk
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1347
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1348
NASHORNAPI_INDEX_HTML = $(NASHORNAPI_DOCDIR)/index.html
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1349
NASHORNAPI_OPTIONS_FILE = $(DOCSTMPDIR)/nashornapi.options
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1350
NASHORNAPI_PACKAGES_FILE = $(DOCSTMPDIR)/nashornapi.packages
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1351
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1352
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1353
NASHORNAPI_MODULES = jdk.scripting.nashorn
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1354
27596
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1355
nashornapidocs: $(NASHORNAPI_INDEX_HTML)
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1356
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1357
# Set relative location to core api document root
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1358
$(NASHORNAPI_INDEX_HTML): GET2DOCSDIR=$(NASHORNAPI2COREAPI)/..
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1359
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1360
# Run javadoc if the index file is out of date or missing
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1361
$(NASHORNAPI_INDEX_HTML): $(NASHORNAPI_OPTIONS_FILE) $(NASHORNAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1362
	$(prep-javadoc)
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1363
	$(call JavadocSummary,$(NASHORNAPI_OPTIONS_FILE),$(NASHORNAPI_PACKAGES_FILE))
29176
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
  1364
	$(JAVADOC_CMD_SMALL) -d $(@D) \
27596
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1365
	    @$(NASHORNAPI_OPTIONS_FILE) @$(NASHORNAPI_PACKAGES_FILE)
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1366
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1367
# Create file with javadoc options in it
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1368
$(NASHORNAPI_OPTIONS_FILE):
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1369
	$(prep-target)
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1370
	@($(call COMMON_JAVADOCFLAGS) ; \
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1371
          $(call COMMON_JAVADOCTAGS) ; \
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1372
	  $(call OptionOnly,-Xdoclint:all) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1373
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1374
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1375
	  $(call OptionPair,-addmods,$(NASHORNAPI_MODULES)) ; \
27596
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1376
	  $(call OptionPair,-encoding,ascii) ; \
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1377
	  $(call OptionPair,-doctitle,$(NASHORNAPI_DOCTITLE)) ; \
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1378
	  $(call OptionPair,-windowtitle,$(NASHORNAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1379
	  $(call OptionPair,-header,$(NASHORNAPI_HEADER)$(DRAFT_HEADER)) ; \
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1380
	  $(call OptionPair,-bottom,$(NASHORNAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1381
	  $(call OptionTrip,-group,$(NASHORNAPI_GROUPNAME),$(NASHORNAPI_REGEXP)); \
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1382
	  $(call OptionTrip,-linkoffline,$(NASHORNAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1383
	) >> $@
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1384
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1385
# Create a file with the package names in it
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1386
$(NASHORNAPI_PACKAGES_FILE): $(call PackageDependencies,$(NASHORNAPI_PKGS))
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1387
	$(prep-target)
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1388
	$(call PackageFilter,$(NASHORNAPI_PKGS))
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1389
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1390
#############################################################
da40665398a4 8066146: jdk.nashorn.api.scripting package javadoc should be included in jdk docs
sundar
parents: 27595
diff changeset
  1391
#
35369
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1392
# dynalinkapidocs
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1393
#
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1394
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1395
ALL_OTHER_TARGETS += dynalinkapidocs
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1396
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1397
DYNALINKAPI_DOCDIR := $(JDK_API_DOCSDIR)/dynalink
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1398
DYNALINKAPI2COREAPI := ../$(JDKJRE2COREAPI)
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1399
DYNALINKAPI_DOCTITLE := Dynalink API
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1400
DYNALINKAPI_WINDOWTITLE := Dynalink API
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1401
DYNALINKAPI_HEADER := <strong>Dynalink API</strong>
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1402
DYNALINKAPI_BOTTOM := $(call CommonBottom,$(DYNALINKAPI_FIRST_COPYRIGHT_YEAR))
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1403
DYNALINKAPI_GROUPNAME := Packages
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1404
DYNALINKAPI_REGEXP := jdk.dynalink.*
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1405
# DYNALINKAPI_PKGS is located in NON_CORE_PKGS.gmk
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1406
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1407
DYNALINKAPI_INDEX_HTML = $(DYNALINKAPI_DOCDIR)/index.html
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1408
DYNALINKAPI_OPTIONS_FILE = $(DOCSTMPDIR)/dynalinkapi.options
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1409
DYNALINKAPI_PACKAGES_FILE = $(DOCSTMPDIR)/dynalinkapi.packages
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1410
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1411
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1412
DYNALINKAPI_MODULES = jdk.dynalink
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1413
35369
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1414
dynalinkapidocs: $(DYNALINKAPI_INDEX_HTML)
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1415
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1416
# Set relative location to core api document root
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1417
$(DYNALINKAPI_INDEX_HTML): GET2DOCSDIR=$(DYNALINKAPI2COREAPI)/..
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1418
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1419
# Run javadoc if the index file is out of date or missing
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1420
$(DYNALINKAPI_INDEX_HTML): $(DYNALINKAPI_OPTIONS_FILE) $(DYNALINKAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1421
	$(prep-javadoc)
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1422
	$(call JavadocSummary,$(DYNALINKAPI_OPTIONS_FILE),$(DYNALINKAPI_PACKAGES_FILE))
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1423
	$(JAVADOC_CMD_SMALL) -d $(@D) \
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1424
	    @$(DYNALINKAPI_OPTIONS_FILE) @$(DYNALINKAPI_PACKAGES_FILE)
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1425
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1426
# Create file with javadoc options in it
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1427
$(DYNALINKAPI_OPTIONS_FILE):
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1428
	$(prep-target)
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1429
	@($(call COMMON_JAVADOCFLAGS) ; \
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1430
          $(call COMMON_JAVADOCTAGS) ; \
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1431
	  $(call OptionOnly,-Xdoclint:all) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1432
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1433
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1434
	  $(call OptionPair,-addmods,$(DYNALINKAPI_MODULES)) ; \
35369
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1435
	  $(call OptionPair,-encoding,ascii) ; \
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1436
	  $(call OptionPair,-doctitle,$(DYNALINKAPI_DOCTITLE)) ; \
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1437
	  $(call OptionPair,-windowtitle,$(DYNALINKAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1438
	  $(call OptionPair,-header,$(DYNALINKAPI_HEADER)$(DRAFT_HEADER)) ; \
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1439
	  $(call OptionPair,-bottom,$(DYNALINKAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1440
	  $(call OptionTrip,-group,$(DYNALINKAPI_GROUPNAME),$(DYNALINKAPI_REGEXP)); \
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1441
	  $(call OptionTrip,-linkoffline,$(DYNALINKAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1442
	) >> $@
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1443
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1444
# Create a file with the package names in it
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1445
$(DYNALINKAPI_PACKAGES_FILE): $(call PackageDependencies,$(DYNALINKAPI_PKGS))
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1446
	$(prep-target)
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1447
	$(call PackageFilter,$(DYNALINKAPI_PKGS))
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1448
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1449
#############################################################
a68e46d94261 8148617: top level make docs target does not generate javadocs for dynalink API
sundar
parents: 35367
diff changeset
  1450
#
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1451
# sctpdocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1452
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1453
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1454
ALL_OTHER_TARGETS += sctpdocs
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1455
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1456
SCTPAPI_DOCDIR := $(JRE_API_DOCSDIR)/nio/sctp/spec
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1457
SCTPAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1458
SCTPAPI_DOCTITLE := SCTP API
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1459
SCTPAPI_WINDOWTITLE := SCTP API
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1460
SCTPAPI_HEADER := <strong>SCTP API</strong>
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1461
SCTPAPI_BOTTOM := $(call CommonBottom,$(SCTPAPI_FIRST_COPYRIGHT_YEAR))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1462
# SCTPAPI_PKGS is located in NON_CORE_PKGS.gmk
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1463
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1464
SCTPAPI_INDEX_HTML = $(SCTPAPI_DOCDIR)/index.html
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1465
SCTPAPI_OPTIONS_FILE = $(DOCSTMPDIR)/sctp.options
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1466
SCTPAPI_PACKAGES_FILE = $(DOCSTMPDIR)/sctp.packages
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1467
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1468
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1469
SCTPAPI_MODULES = jdk.sctp
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1470
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1471
sctpdocs: $(SCTPAPI_INDEX_HTML)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1472
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1473
# Set relative location to core api document root
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1474
$(SCTPAPI_INDEX_HTML): GET2DOCSDIR=$(SCTPAPI2COREAPI)/..
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1475
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1476
# Run javadoc if the index file is out of date or missing
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
  1477
$(SCTPAPI_INDEX_HTML): $(SCTPAPI_OPTIONS_FILE) $(SCTPAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1478
	$(prep-javadoc)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1479
	$(call JavadocSummary,$(SCTPAPI_OPTIONS_FILE),$(SCTPAPI_PACKAGES_FILE))
29176
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
  1480
	$(JAVADOC_CMD_SMALL) -d $(@D) \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1481
	    @$(SCTPAPI_OPTIONS_FILE) @$(SCTPAPI_PACKAGES_FILE)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1482
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1483
# Create file with javadoc options in it
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1484
$(SCTPAPI_OPTIONS_FILE):
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1485
	$(prep-target)
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
  1486
	@($(call COMMON_JAVADOCFLAGS) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
  1487
          $(call COMMON_JAVADOCTAGS) ; \
22033
c323078abaf4 8031081: Use separate doclint flags for different doc bundles
darcy
parents: 21759
diff changeset
  1488
	  $(call OptionOnly,-Xdoclint:none) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1489
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1490
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1491
	  $(call OptionPair,-addmods,$(SCTPAPI_MODULES)) ; \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1492
	  $(call OptionPair,-encoding,ascii) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1493
	  $(call OptionOnly,-nodeprecatedlist) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1494
	  $(call OptionPair,-doctitle,$(SCTPAPI_DOCTITLE)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1495
	  $(call OptionPair,-windowtitle,$(SCTPAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1496
	  $(call OptionPair,-header,$(SCTPAPI_HEADER)$(DRAFT_HEADER)) ; \
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1497
	  $(call OptionPair,-bottom,$(SCTPAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1498
	  $(call OptionTrip,-linkoffline,$(SCTPAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
20363
fa7663fc5d50 8001931: The new build system whitespace cleanup
ihse
parents: 17067
diff changeset
  1499
	) >> $@
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1500
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1501
# Create a file with the package names in it
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
  1502
$(SCTPAPI_PACKAGES_FILE): $(call PackageDependencies,$(SCTPAPI_PKGS))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1503
	$(prep-target)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1504
	$(call PackageFilter,$(SCTPAPI_PKGS))
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1505
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1506
#############################################################
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1507
#
29851
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1508
# jaccessdocs - Java Accessibility Utilities
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1509
#
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1510
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1511
ALL_OTHER_TARGETS += jaccessdocs
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1512
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1513
JACCESSAPI_DOCDIR := $(JRE_API_DOCSDIR)/accessibility/jaccess/spec
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1514
JACCESSAPI2COREAPI := ../../../$(JDKJRE2COREAPI)
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1515
JACCESSAPI_DOCTITLE := JACCESS API
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1516
JACCESSAPI_WINDOWTITLE := JACCESS API
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1517
JACCESSAPI_HEADER := <strong>JACCESS API</strong>
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1518
JACCESSAPI_BOTTOM := $(call CommonBottom,$(JACCESSAPI_FIRST_COPYRIGHT_YEAR))
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1519
# JACCESSAPI_PKGS is located in NON_CORE_PKGS.gmk
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1520
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1521
JACCESSAPI_INDEX_HTML = $(JACCESSAPI_DOCDIR)/index.html
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1522
JACCESSAPI_OPTIONS_FILE = $(DOCSTMPDIR)/jaccess.options
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1523
JACCESSAPI_PACKAGES_FILE = $(DOCSTMPDIR)/jaccess.packages
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1524
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1525
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1526
JACCESSAPI_MODULES = jdk.accessibility
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1527
29851
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1528
jaccessdocs: $(JACCESSAPI_INDEX_HTML)
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1529
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1530
# Set relative location to core api document root
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1531
$(JACCESSAPI_INDEX_HTML): GET2DOCSDIR=$(JACCESSAPI2COREAPI)/..
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1532
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1533
# Run javadoc if the index file is out of date or missing
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1534
$(JACCESSAPI_INDEX_HTML): $(JACCESSAPI_OPTIONS_FILE) $(JACCESSAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1535
	$(prep-javadoc)
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1536
	$(call JavadocSummary,$(JACCESSAPI_OPTIONS_FILE),$(JACCESSAPI_PACKAGES_FILE))
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1537
	$(JAVADOC_CMD) -d $(@D) \
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1538
	    @$(JACCESSAPI_OPTIONS_FILE) @$(JACCESSAPI_PACKAGES_FILE)
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1539
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1540
# Create file with javadoc options in it
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1541
$(JACCESSAPI_OPTIONS_FILE):
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1542
	$(prep-target)
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1543
	@($(call COMMON_JAVADOCFLAGS) ; \
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1544
	  $(call COMMON_JAVADOCTAGS) ; \
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1545
	  $(call OptionOnly,-Xdoclint:all) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1546
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1547
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1548
	  $(call OptionPair,-addmods,$(JACCESSAPI_MODULES)) ; \
29851
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1549
	  $(call OptionPair,-encoding,ascii) ; \
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1550
	  $(call OptionOnly,-nodeprecatedlist) ; \
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1551
	  $(call OptionPair,-doctitle,$(JACCESSAPI_DOCTITLE)) ; \
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1552
	  $(call OptionPair,-windowtitle,$(JACCESSAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1553
	  $(call OptionPair,-header,$(JACCESSAPI_HEADER)$(DRAFT_HEADER)) ; \
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1554
	  $(call OptionPair,-bottom,$(JACCESSAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1555
	  $(call OptionTrip,-linkoffline,$(JACCESSAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1556
	) >> $@
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1557
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1558
# Create a file with the package names in it
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1559
$(JACCESSAPI_PACKAGES_FILE): $(call PackageDependencies,$(JACCESSAPI_PKGS))
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1560
	$(prep-target)
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1561
	$(call PackageFilter,$(JACCESSAPI_PKGS))
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1562
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1563
#############################################################
81a61a04e2fe 8076182: Open Source Java Access Bridge - Create Patch for JEP C127 8055831
ptbrunet
parents: 29176
diff changeset
  1564
#
23836
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1565
# jdk.net docs
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1566
#
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1567
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1568
ALL_OTHER_TARGETS += jdknetdocs
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1569
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1570
JDKNET_DOCDIR := $(JRE_API_DOCSDIR)/net/socketoptions/spec
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1571
JDKNET2COREAPI := ../../../$(JDKJRE2COREAPI)
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1572
JDKNET_DOCTITLE := jdk.net API
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1573
JDKNET_WINDOWTITLE := jdk.net API
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1574
JDKNET_HEADER := <strong>jdk.net API</strong>
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1575
JDKNET_BOTTOM := $(call CommonBottom,$(JDKNET_FIRST_COPYRIGHT_YEAR))
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1576
JDKNET_PKGS := jdk.net
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1577
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1578
JDKNET_INDEX_HTML = $(JDKNET_DOCDIR)/index.html
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1579
JDKNET_OPTIONS_FILE = $(DOCSTMPDIR)/jdknet.options
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1580
JDKNET_PACKAGES_FILE = $(DOCSTMPDIR)/jdknet.packages
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1581
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1582
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1583
JDKNET_MODULES = java.base
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1584
23836
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1585
jdknetdocs: $(JDKNET_INDEX_HTML)
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1586
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1587
# Set relative location to core api document root
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1588
$(JDKNET_INDEX_HTML): GET2DOCSDIR=$(JDKNET2COREAPI)/..
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1589
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1590
# Run javadoc if the index file is out of date or missing
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
  1591
$(JDKNET_INDEX_HTML): $(JDKNET_OPTIONS_FILE) $(JDKNET_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
23836
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1592
	$(prep-javadoc)
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1593
	$(call JavadocSummary,$(JDKNET_OPTIONS_FILE),$(JDKNET_PACKAGES_FILE))
29176
45baf3cdc876 8074395: Random build failures in javadoc on Solaris
erikj
parents: 28010
diff changeset
  1594
	$(JAVADOC_CMD_SMALL) -d $(@D) \
23836
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1595
	    @$(JDKNET_OPTIONS_FILE) @$(JDKNET_PACKAGES_FILE)
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1596
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1597
# Create file with javadoc options in it
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1598
$(JDKNET_OPTIONS_FILE):
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1599
	$(prep-target)
25614
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
  1600
	@($(call COMMON_JAVADOCFLAGS) ; \
0d18591d71d8 8051010: Support @apiNote, @implSpec and @implNote in all javadoc bundles
mduigou
parents: 25046
diff changeset
  1601
          $(call COMMON_JAVADOCTAGS) ; \
23836
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1602
	  $(call OptionOnly,-Xdoclint:none) ; \
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1603
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1604
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1605
	  $(call OptionPair,-addmods,$(JDKNET_MODULES)) ; \
23836
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1606
	  $(call OptionPair,-encoding,ascii) ; \
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1607
	  $(call OptionOnly,-nodeprecatedlist) ; \
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1608
	  $(call OptionPair,-doctitle,$(JDKNET_DOCTITLE)) ; \
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1609
	  $(call OptionPair,-windowtitle,$(JDKNET_WINDOWTITLE) $(DRAFT_WINTITLE)); \
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1610
	  $(call OptionPair,-header,$(JDKNET_HEADER)$(DRAFT_HEADER)); \
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1611
	  $(call OptionPair,-bottom,$(JDKNET_BOTTOM)$(DRAFT_BOTTOM)); \
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1612
	  $(call OptionTrip,-linkoffline,$(JDKNET2COREAPI),$(COREAPI_DOCSDIR)/); \
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1613
	) >> $@
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1614
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1615
# Create a file with the package names in it
23986
1809fb8266cb 8041487: Fix proper dependencies for correct incremental build of javadocs
erikj
parents: 23836
diff changeset
  1616
$(JDKNET_PACKAGES_FILE): $(call PackageDependencies,$(JDKNET_PKGS))
23836
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1617
	$(prep-target)
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1618
	$(call PackageFilter,$(JDKNET_PKGS))
a199f7dbfbc6 8036979: Support java.net.SocketOption<> in java.net socket types
michaelm
parents: 22033
diff changeset
  1619
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1620
#############################################################
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1621
#
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1622
# jlink plugin API docs
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1623
#
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1624
# TODO: Need to decide when the plugin API is ready to publish as experimental API.
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1625
# This target is temporarily added for internal use for now.
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1626
#        
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1627
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1628
ALL_OTHER_TARGETS += jlinkdocs
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1629
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1630
JLINK_PLUGIN_FIRST_COPYRIGHT_YEAR = 2015
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1631
JLINK_PLUGIN_DOCDIR := $(JDK_API_DOCSDIR)/jlink
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1632
JLINK_PLUGIN2COREAPI := ../$(JDKJRE2COREAPI)
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1633
JLINK_PLUGIN_DOCTITLE := JLink Plugin API - EXPERIMENTAL
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1634
JLINK_PLUGIN_WINDOWTITLE := JLink Plugin API - EXPERIMENTAL
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1635
JLINK_PLUGIN_HEADER := <strong>JLink Plugin API - EXPERIMENTAL</strong>
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1636
JLINK_PLUGIN_BOTTOM := $(call CommonBottom,$(JLINK_PLUGIN_FIRST_COPYRIGHT_YEAR))
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1637
JLINK_PLUGIN_PKGS = jdk.tools.jlink \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1638
    jdk.tools.jlink.builder \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1639
    jdk.tools.jlink.plugin
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1640
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1641
JLINK_PLUGIN_INDEX_HTML = $(JLINK_PLUGIN_DOCDIR)/index.html
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1642
JLINK_PLUGIN_OPTIONS_FILE = $(DOCSTMPDIR)/jlinkplugins.options
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1643
JLINK_PLUGIN_PACKAGES_FILE = $(DOCSTMPDIR)/jlinkplugins.packages
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1644
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1645
# The modules required to be documented
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1646
JLINK_PLUGIN_MODULES = jdk.jlink
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1647
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1648
jlinkdocs: $(JLINK_PLUGIN_INDEX_HTML)
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1649
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1650
# Set relative location to core api document root
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1651
$(JLINK_PLUGIN_INDEX_HTML): GET2DOCSDIR=$(JLINK_PLUGIN2COREAPI)/..
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1652
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1653
# Run javadoc if the index file is out of date or missing
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1654
$(JLINK_PLUGIN_INDEX_HTML): $(JLINK_PLUGIN_OPTIONS_FILE) $(JLINK_PLUGIN_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1655
	$(prep-javadoc)
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1656
	$(call JavadocSummary,$(JLINK_PLUGIN_OPTIONS_FILE),$(JLINK_PLUGIN_PACKAGES_FILE))
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1657
	$(JAVADOC_CMD_SMALL) -d $(@D) \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1658
	    @$(JLINK_PLUGIN_OPTIONS_FILE) @$(JLINK_PLUGIN_PACKAGES_FILE)
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1659
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1660
# Create file with javadoc options in it
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1661
$(JLINK_PLUGIN_OPTIONS_FILE):
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1662
	$(prep-target)
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1663
	@($(call COMMON_JAVADOCFLAGS) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1664
          $(call COMMON_JAVADOCTAGS) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1665
	  $(call OptionOnly,-Xdoclint:none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1666
          $(call OptionPair,-system,none) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1667
	  $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1668
	  $(call OptionPair,-addmods,$(JLINK_PLUGIN_MODULES)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1669
	  $(call OptionPair,-encoding,ascii) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1670
	  $(call OptionOnly,-nodeprecatedlist) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1671
	  $(call OptionPair,-doctitle,$(JLINK_PLUGIN_DOCTITLE)) ; \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1672
	  $(call OptionPair,-windowtitle,$(JLINK_PLUGIN_WINDOWTITLE) $(DRAFT_WINTITLE)); \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1673
	  $(call OptionPair,-header,$(JLINK_PLUGIN_HEADER)$(DRAFT_HEADER)); \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1674
	  $(call OptionPair,-bottom,$(JLINK_PLUGIN_BOTTOM)$(DRAFT_BOTTOM)); \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1675
	  $(call OptionTrip,-linkoffline,$(JLINK_PLUGIN2COREAPI),$(COREAPI_DOCSDIR)/); \
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1676
	) >> $@
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1677
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1678
# Create a file with the package names in it
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1679
$(JLINK_PLUGIN_PACKAGES_FILE): $(call PackageDependencies,$(JLINK_PLUGIN_PKGS))
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1680
	$(prep-target)
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1681
	$(call PackageFilter,$(JLINK_PLUGIN_PKGS))
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
  1682
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1683
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1684
otherdocs: $(ALL_OTHER_TARGETS)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1685
37034
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1686
#
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1687
# Add the core docs as prerequisite to the archive to trigger a rebuild
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1688
# if the core docs were rebuilt. Ideally any doc rebuild should trigger
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1689
# this, but the way prerequisites are currently setup in this file, that
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1690
# is hard to achieve.
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1691
#
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1692
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1693
$(JAVADOC_ARCHIVE): $(COREAPI_INDEX_FILE)
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1694
	$(call LogInfo, Compressing javadoc to single $(JAVADOC_ARCHIVE_NAME))
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1695
	$(MKDIR) -p $(JAVADOC_ARCHIVE_DIR)
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1696
	$(RM) -r $(JAVADOC_ARCHIVE_ASSEMBLY_DIR)
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1697
	$(MKDIR) -p $(JAVADOC_ARCHIVE_ASSEMBLY_DIR)
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1698
	all_roots=`$(FIND) $(DOCSDIR) | $(GREP) index.html | grep -v old/doclet`; \
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1699
	pushd $(JAVADOC_ARCHIVE_ASSEMBLY_DIR); \
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1700
	for index_file in $${all_roots} ; do \
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1701
	  target_dir=`dirname $${index_file}`; \
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1702
	  name=`$(ECHO) $${target_dir} | $(SED) "s;/spec;;" | $(SED) "s;.*/;;"`; \
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1703
	  $(LN) -s $${target_dir}  $${name}; \
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1704
	done; \
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1705
	$(ZIP) -q -r $(JAVADOC_ARCHIVE) * ; \
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1706
	popd ;
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1707
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
  1708
#############################################################
33926
3a19edba4808 8085822: JEP 223: New Version-String Scheme (initial integration)
ihse
parents: 30416
diff changeset
  1709
.PHONY: all docs coredocs otherdocs \
37034
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
  1710
     $(ALL_OTHER_TARGETS) zip-docs