author | dfuchs |
Mon, 18 Nov 2019 16:48:05 +0000 | |
changeset 59124 | d01fe40e9cd8 |
parent 58924 | c41d1303a87c |
permissions | -rw-r--r-- |
53995 | 1 |
# Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved. |
13697 | 2 |
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
3 |
# |
|
4 |
# This code is free software; you can redistribute it and/or modify it |
|
5 |
# under the terms of the GNU General Public License version 2 only, as |
|
6 |
# published by the Free Software Foundation. Oracle designates this |
|
7 |
# particular file as subject to the "Classpath" exception as provided |
|
8 |
# by Oracle in the LICENSE file that accompanied this code. |
|
9 |
# |
|
10 |
# This code is distributed in the hope that it will be useful, but WITHOUT |
|
11 |
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
12 |
# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
13 |
# version 2 for more details (a copy is included in the LICENSE file that |
|
14 |
# accompanied this code). |
|
15 |
# |
|
16 |
# You should have received a copy of the GNU General Public License version |
|
17 |
# 2 along with this work; if not, write to the Free Software Foundation, |
|
18 |
# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
19 |
# |
|
20 |
# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
21 |
# or visit www.oracle.com if you need additional information or have any |
|
22 |
# questions. |
|
23 |
# |
|
24 |
||
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
25 |
default: all |
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
26 |
|
13697 | 27 |
include $(SPEC) |
28 |
include MakeBase.gmk |
|
53995 | 29 |
include Execute.gmk |
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
30 |
include Modules.gmk |
52940
26e2cfebcfba
8214720: Add pandoc filter to improve html man page output
ihse
parents:
52714
diff
changeset
|
31 |
include ModuleTools.gmk |
44983 | 32 |
include ProcessMarkdown.gmk |
52940
26e2cfebcfba
8214720: Add pandoc filter to improve html man page output
ihse
parents:
52714
diff
changeset
|
33 |
include ToolsJdk.gmk |
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
34 |
include ZipArchive.gmk |
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
35 |
include TextFileProcessing.gmk |
13697 | 36 |
|
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
37 |
# This is needed to properly setup DOCS_MODULES. |
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
38 |
$(eval $(call ReadImportMetaData)) |
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
39 |
|
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
40 |
################################################################################ |
44827 | 41 |
# Hook to include the corresponding custom file, if present. |
47314 | 42 |
$(eval $(call IncludeCustomExtension, Docs.gmk)) |
44827 | 43 |
|
44 |
################################################################################ |
|
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
45 |
# This file generates all documentation for OpenJDK. |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
46 |
# |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
47 |
# We will generate API documentation for two different selections of the source |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
48 |
# code: "Java SE", which contains just the modules covered by the top-level |
48841 | 49 |
# module java.se and "JDK", which covers all of Java SE and also all |
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
50 |
# other available modules that should be documented, including imported modules, |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
51 |
# if any. |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
52 |
# |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
53 |
# We will also generate separate, free-standing specifications from either |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
54 |
# markdown or existing html files. |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
55 |
# |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
56 |
|
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
57 |
################################################################################ |
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
58 |
# Javadoc settings |
13697 | 59 |
|
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
60 |
# On top of the sources that was used to compile the JDK, we need some |
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
61 |
# extra java.rmi sources that are used just for javadoc. |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
62 |
MODULES_SOURCE_PATH := $(call PathList, $(call GetModuleSrcPath) \ |
47217 | 63 |
$(SUPPORT_OUTPUTDIR)/rmic/* $(TOPDIR)/src/*/share/doc/stub) |
36506 | 64 |
|
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
65 |
# URLs |
52318
124af9276e44
8213102: Oracle Unilinks are [301 Moved Permanently] to https://docs.oracle.com
jjg
parents:
52296
diff
changeset
|
66 |
JAVADOC_BASE_URL := https://docs.oracle.com/pls/topic/lookup?ctx=javase$(VERSION_NUMBER)&id=homepage |
52296
26207007d234
8212994: Links to Oracle websites should use "https:"
iris
parents:
52204
diff
changeset
|
67 |
BUG_SUBMIT_URL := https://bugreport.java.com/bugreport/ |
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
68 |
COPYRIGHT_URL := legal/copyright.html |
52296
26207007d234
8212994: Links to Oracle websites should use "https:"
iris
parents:
52204
diff
changeset
|
69 |
LICENSE_URL := https://www.oracle.com/technetwork/java/javase/terms/license/java$(VERSION_NUMBER)speclicense.html |
26207007d234
8212994: Links to Oracle websites should use "https:"
iris
parents:
52204
diff
changeset
|
70 |
REDISTRIBUTION_URL := https://www.oracle.com/technetwork/java/redist-137594.html |
44990
db3606f423a3
8140268: Generate link to specification license for JavaDoc API documentation
ihse
parents:
44989
diff
changeset
|
71 |
|
42135 | 72 |
# In order to get a specific ordering it's necessary to specify the total |
73 |
# ordering of tags as the tags are otherwise ordered in order of definition. |
|
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
74 |
JAVADOC_TAGS := \ |
42135 | 75 |
-tag beaninfo:X \ |
76 |
-tag revised:X \ |
|
77 |
-tag since.unbundled:X \ |
|
78 |
-tag spec:X \ |
|
79 |
-tag specdefault:X \ |
|
80 |
-tag Note:X \ |
|
81 |
-tag ToDo:X \ |
|
82 |
-tag 'apiNote:a:API Note:' \ |
|
83 |
-tag 'implSpec:a:Implementation Requirements:' \ |
|
84 |
-tag 'implNote:a:Implementation Note:' \ |
|
85 |
-tag param \ |
|
86 |
-tag return \ |
|
87 |
-tag throws \ |
|
54953
566fbca8a890
8224166: Create a taglet to better handle @jls and @jvms tags
jjg
parents:
54950
diff
changeset
|
88 |
-taglet build.tools.taglet.JSpec\$$JLS \ |
566fbca8a890
8224166: Create a taglet to better handle @jls and @jvms tags
jjg
parents:
54950
diff
changeset
|
89 |
-taglet build.tools.taglet.JSpec\$$JVMS \ |
44397
f932d6b9f7fe
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
44071
diff
changeset
|
90 |
-taglet build.tools.taglet.ModuleGraph \ |
54950 | 91 |
-taglet build.tools.taglet.ToolGuide \ |
42135 | 92 |
-tag since \ |
93 |
-tag serialData \ |
|
94 |
-tag factory \ |
|
95 |
-tag see \ |
|
44826
7a887996ee84
8178725: provide way to link to external documentation
ksrini
parents:
44734
diff
changeset
|
96 |
-taglet build.tools.taglet.ExtLink \ |
43285
223c3eea12e4
8173354: javadoc warning notice for types in Incubator Modules
chegar
parents:
43171
diff
changeset
|
97 |
-taglet build.tools.taglet.Incubating \ |
58713
ad69fd32778e
8226585: Improve javac messages for using a preview API
jlahoda
parents:
55675
diff
changeset
|
98 |
-taglet build.tools.taglet.Preview \ |
43285
223c3eea12e4
8173354: javadoc warning notice for types in Incubator Modules
chegar
parents:
43171
diff
changeset
|
99 |
-tagletpath $(BUILDTOOLS_OUTPUTDIR)/jdk_tools_classes \ |
44827 | 100 |
$(CUSTOM_JAVADOC_TAGS) \ |
42135 | 101 |
# |
102 |
||
47432
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
103 |
# The reference tags must stay stable to allow for comparisons across the |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
104 |
# development cycle. If JAVADOC_TAGS needs to change, make sure that |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
105 |
# REFERENCE_TAGS remains unchanged, by copying and hardcoding, if necessary. |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
106 |
REFERENCE_TAGS := $(JAVADOC_TAGS) |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
107 |
|
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
108 |
# Which doclint checks to ignore |
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
109 |
JAVADOC_DISABLED_DOCLINT := accessibility html missing syntax reference |
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
110 |
|
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
111 |
# The initial set of options for javadoc |
46087 | 112 |
JAVADOC_OPTIONS := -use -keywords -notimestamp \ |
113 |
-serialwarn -encoding ISO-8859-1 -docencoding UTF-8 -breakiterator \ |
|
49428
ce86061aff12
8199705: Docs.gmk needs to be updated to remove the -html5 option
bpatel
parents:
49075
diff
changeset
|
114 |
-splitIndex --system none -javafx --expand-requires transitive \ |
47429
aa31c0a9ebca
8189706: javadoc for the JDK APIs should summarize overridden methods with no specification changes
ksrini
parents:
47314
diff
changeset
|
115 |
--override-methods=summary |
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
116 |
|
47432
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
117 |
# The reference options must stay stable to allow for comparisons across the |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
118 |
# development cycle. |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
119 |
REFERENCE_OPTIONS := -XDignore.symbol.file=true -use -keywords -notimestamp \ |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
120 |
-serialwarn -encoding ISO-8859-1 -breakiterator -splitIndex --system none \ |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
121 |
-html5 -javafx --expand-requires transitive |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
122 |
|
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
123 |
# Should we add DRAFT stamps to the generated javadoc? |
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
124 |
ifeq ($(VERSION_IS_GA), true) |
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
125 |
IS_DRAFT := false |
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
126 |
else |
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
127 |
IS_DRAFT := true |
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
128 |
endif |
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
129 |
|
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
130 |
################################################################################ |
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
131 |
# General text snippets |
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
132 |
|
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
133 |
FULL_COMPANY_NAME := Oracle and/or its affiliates |
45616 | 134 |
COMPANY_ADDRESS := 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
13697 | 135 |
|
45616 | 136 |
JAVA_PLATFORM := Java Platform |
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
137 |
|
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
138 |
ifeq ($(IS_DRAFT), true) |
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
139 |
DRAFT_MARKER_STR := <br><strong>DRAFT $(VERSION_STRING)</strong> |
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
140 |
ifeq ($(VERSION_BUILD), 0) |
58924
c41d1303a87c
8233422: Extra space in the title of the HTML javadoc page
igerasim
parents:
58726
diff
changeset
|
141 |
DRAFT_MARKER_TITLE := $(SPACE)[ad-hoc build] |
43047
28be7f773e4e
8172562: Changing log level on Javadoc causes total rebuild
ihse
parents:
43044
diff
changeset
|
142 |
else |
58924
c41d1303a87c
8233422: Extra space in the title of the HTML javadoc page
igerasim
parents:
58726
diff
changeset
|
143 |
DRAFT_MARKER_TITLE := $(SPACE)[build $(VERSION_BUILD)] |
43047
28be7f773e4e
8172562: Changing log level on Javadoc causes total rebuild
ihse
parents:
43044
diff
changeset
|
144 |
endif |
45616 | 145 |
DRAFT_TEXT := This specification is not final and is subject to change. \ |
146 |
Use is subject to <a href="$(LICENSE_URL)">license terms</a>. |
|
47432
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
147 |
|
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
148 |
# Workaround stylesheet bug |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
149 |
HEADER_STYLE := style="margin-top: 9px;" |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
150 |
else |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
151 |
HEADER_STYLE := style="margin-top: 14px;" |
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
152 |
endif |
42135 | 153 |
|
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
154 |
# $1 - Relative prefix to COPYRIGHT_URL |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
155 |
COPYRIGHT_BOTTOM = \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
156 |
<a href="$(strip $1)$(COPYRIGHT_URL)">Copyright</a> \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
157 |
© 1993, $(COPYRIGHT_YEAR), $(FULL_COMPANY_NAME), \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
158 |
$(COMPANY_ADDRESS).<br>All rights reserved. \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
159 |
Use is subject to <a href="$(LICENSE_URL)">license terms</a> and the \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
160 |
<a href="$(REDISTRIBUTION_URL)">documentation redistribution policy</a>. \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
161 |
$(DRAFT_MARKER_STR) <!-- Version $(VERSION_STRING) --> |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
162 |
|
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
163 |
JAVADOC_BOTTOM := \ |
45616 | 164 |
<a href="$(BUG_SUBMIT_URL)">Report a bug or suggest an enhancement</a><br> \ |
165 |
For further API reference and developer documentation see the \ |
|
45108
8ad1bd49f4bc
8180328: Bad links in footer of all javadoc-generated pages
ihse
parents:
45105
diff
changeset
|
166 |
<a href="$(JAVADOC_BASE_URL)" target="_blank">Java SE \ |
45616 | 167 |
Documentation</a>, which contains more detailed, \ |
168 |
developer-targeted descriptions with conceptual overviews, definitions \ |
|
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
169 |
of terms, workarounds, and working code examples.<br> \ |
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
170 |
Java is a trademark or registered trademark of $(FULL_COMPANY_NAME) in \ |
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
171 |
the US and other countries.<br> \ |
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
172 |
$(call COPYRIGHT_BOTTOM, {@docroot}/../) |
45616 | 173 |
|
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
174 |
JAVADOC_TOP := \ |
45616 | 175 |
<div style="padding: 6px; text-align: center; font-size: 80%; \ |
176 |
font-family: DejaVu Sans, Arial, Helvetica, sans-serif; \ |
|
177 |
font-weight: normal;">$(DRAFT_TEXT)</div> |
|
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
178 |
|
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
179 |
################################################################################ |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
180 |
# JDK javadoc titles/text snippets |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
181 |
|
45616 | 182 |
JDK_SHORT_NAME := Java SE $(VERSION_SPECIFICATION) & JDK $(VERSION_SPECIFICATION) |
183 |
JDK_LONG_NAME := Java<sup>®</sup> Platform, Standard Edition \ |
|
45775
e333a1979702
8183251: Meta "keywords" tag malformed in overview-summary.html and related pages
mr
parents:
45617
diff
changeset
|
184 |
& Java Development Kit |
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
185 |
|
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
186 |
################################################################################ |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
187 |
# Java SE javadoc titles/text snippets |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
188 |
|
45616 | 189 |
JAVASE_SHORT_NAME := Java SE $(VERSION_SPECIFICATION) |
190 |
JAVASE_LONG_NAME := Java<sup>®</sup> Platform, Standard Edition |
|
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
191 |
|
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
192 |
################################################################################ |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
193 |
# Functions |
13697 | 194 |
|
58726
449555c346d9
8232639: Change module graph images to use SVG instead of PNG format.
jjg
parents:
58713
diff
changeset
|
195 |
# Helper function for creating a svg file from a dot file generated by the |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
196 |
# GenGraphs tool. |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
197 |
# param 1: SetupJavadocGeneration namespace ($1) |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
198 |
# param 2: module name |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
199 |
# |
58726
449555c346d9
8232639: Change module graph images to use SVG instead of PNG format.
jjg
parents:
58713
diff
changeset
|
200 |
define setup_gengraph_dot_to_svg |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
201 |
$1_$2_DOT_SRC := $$($1_GENGRAPHS_DIR)/$2.dot |
58726
449555c346d9
8232639: Change module graph images to use SVG instead of PNG format.
jjg
parents:
58713
diff
changeset
|
202 |
$1_$2_SVG_TARGET := $$($1_TARGET_DIR)/$2/module-graph.svg |
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
203 |
|
58726
449555c346d9
8232639: Change module graph images to use SVG instead of PNG format.
jjg
parents:
58713
diff
changeset
|
204 |
# For each module needing a graph, create a svg file from the dot file |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
205 |
# generated by the GenGraphs tool and store it in the target dir. |
58726
449555c346d9
8232639: Change module graph images to use SVG instead of PNG format.
jjg
parents:
58713
diff
changeset
|
206 |
$$(eval $$(call SetupExecute, gengraphs_svg_$1_$2, \ |
53995 | 207 |
INFO := Running dot for module graphs for $2, \ |
208 |
DEPS := $$(gengraphs_$1_TARGET), \ |
|
58726
449555c346d9
8232639: Change module graph images to use SVG instead of PNG format.
jjg
parents:
58713
diff
changeset
|
209 |
OUTPUT_FILE := $$($1_$2_SVG_TARGET), \ |
53995 | 210 |
SUPPORT_DIR := $$($1_GENGRAPHS_DIR), \ |
58726
449555c346d9
8232639: Change module graph images to use SVG instead of PNG format.
jjg
parents:
58713
diff
changeset
|
211 |
COMMAND := $$(DOT) -Tsvg -o $$($1_$2_SVG_TARGET) $$($1_$2_DOT_SRC), \ |
53995 | 212 |
)) |
42427
2c48c5ffb581
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
42290
diff
changeset
|
213 |
|
58726
449555c346d9
8232639: Change module graph images to use SVG instead of PNG format.
jjg
parents:
58713
diff
changeset
|
214 |
$1_MODULEGRAPH_TARGETS += $$($1_$2_SVG_TARGET) |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
215 |
endef |
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
216 |
|
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
217 |
# Helper function to create the overview.html file to use with the -overview |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
218 |
# javadoc option. |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
219 |
# Returns the filename as $1_OVERVIEW. |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
220 |
# |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
221 |
# param 1: SetupJavadocGeneration namespace ($1) |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
222 |
define create_overview_file |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
223 |
$1_OVERVIEW_TEXT := \ |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
224 |
<!DOCTYPE html> \ |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
225 |
<html><head></head><body> \ |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
226 |
# |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
227 |
ifneq ($$($1_GROUPS),) |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
228 |
$1_OVERVIEW_TEXT += \ |
45616 | 229 |
<p>This document is divided into \ |
230 |
$$(subst 2,two,$$(subst 3,three,$$(words $$($1_GROUPS)))) sections:</p> \ |
|
231 |
<blockquote><dl> \ |
|
232 |
# |
|
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
233 |
$1_OVERVIEW_TEXT += $$(foreach g, $$($1_GROUPS), \ |
52204 | 234 |
<dt style="margin-top: 8px;">$$($$g_GROUP_NAME)</dt> \ |
45775
e333a1979702
8183251: Meta "keywords" tag malformed in overview-summary.html and related pages
mr
parents:
45617
diff
changeset
|
235 |
<dd style="margin-top: 8px;">$$($$g_GROUP_DESCRIPTION)</dd> \ |
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
236 |
) |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
237 |
$1_OVERVIEW_TEXT += \ |
45775
e333a1979702
8183251: Meta "keywords" tag malformed in overview-summary.html and related pages
mr
parents:
45617
diff
changeset
|
238 |
</dl></blockquote> \ |
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
239 |
# |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
240 |
endif |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
241 |
$1_OVERVIEW_TEXT += \ |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
242 |
</body></html> \ |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
243 |
# |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
244 |
|
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
245 |
$1_OVERVIEW := $$(SUPPORT_OUTPUTDIR)/docs/$1-overview.html |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
246 |
|
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
247 |
$1_OVERVIEW_VARDEPS_FILE := $$(call DependOnVariable, $1_OVERVIEW_TEXT, \ |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
248 |
$$($1_OVERVIEW).vardeps) |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
249 |
|
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
250 |
$$($1_OVERVIEW): $$($1_OVERVIEW_VARDEPS_FILE) |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
251 |
$$(call LogInfo, Creating overview.html for $1) |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
252 |
$$(call MakeDir, $$(@D)) |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
253 |
$$(PRINTF) > $$@ '$$($1_OVERVIEW_TEXT)' |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
254 |
endef |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
255 |
|
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
256 |
################################################################################ |
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
257 |
# Setup make rules to create an API documentation collection, using javadoc and |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
258 |
# other tools if needed. |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
259 |
# |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
260 |
# Parameter 1 is the name of the rule. This name is used as variable prefix. |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
261 |
# Targets generated are returned as $1_JAVADOC_TARGETS and |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
262 |
# $1_MODULEGRAPH_TARGETS. Note that the index.html file will work as a "touch |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
263 |
# file" for all the magnitude of files that are generated by javadoc. |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
264 |
# |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
265 |
# Remaining parameters are named arguments. These include: |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
266 |
# MODULES - Modules to generate javadoc for |
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
267 |
# GROUPS - Name of the groups to divide the modules into, if any |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
268 |
# SHORT_NAME - The short name of this documentation collection |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
269 |
# LONG_NAME - The long name of this documentation collection |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
270 |
# TARGET_DIR - Where to store the output |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
271 |
# |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
272 |
SetupApiDocsGeneration = $(NamedParamsMacroTemplate) |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
273 |
define SetupApiDocsGenerationBody |
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
274 |
|
45233
538af025db97
8180480: Use "requires transitive" relationship when determining modules for javadoc
ihse
parents:
45229
diff
changeset
|
275 |
# Figure out all modules, both specified and transitive indirect exports, that |
538af025db97
8180480: Use "requires transitive" relationship when determining modules for javadoc
ihse
parents:
45229
diff
changeset
|
276 |
# will be processed by javadoc. |
538af025db97
8180480: Use "requires transitive" relationship when determining modules for javadoc
ihse
parents:
45229
diff
changeset
|
277 |
$1_INDIRECT_EXPORTS := $$(call FindTransitiveIndirectDepsForModules, $$($1_MODULES)) |
538af025db97
8180480: Use "requires transitive" relationship when determining modules for javadoc
ihse
parents:
45229
diff
changeset
|
278 |
$1_ALL_MODULES := $$(sort $$($1_MODULES) $$($1_INDIRECT_EXPORTS)) |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
279 |
|
54953
566fbca8a890
8224166: Create a taglet to better handle @jls and @jvms tags
jjg
parents:
54950
diff
changeset
|
280 |
$1_JAVA_ARGS := -Dextlink.spec.version=$$(VERSION_SPECIFICATION) \ |
566fbca8a890
8224166: Create a taglet to better handle @jls and @jvms tags
jjg
parents:
54950
diff
changeset
|
281 |
-Djspec.version=$$(VERSION_SPECIFICATION) |
50969
3f879ff34084
8206184: docs-reference build fails due to extlink.spec.version property not set
mchung
parents:
50782
diff
changeset
|
282 |
|
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
283 |
ifeq ($$(ENABLE_FULL_DOCS), true) |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
284 |
# Tell the ModuleGraph taglet to generate html links to soon-to-be-created |
58726
449555c346d9
8232639: Change module graph images to use SVG instead of PNG format.
jjg
parents:
58713
diff
changeset
|
285 |
# svg files with module graphs. |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
286 |
$1_JAVA_ARGS += -DenableModuleGraph=true |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
287 |
endif |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
288 |
|
47432
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
289 |
# Start with basic options and tags |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
290 |
ifeq ($$($1_OPTIONS), ) |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
291 |
$1_OPTIONS := $$(JAVADOC_OPTIONS) |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
292 |
endif |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
293 |
ifeq ($$($1_TAGS), ) |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
294 |
$1_TAGS := $$(JAVADOC_TAGS) |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
295 |
endif |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
296 |
$1_OPTIONS += $$($1_TAGS) |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
297 |
|
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
298 |
$1_OPTIONS += --module-source-path $$(MODULES_SOURCE_PATH) |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
299 |
$1_OPTIONS += --module $$(call CommaList, $$($1_MODULES)) |
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
300 |
|
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
301 |
# Create a string like "-Xdoclint:all,-syntax,-html,..." |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
302 |
$1_OPTIONS += -Xdoclint:all,$$(call CommaList, $$(addprefix -, \ |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
303 |
$$(JAVADOC_DISABLED_DOCLINT))) |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
304 |
|
47432
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
305 |
$1_DOC_TITLE := $$($1_LONG_NAME)<br>Version $$(VERSION_SPECIFICATION) API \ |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
306 |
Specification |
58924
c41d1303a87c
8233422: Extra space in the title of the HTML javadoc page
igerasim
parents:
58726
diff
changeset
|
307 |
$1_WINDOW_TITLE := $$(subst &,&,$$($1_SHORT_NAME))$$(DRAFT_MARKER_TITLE) |
47432
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
308 |
$1_HEADER_TITLE := <div $$(HEADER_STYLE)><strong>$$($1_SHORT_NAME)</strong> \ |
45616 | 309 |
$$(DRAFT_MARKER_STR)</div> |
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
310 |
|
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
311 |
$1_OPTIONS += -doctitle '$$($1_DOC_TITLE)' |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
312 |
$1_OPTIONS += -windowtitle '$$($1_WINDOW_TITLE)' |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
313 |
$1_OPTIONS += -header '$$($1_HEADER_TITLE)' |
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
314 |
$1_OPTIONS += -bottom '$$(JAVADOC_BOTTOM)' |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
315 |
ifeq ($$(IS_DRAFT), true) |
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
316 |
$1_OPTIONS += -top '$$(JAVADOC_TOP)' |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
317 |
endif |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
318 |
|
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
319 |
# Do not store debug level options in VARDEPS. |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
320 |
ifneq ($$(LOG_LEVEL), trace) |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
321 |
$1_LOG_OPTION += -quiet |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
322 |
else |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
323 |
$1_LOG_OPTION += -verbose |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
324 |
endif |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
325 |
|
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
326 |
# Generate the overview.html file. This will return the filename in |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
327 |
# $1_OVERVIEW. |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
328 |
$$(eval $$(call create_overview_file,$1)) |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
329 |
$1_OPTIONS += -overview $$($1_OVERVIEW) |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
330 |
|
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
331 |
$$(foreach g, $$($1_GROUPS), \ |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
332 |
$$(eval $1_OPTIONS += -group "$$($$g_GROUP_NAME)" "$$($$g_GROUP_MODULES)") \ |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
333 |
) |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
334 |
|
47432
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
335 |
ifeq ($$($1_JAVADOC_CMD), ) |
50969
3f879ff34084
8206184: docs-reference build fails due to extlink.spec.version property not set
mchung
parents:
50782
diff
changeset
|
336 |
$1_JAVADOC_CMD := $$(JAVA) -Djava.awt.headless=true $$($1_JAVA_ARGS) \ |
47432
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
337 |
$$(NEW_JAVADOC) |
50969
3f879ff34084
8206184: docs-reference build fails due to extlink.spec.version property not set
mchung
parents:
50782
diff
changeset
|
338 |
else |
52714
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
339 |
$1_OPTIONS += $$(addprefix -J, $$($1_JAVA_ARGS)) |
47432
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
340 |
endif |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
341 |
|
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
342 |
$1_VARDEPS := $$($1_JAVA_ARGS) $$($1_OPTIONS) $$(MODULES_SOURCE_PATH) \ |
47432
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
343 |
$$($1_ALL_MODULES) $$($1_JAVADOC_CMD) |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
344 |
$1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, \ |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
345 |
$$(SUPPORT_OUTPUTDIR)/docs/$1.vardeps) |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
346 |
|
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
347 |
# Get a list of all files in all the source dirs for all included modules |
54380 | 348 |
$1_SOURCE_DEPS := $$(call FindFiles, $$(wildcard $$(foreach module, \ |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
349 |
$$($1_ALL_MODULES), $$(call FindModuleSrcDirs, $$(module))))) |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
350 |
|
53995 | 351 |
$$(eval $$(call SetupExecute, javadoc_$1, \ |
352 |
WARN := Generating $1 javadoc for $$(words $$($1_ALL_MODULES)) modules, \ |
|
353 |
INFO := Javadoc modules: $$($1_ALL_MODULES), \ |
|
354 |
DEPS := $$(BUILD_TOOLS_JDK) $$($1_VARDEPS_FILE) $$($1_SOURCE_DEPS) \ |
|
355 |
$$($1_OVERVIEW), \ |
|
356 |
OUTPUT_DIR := $$($1_TARGET_DIR), \ |
|
357 |
SUPPORT_DIR := $$(SUPPORT_OUTPUTDIR)/docs, \ |
|
358 |
COMMAND := $$($1_JAVADOC_CMD) -d $$($1_TARGET_DIR) $$($1_OPTIONS) \ |
|
359 |
$$($1_LOG_OPTION), \ |
|
360 |
)) |
|
13697 | 361 |
|
53995 | 362 |
$1_JAVADOC_TARGETS := $$(javadoc_$1_TARGET) |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
363 |
|
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
364 |
ifeq ($$(ENABLE_FULL_DOCS), true) |
58726
449555c346d9
8232639: Change module graph images to use SVG instead of PNG format.
jjg
parents:
58713
diff
changeset
|
365 |
# We have asked ModuleGraph to generate links to svg files. Now we must |
449555c346d9
8232639: Change module graph images to use SVG instead of PNG format.
jjg
parents:
58713
diff
changeset
|
366 |
# produce the svg files. |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
367 |
|
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
368 |
# Locate which modules has the @moduleGraph tag in their module-info.java |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
369 |
$1_MODULES_NEEDING_GRAPH := $$(strip $$(foreach m, $$($1_ALL_MODULES), \ |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
370 |
$$(if $$(shell $$(GREP) -e @moduleGraph \ |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
371 |
$$(wildcard $$(addsuffix /module-info.java, \ |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
372 |
$$(call FindModuleSrcDirs, $$m)))), \ |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
373 |
$$m) \ |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
374 |
)) |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
375 |
|
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
376 |
# First we run the GenGraph tool. It will query the module structure of the |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
377 |
# running JVM and output .dot files for all existing modules. |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
378 |
GENGRAPHS_PROPS := \ |
47217 | 379 |
$$(TOPDIR)/make/jdk/src/classes/build/tools/jigsaw/javadoc-graphs.properties |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
380 |
|
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
381 |
$1_GENGRAPHS_DIR := $$(SUPPORT_OUTPUTDIR)/docs/$1-gengraphs |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
382 |
|
53995 | 383 |
$$(eval $$(call SetupExecute, gengraphs_$1, \ |
384 |
INFO := Running gengraphs for $1 documentation, \ |
|
385 |
DEPS := $$(BUILD_JIGSAW_TOOLS) $$(GENGRAPHS_PROPS), \ |
|
386 |
OUTPUT_DIR := $$($1_GENGRAPHS_DIR), \ |
|
387 |
COMMAND := $$(TOOL_GENGRAPHS) --spec --output $$($1_GENGRAPHS_DIR) \ |
|
388 |
--dot-attributes $$(GENGRAPHS_PROPS), \ |
|
389 |
)) |
|
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
390 |
|
58726
449555c346d9
8232639: Change module graph images to use SVG instead of PNG format.
jjg
parents:
58713
diff
changeset
|
391 |
# For each module needing a graph, create a svg file from the dot file |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
392 |
# generated by the GenGraphs tool and store it in the target dir. |
53995 | 393 |
# They will depend on gengraphs_$1_TARGET, and will be added to $1. |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
394 |
$$(foreach m, $$($1_MODULES_NEEDING_GRAPH), \ |
58726
449555c346d9
8232639: Change module graph images to use SVG instead of PNG format.
jjg
parents:
58713
diff
changeset
|
395 |
$$(eval $$(call setup_gengraph_dot_to_svg,$1,$$m)) \ |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
396 |
) |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
397 |
endif |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
398 |
endef |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
399 |
|
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
400 |
################################################################################ |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
401 |
# Setup generation of the JDK API documentation (javadoc + modulegraph) |
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
402 |
|
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
403 |
# Define the groups of the JDK API documentation |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
404 |
JavaSE_GROUP_NAME := Java SE |
48841 | 405 |
JavaSE_GROUP_MODULES := $(call ColonList, $(sort java.se \ |
406 |
$(call FindTransitiveIndirectDepsForModules, java.se))) |
|
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
407 |
JavaSE_GROUP_DESCRIPTION := \ |
45616 | 408 |
The Java Platform, Standard Edition (Java SE) APIs define the core Java \ |
409 |
platform for general-purpose computing. These APIs are in modules whose \ |
|
410 |
names start with {@code java}. \ |
|
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
411 |
# |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
412 |
JDK_GROUPS += JavaSE |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
413 |
|
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
414 |
JDK_GROUP_NAME := JDK |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
415 |
JDK_GROUP_MODULES := jdk.* |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
416 |
JDK_GROUP_DESCRIPTION := \ |
45616 | 417 |
The Java Development Kit (JDK) APIs are specific to the JDK and will not \ |
418 |
necessarily be available in all implementations of the Java SE Platform. \ |
|
419 |
These APIs are in modules whose names start with {@code jdk}. \ |
|
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
420 |
# |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
421 |
JDK_GROUPS += JDK |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
422 |
|
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
423 |
# If we are importing JavaFX, we need a JavaFX group. In an ideal world, this |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
424 |
# would have been abstracted away to a more proper generic handling of imported |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
425 |
# modules. |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
426 |
ifneq ($(findstring javafx., $(IMPORTED_MODULES)), ) |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
427 |
JavaFX_GROUP_NAME := JavaFX |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
428 |
JavaFX_GROUP_MODULES := javafx.* |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
429 |
JavaFX_GROUP_DESCRIPTION := \ |
45616 | 430 |
The JavaFX APIs define a set of user-interface controls, graphics, \ |
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
431 |
media, and web packages for developing rich client applications. These \ |
45616 | 432 |
APIs are in modules whose names start with {@code javafx}. \ |
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
433 |
# |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
434 |
JDK_GROUPS += JavaFX |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
435 |
endif |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
436 |
|
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
437 |
# All modules to have docs generated by docs-jdk-api target |
49916 | 438 |
JDK_MODULES := $(sort $(filter-out $(MODULES_FILTER), $(DOCS_MODULES))) |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
439 |
|
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
440 |
$(eval $(call SetupApiDocsGeneration, JDK_API, \ |
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
441 |
MODULES := $(JDK_MODULES), \ |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
442 |
GROUPS := $(JDK_GROUPS), \ |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
443 |
SHORT_NAME := $(JDK_SHORT_NAME), \ |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
444 |
LONG_NAME := $(JDK_LONG_NAME), \ |
45103 | 445 |
TARGET_DIR := $(DOCS_OUTPUTDIR)/api, \ |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
446 |
)) |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
447 |
|
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
448 |
# Targets generated are returned in JDK_API_JAVADOC_TARGETS and |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
449 |
# JDK_API_MODULEGRAPH_TARGETS. |
13697 | 450 |
|
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
451 |
################################################################################ |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
452 |
# Setup generation of the Java SE API documentation (javadoc + modulegraph) |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
453 |
|
48855
0006d97556ba
8197866: Docs.mk still had a reference to java.se.ee
lancea
parents:
48841
diff
changeset
|
454 |
# The Java SE module scope is just java.se and its transitive indirect |
45233
538af025db97
8180480: Use "requires transitive" relationship when determining modules for javadoc
ihse
parents:
45229
diff
changeset
|
455 |
# exports. |
48855
0006d97556ba
8197866: Docs.mk still had a reference to java.se.ee
lancea
parents:
48841
diff
changeset
|
456 |
JAVASE_MODULES := java.se |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
457 |
|
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
458 |
$(eval $(call SetupApiDocsGeneration, JAVASE_API, \ |
45323
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
459 |
MODULES := $(JAVASE_MODULES), \ |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
460 |
SHORT_NAME := $(JAVASE_SHORT_NAME), \ |
52500c1d7f1f
8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents:
45233
diff
changeset
|
461 |
LONG_NAME := $(JAVASE_LONG_NAME), \ |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
462 |
TARGET_DIR := $(IMAGES_OUTPUTDIR)/javase-docs/api, \ |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
463 |
)) |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
464 |
|
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
465 |
# Targets generated are returned in JAVASE_API_JAVADOC_TARGETS and |
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
466 |
# JAVASE_API_MODULEGRAPH_TARGETS. |
36506 | 467 |
|
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
468 |
################################################################################ |
47432
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
469 |
# Setup generation of the reference Java SE API documentation (javadoc + modulegraph) |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
470 |
|
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
471 |
# The reference javadoc is just the same as javase, but using the BootJDK javadoc |
52714
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
472 |
# and a stable set of javadoc options. Typically it is used for generating |
50969
3f879ff34084
8206184: docs-reference build fails due to extlink.spec.version property not set
mchung
parents:
50782
diff
changeset
|
473 |
# diffs between the reference javadoc and a javadoc bundle of a specific build |
3f879ff34084
8206184: docs-reference build fails due to extlink.spec.version property not set
mchung
parents:
50782
diff
changeset
|
474 |
# generated in the same way. |
47432
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
475 |
|
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
476 |
$(eval $(call SetupApiDocsGeneration, REFERENCE_API, \ |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
477 |
MODULES := $(JAVASE_MODULES), \ |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
478 |
SHORT_NAME := $(JAVASE_SHORT_NAME), \ |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
479 |
LONG_NAME := $(JAVASE_LONG_NAME), \ |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
480 |
TARGET_DIR := $(IMAGES_OUTPUTDIR)/reference-docs/api, \ |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
481 |
JAVADOC_CMD := $(JAVADOC), \ |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
482 |
OPTIONS := $(REFERENCE_OPTIONS), \ |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
483 |
TAGS := $(REFERENCE_TAGS), \ |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
484 |
)) |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
485 |
|
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
486 |
# Targets generated are returned in REFERENCE_API_JAVADOC_TARGETS and |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
487 |
# REFERENCE_API_MODULEGRAPH_TARGETS. |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
488 |
|
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
489 |
################################################################################ |
45105 | 490 |
|
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
491 |
# Use this variable to control which spec files are included in the output. |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
492 |
# Format: space-delimited list of names, including at most one '%' as a |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
493 |
# wildcard. Spec source files match if their filename or any enclosing folder |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
494 |
# name matches one of the items in SPEC_FILTER. |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
495 |
SPEC_FILTER := % |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
496 |
|
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
497 |
ApplySpecFilter = \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
498 |
$(strip $(foreach file, $(1), \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
499 |
$(eval searchkeys := $(subst /, ,$(subst $(WORKSPACE_ROOT),,$(file)))) \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
500 |
$(if $(filter $(SPEC_FILTER), $(searchkeys)), \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
501 |
$(file) \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
502 |
) \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
503 |
)) |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
504 |
|
52985 | 505 |
# Copy the global resources, including the top-level redirect index.html |
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
506 |
GLOBAL_SPECS_RESOURCES_DIR := $(TOPDIR)/make/data/docs-resources |
45229
88a3fab6006f
8180426: Use standard css file for new docs bundle index.html page
ihse
parents:
45108
diff
changeset
|
507 |
$(eval $(call SetupCopyFiles, COPY_GLOBAL_RESOURCES, \ |
88a3fab6006f
8180426: Use standard css file for new docs bundle index.html page
ihse
parents:
45108
diff
changeset
|
508 |
SRC := $(GLOBAL_SPECS_RESOURCES_DIR), \ |
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
509 |
FILES := $(call ApplySpecFilter, $(call FindFiles, $(GLOBAL_SPECS_RESOURCES_DIR))), \ |
45229
88a3fab6006f
8180426: Use standard css file for new docs bundle index.html page
ihse
parents:
45108
diff
changeset
|
510 |
DEST := $(DOCS_OUTPUTDIR), \ |
88a3fab6006f
8180426: Use standard css file for new docs bundle index.html page
ihse
parents:
45108
diff
changeset
|
511 |
)) |
88a3fab6006f
8180426: Use standard css file for new docs bundle index.html page
ihse
parents:
45108
diff
changeset
|
512 |
JDK_INDEX_TARGETS += $(COPY_GLOBAL_RESOURCES) |
45105 | 513 |
|
45617
1e5b518f5e14
8182492: docs bundle needs legal notices for 3rd party libraries distributed for javadoc search
mchung
parents:
45616
diff
changeset
|
514 |
# Copy the legal notices distributed with the docs bundle |
1e5b518f5e14
8182492: docs bundle needs legal notices for 3rd party libraries distributed for javadoc search
mchung
parents:
45616
diff
changeset
|
515 |
$(eval $(call SetupCopyFiles, COPY_DOCS_LEGAL_NOTICES, \ |
47217 | 516 |
SRC := $(TOPDIR)/src/jdk.javadoc/share/legal, \ |
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
517 |
FILES := $(call ApplySpecFilter, $(wildcard $(TOPDIR)/src/jdk.javadoc/share/legal/*)), \ |
45617
1e5b518f5e14
8182492: docs bundle needs legal notices for 3rd party libraries distributed for javadoc search
mchung
parents:
45616
diff
changeset
|
518 |
DEST := $(DOCS_OUTPUTDIR)/legal, \ |
1e5b518f5e14
8182492: docs bundle needs legal notices for 3rd party libraries distributed for javadoc search
mchung
parents:
45616
diff
changeset
|
519 |
)) |
1e5b518f5e14
8182492: docs bundle needs legal notices for 3rd party libraries distributed for javadoc search
mchung
parents:
45616
diff
changeset
|
520 |
JDK_INDEX_TARGETS += $(COPY_DOCS_LEGAL_NOTICES) |
1e5b518f5e14
8182492: docs bundle needs legal notices for 3rd party libraries distributed for javadoc search
mchung
parents:
45616
diff
changeset
|
521 |
|
45105 | 522 |
################################################################################ |
44733 | 523 |
# Copy JDK specs files |
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
524 |
|
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
525 |
# For all non html/md files in $module/share/specs directories, copy them |
44733 | 526 |
# unmodified |
527 |
||
528 |
ALL_MODULES := $(call FindAllModules) |
|
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
529 |
COPY_SPEC_FILTER := %.gif %.jpg %.mib %.css |
13697 | 530 |
|
44733 | 531 |
$(foreach m, $(ALL_MODULES), \ |
532 |
$(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \ |
|
45095
704e6f5e9b6d
8178278: Move Standard Algorithm Names document to specs directory
ihse
parents:
44990
diff
changeset
|
533 |
$(foreach d, $(SPECS_$m), \ |
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
534 |
$(if $(call ApplySpecFilter, $(filter $(COPY_SPEC_FILTER), $(call FindFiles, $d))), \ |
45095
704e6f5e9b6d
8178278: Move Standard Algorithm Names document to specs directory
ihse
parents:
44990
diff
changeset
|
535 |
$(eval $(call SetupCopyFiles, COPY_$m, \ |
704e6f5e9b6d
8178278: Move Standard Algorithm Names document to specs directory
ihse
parents:
44990
diff
changeset
|
536 |
SRC := $d, \ |
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
537 |
FILES := $(call ApplySpecFilter, $(filter $(COPY_SPEC_FILTER), $(call FindFiles, $d))), \ |
45103 | 538 |
DEST := $(DOCS_OUTPUTDIR)/specs/, \ |
45095
704e6f5e9b6d
8178278: Move Standard Algorithm Names document to specs directory
ihse
parents:
44990
diff
changeset
|
539 |
)) \ |
704e6f5e9b6d
8178278: Move Standard Algorithm Names document to specs directory
ihse
parents:
44990
diff
changeset
|
540 |
$(eval JDK_SPECS_TARGETS += $(COPY_$m)) \ |
704e6f5e9b6d
8178278: Move Standard Algorithm Names document to specs directory
ihse
parents:
44990
diff
changeset
|
541 |
) \ |
44733 | 542 |
) \ |
543 |
) |
|
544 |
||
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
545 |
# Create copyright footer variables. We need different variables for different |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
546 |
# relative paths to the copyright.html file. The number 0-2 below represent how |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
547 |
# many extra directory levels down below the specs dir the specs html file is |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
548 |
# located. |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
549 |
SPECS_BOTTOM = <footer class="legal-footer"><hr/>$(COPYRIGHT_BOTTOM)</footer> |
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
550 |
# The legal dir is one ../ below the specs dir, so start with one ../. |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
551 |
specs_bottom_rel_path := ../ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
552 |
$(foreach n, 0 1 2, \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
553 |
$(eval SPECS_BOTTOM_$n := $(call SPECS_BOTTOM,$(specs_bottom_rel_path))) \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
554 |
$(eval specs_bottom_rel_path := $(specs_bottom_rel_path)../) \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
555 |
) |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
556 |
|
55673
0bf678dd8951
8227613: "draft" header should be in a <header> instead of <div>
jjg
parents:
55651
diff
changeset
|
557 |
SPECS_TOP := $(if $(filter true, $(IS_DRAFT)), <header class="draft-header">$(DRAFT_TEXT)</header>) |
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
558 |
|
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
559 |
# For all html files in $module/share/specs directories, copy and add the |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
560 |
# copyright footer. |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
561 |
|
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
562 |
$(foreach m, $(ALL_MODULES), \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
563 |
$(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
564 |
$(foreach d, $(SPECS_$m), \ |
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
565 |
$(foreach f, $(call ApplySpecFilter, $(filter %.html, $(call FindFiles, $d))), \ |
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
566 |
$(eval $m_$f_NOF_SUBDIRS := $(words $(subst /, $(SPACE), $(subst $d, , $(dir $f))))) \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
567 |
$(eval $m_$f_NAME := PROCESS_HTML_$m_$(strip $(call RelativePath, $f, $(TOPDIR)))) \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
568 |
$(eval $(call SetupTextFileProcessing, $($m_$f_NAME), \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
569 |
SOURCE_FILES := $f, \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
570 |
SOURCE_BASE_DIR := $d, \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
571 |
OUTPUT_DIR := $(DOCS_OUTPUTDIR)/specs/, \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
572 |
REPLACEMENTS := \ |
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
573 |
<body> => <body>$(SPECS_TOP) ; \ |
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
574 |
</body> => $(SPECS_BOTTOM_$($m_$f_NOF_SUBDIRS))</body>, \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
575 |
)) \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
576 |
$(eval JDK_SPECS_TARGETS += $($($m_$f_NAME))) \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
577 |
) \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
578 |
) \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
579 |
) |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
580 |
|
53087
f48737b2f428
8215635: Pandoc check in Docs.gmk does not work on Windows
erikj
parents:
52985
diff
changeset
|
581 |
ifeq ($(ENABLE_PANDOC), true) |
44734 | 582 |
# For all markdown files in $module/share/specs directories, convert them to |
52984
2e41937c9cab
8214910: If pandoc is present, markdown spec files should be processed
ihse
parents:
52940
diff
changeset
|
583 |
# html, if we have pandoc (otherwise we'll just skip this). |
44734 | 584 |
|
45229
88a3fab6006f
8180426: Use standard css file for new docs bundle index.html page
ihse
parents:
45108
diff
changeset
|
585 |
GLOBAL_SPECS_DEFAULT_CSS_FILE := $(DOCS_OUTPUTDIR)/resources/jdk-default.css |
44734 | 586 |
|
587 |
$(foreach m, $(ALL_MODULES), \ |
|
588 |
$(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \ |
|
44983 | 589 |
$(foreach d, $(SPECS_$m), \ |
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
590 |
$(foreach f, $(call ApplySpecFilter, $(filter %.md, $(call FindFiles, $d))), \ |
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
591 |
$(eval $m_$f_NOF_SUBDIRS := $(words $(subst /, $(SPACE), $(subst $d, , $(dir $f))))) \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
592 |
$(eval $m_$f_NAME := SPECS_TO_HTML_$m_$(strip $(call RelativePath, $f, $(TOPDIR)))) \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
593 |
$(eval $(call SetupProcessMarkdown, $($m_$f_NAME), \ |
44983 | 594 |
SRC := $d, \ |
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
595 |
FILES := $f, \ |
45103 | 596 |
DEST := $(DOCS_OUTPUTDIR)/specs/, \ |
44983 | 597 |
CSS := $(GLOBAL_SPECS_DEFAULT_CSS_FILE), \ |
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
598 |
OPTIONS := -V include-before='$(SPECS_TOP)' -V include-after='$(SPECS_BOTTOM_$($m_$f_NOF_SUBDIRS))', \ |
55675
a33465cf8774
8227644: make more build-time variables available to Markdown files
jjg
parents:
55673
diff
changeset
|
599 |
REPLACEMENTS := \ |
a33465cf8774
8227644: make more build-time variables available to Markdown files
jjg
parents:
55673
diff
changeset
|
600 |
@@VERSION_SPECIFICATION@@ => $(VERSION_SPECIFICATION) ; \ |
a33465cf8774
8227644: make more build-time variables available to Markdown files
jjg
parents:
55673
diff
changeset
|
601 |
@@VERSION_STRING@@ => $(VERSION_STRING), \ |
55112 | 602 |
POST_PROCESS := $(TOOL_FIXUPPANDOC), \ |
44983 | 603 |
)) \ |
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
604 |
$(eval JDK_SPECS_TARGETS += $($($m_$f_NAME))) \ |
44983 | 605 |
) \ |
44734 | 606 |
) \ |
607 |
) |
|
52714
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
608 |
|
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
609 |
# For all markdown files in $module/share/man directories, convert them to |
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
610 |
# html. |
52940
26e2cfebcfba
8214720: Add pandoc filter to improve html man page output
ihse
parents:
52714
diff
changeset
|
611 |
|
26e2cfebcfba
8214720: Add pandoc filter to improve html man page output
ihse
parents:
52714
diff
changeset
|
612 |
# Create dynamic man pages from markdown using pandoc. We need |
26e2cfebcfba
8214720: Add pandoc filter to improve html man page output
ihse
parents:
52714
diff
changeset
|
613 |
# PANDOC_HTML_MANPAGE_FILTER, a wrapper around |
26e2cfebcfba
8214720: Add pandoc filter to improve html man page output
ihse
parents:
52714
diff
changeset
|
614 |
# PANDOC_HTML_MANPAGE_FILTER_JAVASCRIPT. This is created by buildtools-jdk. |
26e2cfebcfba
8214720: Add pandoc filter to improve html man page output
ihse
parents:
52714
diff
changeset
|
615 |
|
26e2cfebcfba
8214720: Add pandoc filter to improve html man page output
ihse
parents:
52714
diff
changeset
|
616 |
# We should also depend on the source javascript filter |
26e2cfebcfba
8214720: Add pandoc filter to improve html man page output
ihse
parents:
52714
diff
changeset
|
617 |
PANDOC_HTML_MANPAGE_FILTER_JAVASCRIPT := \ |
26e2cfebcfba
8214720: Add pandoc filter to improve html man page output
ihse
parents:
52714
diff
changeset
|
618 |
$(TOPDIR)/make/scripts/pandoc-html-manpage-filter.js |
26e2cfebcfba
8214720: Add pandoc filter to improve html man page output
ihse
parents:
52714
diff
changeset
|
619 |
|
52714
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
620 |
$(foreach m, $(ALL_MODULES), \ |
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
621 |
$(eval MAN_$m := $(call FindModuleManDirs, $m)) \ |
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
622 |
$(foreach d, $(MAN_$m), \ |
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
623 |
$(foreach f, $(call ApplySpecFilter, $(filter %.md, $(call FindFiles, $d))), \ |
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
624 |
$(eval $m_$f_NAME := MAN_TO_HTML_$m_$(strip $(call RelativePath, $f, $(TOPDIR)))) \ |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
625 |
$(eval $(call SetupProcessMarkdown, $($m_$f_NAME), \ |
52714
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
626 |
SRC := $d, \ |
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
627 |
FILES := $f, \ |
52714
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
628 |
DEST := $(DOCS_OUTPUTDIR)/specs/man, \ |
52940
26e2cfebcfba
8214720: Add pandoc filter to improve html man page output
ihse
parents:
52714
diff
changeset
|
629 |
FILTER := $(PANDOC_HTML_MANPAGE_FILTER), \ |
52714
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
630 |
CSS := $(GLOBAL_SPECS_DEFAULT_CSS_FILE), \ |
55675
a33465cf8774
8227644: make more build-time variables available to Markdown files
jjg
parents:
55673
diff
changeset
|
631 |
REPLACEMENTS := \ |
a33465cf8774
8227644: make more build-time variables available to Markdown files
jjg
parents:
55673
diff
changeset
|
632 |
@@COPYRIGHT_YEAR@@ => $(COPYRIGHT_YEAR) ; \ |
a33465cf8774
8227644: make more build-time variables available to Markdown files
jjg
parents:
55673
diff
changeset
|
633 |
@@VERSION_SHORT@@ => $(VERSION_SHORT) ; \ |
a33465cf8774
8227644: make more build-time variables available to Markdown files
jjg
parents:
55673
diff
changeset
|
634 |
@@VERSION_SPECIFICATION@@ => $(VERSION_SPECIFICATION), \ |
55651
45fc36beb0aa
8227416: Add a "Table Of Contents" to HTML version of man pages
jjg
parents:
55488
diff
changeset
|
635 |
OPTIONS := --toc -V include-before='$(SPECS_TOP)' -V include-after='$(SPECS_BOTTOM_1)', \ |
55112 | 636 |
POST_PROCESS := $(TOOL_FIXUPPANDOC), \ |
52940
26e2cfebcfba
8214720: Add pandoc filter to improve html man page output
ihse
parents:
52714
diff
changeset
|
637 |
EXTRA_DEPS := $(PANDOC_HTML_MANPAGE_FILTER) \ |
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
638 |
$(PANDOC_HTML_MANPAGE_FILTER_JAVASCRIPT), \ |
52714
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
639 |
)) \ |
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
640 |
$(eval JDK_SPECS_TARGETS += $($($m_$f_NAME))) \ |
52714
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
641 |
) \ |
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
642 |
) \ |
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
643 |
) |
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
644 |
|
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
645 |
# The html generated from markdown also needs the css file |
2e52aa822c57
8178317: Create man pages using pandoc from markdown sources
ihse
parents:
52318
diff
changeset
|
646 |
JDK_SPECS_TARGETS += $(COPY_GLOBAL_RESOURCES) |
44734 | 647 |
endif |
648 |
||
44733 | 649 |
# Special treatment for generated documentation |
650 |
||
651 |
JDWP_PROTOCOL := $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html |
|
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
652 |
ifneq ($(call ApplySpecFilter, $(JDWP_PROTOCOL)), ) |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
653 |
$(eval $(call SetupTextFileProcessing, PROCESS_JDWP_PROTOCOL, \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
654 |
SOURCE_FILES := $(JDWP_PROTOCOL), \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
655 |
OUTPUT_DIR := $(DOCS_OUTPUTDIR)/specs/jdwp, \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
656 |
REPLACEMENTS := \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
657 |
<body> => <body>$(SPECS_TOP) ; \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
658 |
</body> => $(SPECS_BOTTOM_1)</body>, \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
659 |
)) |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
660 |
JDK_SPECS_TARGETS += $(PROCESS_JDWP_PROTOCOL) |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
661 |
endif |
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
662 |
|
44733 | 663 |
# Get jvmti.html from the main jvm variant (all variants' jvmti.html are identical). |
49928 | 664 |
JVMTI_HTML ?= $(HOTSPOT_OUTPUTDIR)/variant-$(JVM_VARIANT_MAIN)/gensrc/jvmtifiles/jvmti.html |
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
665 |
ifneq ($(call ApplySpecFilter, $(JVMTI_HTML)), ) |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
666 |
$(eval $(call SetupTextFileProcessing, PROCESS_JVMTI_HTML, \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
667 |
SOURCE_FILES := $(JVMTI_HTML), \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
668 |
OUTPUT_DIR := $(DOCS_OUTPUTDIR)/specs/, \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
669 |
REPLACEMENTS := \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
670 |
<body> => <body>$(SPECS_TOP) ; \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
671 |
</body> => $(SPECS_BOTTOM_0)</body>, \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
672 |
)) |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
673 |
JDK_SPECS_TARGETS += $(PROCESS_JVMTI_HTML) |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
674 |
endif |
13697 | 675 |
|
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
676 |
################################################################################ |
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
677 |
# Optional target which bundles all generated javadocs into a zip archive. |
37034
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
678 |
|
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
679 |
JAVADOC_ZIP_NAME := jdk-$(VERSION_STRING)-docs.zip |
47253
92fd0e04e0e1
8187544: Replace BUILD_OUTPUT and OUTPUT_ROOT with OUTPUTDIR
ihse
parents:
47217
diff
changeset
|
680 |
JAVADOC_ZIP_FILE := $(OUTPUTDIR)/bundles/$(JAVADOC_ZIP_NAME) |
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
681 |
|
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
682 |
$(eval $(call SetupZipArchive, BUILD_JAVADOC_ZIP, \ |
45103 | 683 |
SRC := $(DOCS_OUTPUTDIR), \ |
44733 | 684 |
ZIP := $(JAVADOC_ZIP_FILE), \ |
685 |
EXTRA_DEPS := $(JDK_API_JAVADOC_TARGETS) $(JDK_API_MODULEGRAPH_TARGETS) \ |
|
686 |
$(JDK_SPECS_TARGETS), \ |
|
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
687 |
)) |
37034
b63fd4af003e
8154313: Generated javadoc scattered all over the place
neugens
parents:
36792
diff
changeset
|
688 |
|
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
689 |
ZIP_TARGETS += $(BUILD_JAVADOC_ZIP) |
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
690 |
|
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
691 |
################################################################################ |
54747
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
692 |
# Hook to include the corresponding custom file, if present. |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
693 |
$(eval $(call IncludeCustomExtension, Docs-post.gmk)) |
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
694 |
|
0082ede5dc53
8223319: Add copyright footer to specs and man pages
erikj
parents:
54380
diff
changeset
|
695 |
################################################################################ |
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
696 |
# Bundles all generated specs into a zip archive, skipping javadocs. |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
697 |
|
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
698 |
SPECS_ZIP_NAME := jdk-$(VERSION_STRING)-specs.zip |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
699 |
SPECS_ZIP_FILE := $(OUTPUTDIR)/bundles/$(SPECS_ZIP_NAME) |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
700 |
|
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
701 |
$(eval $(call SetupZipArchive, BUILD_SPECS_ZIP, \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
702 |
SRC := $(DOCS_OUTPUTDIR), \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
703 |
ZIP := $(SPECS_ZIP_FILE), \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
704 |
EXTRA_DEPS := $(JDK_SPECS_TARGETS), \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
705 |
)) |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
706 |
|
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
707 |
SPECS_ZIP_TARGETS += $(BUILD_SPECS_ZIP) |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
708 |
|
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
709 |
################################################################################ |
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
710 |
|
45103 | 711 |
docs-jdk-api-javadoc: $(JDK_API_JAVADOC_TARGETS) $(JDK_API_CUSTOM_TARGETS) |
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
712 |
|
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
713 |
docs-jdk-api-modulegraph: $(JDK_API_MODULEGRAPH_TARGETS) |
44397
f932d6b9f7fe
8173303: Add module-subgraph images to main platform documentation
mchung
parents:
44071
diff
changeset
|
714 |
|
45103 | 715 |
docs-javase-api-javadoc: $(JAVASE_API_JAVADOC_TARGETS) $(JAVASE_API_CUSTOM_TARGETS) |
44725
8747b14eb49c
8172312: Update docs target and image for new combined docs
ihse
parents:
44397
diff
changeset
|
716 |
|
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
717 |
docs-javase-api-modulegraph: $(JAVASE_API_MODULEGRAPH_TARGETS) |
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
718 |
|
47432
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
719 |
docs-reference-api-javadoc: $(REFERENCE_API_JAVADOC_TARGETS) $(REFERENCE_API_CUSTOM_TARGETS) |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
720 |
|
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
721 |
docs-reference-api-modulegraph: $(REFERENCE_API_MODULEGRAPH_TARGETS) |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
722 |
|
44733 | 723 |
docs-jdk-specs: $(JDK_SPECS_TARGETS) |
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
724 |
|
45229
88a3fab6006f
8180426: Use standard css file for new docs bundle index.html page
ihse
parents:
45108
diff
changeset
|
725 |
docs-jdk-index: $(JDK_INDEX_TARGETS) |
45105 | 726 |
|
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
727 |
docs-zip: $(ZIP_TARGETS) |
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
728 |
|
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
729 |
docs-specs-zip: $(SPECS_ZIP_TARGETS) |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
730 |
|
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
731 |
all: docs-jdk-api-javadoc docs-jdk-api-modulegraph docs-javase-api-javadoc \ |
47432
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
732 |
docs-javase-api-modulegraph docs-reference-api-javadoc \ |
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
733 |
docs-reference-api-modulegraph docs-jdk-specs docs-jdk-index docs-zip \ |
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
734 |
docs-specs-zip |
41652
a0664e2b49a1
8168772: Convert javadoc generation to build-infra standards
ihse
parents:
41260
diff
changeset
|
735 |
|
44726
04aa2c065f5c
8176785: Add build support to generate PNG file from .dot file
ihse
parents:
44725
diff
changeset
|
736 |
.PHONY: default all docs-jdk-api-javadoc docs-jdk-api-modulegraph \ |
47432
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
737 |
docs-javase-api-javadoc docs-javase-api-modulegraph \ |
28d6070f5f2f
8189056: javadoc target for stable specdiff comparisons
ihse
parents:
47429
diff
changeset
|
738 |
docs-reference-api-javadoc docs-reference-api-modulegraph docs-jdk-specs \ |
55447
95794e32352e
8226325: Support building of filtered spec bundles
dlsmith
parents:
55112
diff
changeset
|
739 |
docs-jdk-index docs-zip docs-specs-zip |