make/Docs.gmk
author ihse
Fri, 16 Jun 2017 11:41:25 +0200
changeset 45613 3d1c96cd5479
parent 45610 e9dbf9eb0100
child 45616 88a3b1082777
permissions -rw-r--r--
8179556: Add specs copyright file Reviewed-by: erikj
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
43047
28be7f773e4e 8172562: Changing log level on Javadoc causes total rebuild
ihse
parents: 43044
diff changeset
     1
# Copyright (c) 1997, 2017, Oracle and/or its affiliates. All rights reserved.
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
     2
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
     3
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
     4
# This code is free software; you can redistribute it and/or modify it
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
     5
# under the terms of the GNU General Public License version 2 only, as
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
     6
# published by the Free Software Foundation.  Oracle designates this
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
     7
# particular file as subject to the "Classpath" exception as provided
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
     8
# by Oracle in the LICENSE file that accompanied this code.
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
     9
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    10
# This code is distributed in the hope that it will be useful, but WITHOUT
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    11
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    12
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    13
# version 2 for more details (a copy is included in the LICENSE file that
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    14
# accompanied this code).
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    15
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    16
# You should have received a copy of the GNU General Public License version
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    17
# 2 along with this work; if not, write to the Free Software Foundation,
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    18
# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    19
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    20
# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    21
# or visit www.oracle.com if you need additional information or have any
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    22
# questions.
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    23
#
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    24
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
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    27
include $(SPEC)
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    28
include MakeBase.gmk
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
    29
include Modules.gmk
44983
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44829
diff changeset
    30
include ProcessMarkdown.gmk
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
    31
include ZipArchive.gmk
43285
223c3eea12e4 8173354: javadoc warning notice for types in Incubator Modules
chegar
parents: 43171
diff changeset
    32
include $(JDK_TOPDIR)/make/Tools.gmk
44397
f932d6b9f7fe 8173303: Add module-subgraph images to main platform documentation
mchung
parents: 44071
diff changeset
    33
include $(JDK_TOPDIR)/make/ModuleTools.gmk
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    34
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
    35
# This is needed to properly setup DOCS_MODULES.
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
    36
$(eval $(call ReadImportMetaData))
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
    37
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
    38
################################################################################
44827
56c57aa67d0c 8178042: Allow custom taglets
ihse
parents: 44826
diff changeset
    39
# Hook to include the corresponding custom file, if present.
45103
85999d3d05f0 8175825: Stop including pubs repo
ihse
parents: 45095
diff changeset
    40
$(eval $(call IncludeCustomExtension, , Docs.gmk))
44827
56c57aa67d0c 8178042: Allow custom taglets
ihse
parents: 44826
diff changeset
    41
56c57aa67d0c 8178042: Allow custom taglets
ihse
parents: 44826
diff changeset
    42
################################################################################
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
    43
# This file generates all documentation for OpenJDK.
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
    44
#
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
    45
# 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
    46
# code: "Java SE", which contains just the modules covered by the top-level
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
    47
# module java.se.ee, and "JDK", which covers all of Java SE and also all
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
    48
# 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
    49
# if any.
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
    50
#
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
    51
# 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
    52
# markdown or existing html files.
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
    53
#
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
    54
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
    55
################################################################################
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
    56
# Javadoc settings
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
    57
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
    58
# 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
    59
# 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
    60
MODULES_SOURCE_PATH := $(call PathList, $(call GetModuleSrcPath) \
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
    61
    $(SUPPORT_OUTPUTDIR)/rmic/* $(JDK_TOPDIR)/src/*/share/doc/stub)
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
    62
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
    63
# URLs
45108
8ad1bd49f4bc 8180328: Bad links in footer of all javadoc-generated pages
ihse
parents: 45105
diff changeset
    64
JAVADOC_BASE_URL := http://www.oracle.com/pls/topic/lookup?ctx=javase9&id=homepage
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
    65
BUG_SUBMIT_URL := http://bugreport.java.com/bugreport/
45613
3d1c96cd5479 8179556: Add specs copyright file
ihse
parents: 45610
diff changeset
    66
COPYRIGHT_URL := {@docroot}/../legal/copyright.html
44990
db3606f423a3 8140268: Generate link to specification license for JavaDoc API documentation
ihse
parents: 44989
diff changeset
    67
LICENSE_URL := http://www.oracle.com/technetwork/java/javase/terms/license/java9speclicense.html
db3606f423a3 8140268: Generate link to specification license for JavaDoc API documentation
ihse
parents: 44989
diff changeset
    68
REDISTRIBUTION_URL := http://www.oracle.com/technetwork/java/redist-137594.html
db3606f423a3 8140268: Generate link to specification license for JavaDoc API documentation
ihse
parents: 44989
diff changeset
    69
42135
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    70
# In order to get a specific ordering it's necessary to specify the total
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    71
# 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
    72
JAVADOC_TAGS := \
42135
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    73
    -tag beaninfo:X \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    74
    -tag revised:X \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    75
    -tag since.unbundled:X \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    76
    -tag spec:X \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    77
    -tag specdefault:X \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    78
    -tag Note:X \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    79
    -tag ToDo:X \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    80
    -tag 'apiNote:a:API Note:' \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    81
    -tag 'implSpec:a:Implementation Requirements:' \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    82
    -tag 'implNote:a:Implementation Note:' \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    83
    -tag param \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    84
    -tag return \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    85
    -tag throws \
44397
f932d6b9f7fe 8173303: Add module-subgraph images to main platform documentation
mchung
parents: 44071
diff changeset
    86
    -taglet build.tools.taglet.ModuleGraph \
42135
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    87
    -tag since \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    88
    -tag version \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    89
    -tag serialData \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    90
    -tag factory \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    91
    -tag see \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    92
    -tag 'jvms:a:See <cite>The Java&trade; Virtual Machine Specification</cite>:' \
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    93
    -tag 'jls:a:See <cite>The Java&trade; Language Specification</cite>:' \
44826
7a887996ee84 8178725: provide way to link to external documentation
ksrini
parents: 44734
diff changeset
    94
    -taglet build.tools.taglet.ExtLink \
43285
223c3eea12e4 8173354: javadoc warning notice for types in Incubator Modules
chegar
parents: 43171
diff changeset
    95
    -taglet build.tools.taglet.Incubating \
223c3eea12e4 8173354: javadoc warning notice for types in Incubator Modules
chegar
parents: 43171
diff changeset
    96
    -tagletpath $(BUILDTOOLS_OUTPUTDIR)/jdk_tools_classes \
44827
56c57aa67d0c 8178042: Allow custom taglets
ihse
parents: 44826
diff changeset
    97
    $(CUSTOM_JAVADOC_TAGS) \
42135
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    98
    #
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
    99
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   100
# Which doclint checks to ignore
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   101
JAVADOC_DISABLED_DOCLINT := accessibility html missing syntax reference
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   102
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   103
# The initial set of options for javadoc
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   104
JAVADOC_OPTIONS := -XDignore.symbol.file=true -use -keywords -notimestamp \
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   105
    -serialwarn -encoding ISO-8859-1 -breakiterator -splitIndex --system none \
44829
d9f6608f924e 8179361: specify -javafx option for javadoc command
ihse
parents: 44827
diff changeset
   106
    -html5 -javafx --expand-requires transitive
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   107
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   108
# 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
   109
ifeq ($(VERSION_IS_GA), true)
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   110
  IS_DRAFT := false
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   111
else
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   112
  IS_DRAFT := true
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   113
endif
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   114
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   115
################################################################################
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   116
# General text snippets
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   117
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   118
FULL_COMPANY_NAME := Oracle and/or its affiliates
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   119
COMPANY_ADDRESS := 500 Oracle Parkway<br>Redwood Shores, CA 94065 USA
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   120
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   121
JAVA_PLATFORM := Java&trade; Platform
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   122
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   123
ifeq ($(IS_DRAFT), true)
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   124
  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
   125
  ifeq ($(VERSION_BUILD), 0)
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   126
    DRAFT_MARKER_TITLE := [ad-hoc build]
43047
28be7f773e4e 8172562: Changing log level on Javadoc causes total rebuild
ihse
parents: 43044
diff changeset
   127
  else
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   128
    DRAFT_MARKER_TITLE := [build $(VERSION_BUILD)]
43047
28be7f773e4e 8172562: Changing log level on Javadoc causes total rebuild
ihse
parents: 43044
diff changeset
   129
  endif
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   130
  DRAFT_TEXT := Please note that the specifications and other information \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   131
      contained herein are not final and are subject to change. The \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   132
      information is being made available to you solely for purpose of \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   133
      evaluation.
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   134
endif
42135
484c28d7fd1b 8170077: Properly parallelize javadoc generation
ihse
parents: 42134
diff changeset
   135
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   136
JAVADOC_BOTTOM := \
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   137
    <span style="font-size:smaller"> \
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   138
    <a href="$(BUG_SUBMIT_URL)">Submit a bug or feature</a><br> \
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   139
    For further API reference and developer documentation, see \
45108
8ad1bd49f4bc 8180328: Bad links in footer of all javadoc-generated pages
ihse
parents: 45105
diff changeset
   140
    <a href="$(JAVADOC_BASE_URL)" target="_blank">Java SE \
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   141
    Documentation</a>. That documentation contains more detailed, \
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   142
    developer-targeted descriptions, with conceptual overviews, definitions \
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   143
    of terms, workarounds, and working code examples.<br> \
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   144
    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
   145
    the US and other countries.<br> \
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   146
    <a href="$(COPYRIGHT_URL)">Copyright</a> \
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   147
    &copy; 1993, $(COPYRIGHT_YEAR), $(FULL_COMPANY_NAME). \
44990
db3606f423a3 8140268: Generate link to specification license for JavaDoc API documentation
ihse
parents: 44989
diff changeset
   148
    $(COMPANY_ADDRESS). All rights reserved. \
db3606f423a3 8140268: Generate link to specification license for JavaDoc API documentation
ihse
parents: 44989
diff changeset
   149
    Use is subject to <a href="$(LICENSE_URL)">license terms</a>. Also see the \
db3606f423a3 8140268: Generate link to specification license for JavaDoc API documentation
ihse
parents: 44989
diff changeset
   150
    <a href="$(REDISTRIBUTION_URL)">documentation redistribution policy</a>. \
db3606f423a3 8140268: Generate link to specification license for JavaDoc API documentation
ihse
parents: 44989
diff changeset
   151
    $(DRAFT_MARKER_STR)</span>
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   152
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   153
JAVADOC_TOP := \
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   154
    <div style="background-color: $(HASH)EEEEEE"><div style="padding: 6px; \
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   155
    margin-top: 2px; margin-bottom: 6px; margin-left: 6px; margin-right: \
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   156
    6px; text-align: justify; font-size: 80%; font-family: Helvetica, Arial, \
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   157
    sans-serif; font-weight: normal;">$(DRAFT_TEXT)</div></div>
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   158
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   159
################################################################################
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   160
# JDK javadoc titles/text snippets
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   161
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   162
JDK_SHORT_NAME := JDK&trade; $(VERSION_SPECIFICATION)
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   163
JDK_LONG_NAME := Standard Edition Development Kit (JDK&trade;) $(VERSION_SPECIFICATION)
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   164
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   165
################################################################################
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   166
# Java SE javadoc titles/text snippets
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   167
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   168
JAVASE_SHORT_NAME := SE $(VERSION_SPECIFICATION)
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   169
JAVASE_LONG_NAME := Standard Edition $(VERSION_SPECIFICATION)
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   170
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   171
################################################################################
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   172
# Functions
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   173
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   174
# Helper function for creating a png file from a dot file generated by the
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   175
# GenGraphs tool.
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   176
# param 1: SetupJavadocGeneration namespace ($1)
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   177
# param 2: module name
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   178
#
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   179
define setup_gengraph_dot_to_png
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   180
  $1_$2_DOT_SRC :=  $$($1_GENGRAPHS_DIR)/$2.dot
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   181
  $1_$2_PNG_TARGET := $$($1_TARGET_DIR)/$2-graph.png
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   182
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   183
    # For each module needing a graph, create a png file from the dot file
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   184
    # generated by the GenGraphs tool and store it in the target dir.
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   185
    $$($1_$2_PNG_TARGET): $$($1_GENGRAPHS_MARKER)
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   186
	$$(call MakeDir, $$(@D))
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   187
	$$(call ExecuteWithLog, $$($1_$2_DOT_SRC), \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   188
	    $$(DOT) -Tpng -o $$($1_$2_PNG_TARGET) $$($1_$2_DOT_SRC))
42427
2c48c5ffb581 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents: 42290
diff changeset
   189
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   190
  $1_MODULEGRAPH_TARGETS += $$($1_$2_PNG_TARGET)
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   191
endef
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   192
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   193
# 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
   194
# javadoc option.
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   195
# Returns the filename as $1_OVERVIEW.
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   196
#
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   197
# param 1: SetupJavadocGeneration namespace ($1)
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   198
define create_overview_file
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   199
  $1_OVERVIEW_TEXT := \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   200
      <!DOCTYPE html> \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   201
      <html><head></head><body> \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   202
      <p>This document is the API specification for $$($1_FULL_NAME).</p> \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   203
      #
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   204
  ifneq ($$($1_GROUPS),)
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   205
    $1_OVERVIEW_TEXT += \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   206
        <dl> \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   207
        #
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   208
    $1_OVERVIEW_TEXT += $$(foreach g, $$($1_GROUPS), \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   209
        <dt><a href="\#$$g">$$($$g_GROUP_NAME)</a></dt> \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   210
        <dd>$$($$g_GROUP_DESCRIPTION)</dt> \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   211
    )
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   212
    $1_OVERVIEW_TEXT += \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   213
        </dl> \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   214
        #
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   215
  endif
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   216
  ifeq ($$(IS_DRAFT), true)
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   217
    $1_OVERVIEW_TEXT += \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   218
        <p><strong>$$(DRAFT_TEXT)</strong></p> \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   219
        #
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   220
  endif
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   221
  $1_OVERVIEW_TEXT += \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   222
      </body></html> \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   223
      #
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   224
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   225
  $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
   226
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   227
  $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
   228
      $$($1_OVERVIEW).vardeps)
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   229
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   230
  $$($1_OVERVIEW): $$($1_OVERVIEW_VARDEPS_FILE)
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   231
	$$(call LogInfo, Creating overview.html for $1)
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   232
	$$(call MakeDir, $$(@D))
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   233
	$$(PRINTF) > $$@ '$$($1_OVERVIEW_TEXT)'
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   234
endef
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   235
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   236
################################################################################
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   237
# 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
   238
# other tools if needed.
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   239
#
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   240
# 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
   241
# 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
   242
# $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
   243
# 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
   244
#
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   245
# Remaining parameters are named arguments. These include:
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   246
#   MODULES - Modules to generate javadoc for
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   247
#   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
   248
#   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
   249
#   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
   250
#   TARGET_DIR - Where to store the output
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   251
#
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   252
SetupApiDocsGeneration = $(NamedParamsMacroTemplate)
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   253
define SetupApiDocsGenerationBody
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   254
45233
538af025db97 8180480: Use "requires transitive" relationship when determining modules for javadoc
ihse
parents: 45229
diff changeset
   255
  # 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
   256
  # will be processed by javadoc.
538af025db97 8180480: Use "requires transitive" relationship when determining modules for javadoc
ihse
parents: 45229
diff changeset
   257
  $1_INDIRECT_EXPORTS := $$(call FindTransitiveIndirectDepsForModules, $$($1_MODULES))
538af025db97 8180480: Use "requires transitive" relationship when determining modules for javadoc
ihse
parents: 45229
diff changeset
   258
  $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
   259
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   260
  ifeq ($$(ENABLE_FULL_DOCS), true)
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   261
    # Tell the ModuleGraph taglet to generate html links to soon-to-be-created
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   262
    # png files with module graphs.
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   263
    $1_JAVA_ARGS += -DenableModuleGraph=true
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   264
  endif
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   265
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   266
  # Always include tags and basic options
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   267
  $1_OPTIONS := $$(JAVADOC_TAGS) $$(JAVADOC_OPTIONS)
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   268
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   269
  $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
   270
  $1_OPTIONS += --module $$(call CommaList, $$($1_MODULES))
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   271
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   272
  # 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
   273
  $1_OPTIONS += -Xdoclint:all,$$(call CommaList, $$(addprefix -, \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   274
      $$(JAVADOC_DISABLED_DOCLINT)))
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   275
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   276
  $1_FULL_NAME := $$(JAVA_PLATFORM), $$($1_LONG_NAME) \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   277
      $$(DRAFT_MARKER_TITLE)
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   278
  $1_DOC_TITLE := $$($1_FULL_NAME)<br>API Specification
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   279
  $1_WINDOW_TITLE := $$(subst &trade;,,$$(JAVA_PLATFORM) $$($1_SHORT_NAME)) \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   280
    $$(DRAFT_MARKER_TITLE)
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   281
  $1_HEADER_TITLE := <strong>$$(JAVA_PLATFORM)<br>$$($1_SHORT_NAME)</strong> \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   282
      $$(DRAFT_MARKER_STR)
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   283
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   284
  $1_OPTIONS += -doctitle '$$($1_DOC_TITLE)'
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   285
  $1_OPTIONS += -windowtitle '$$($1_WINDOW_TITLE)'
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   286
  $1_OPTIONS += -header '$$($1_HEADER_TITLE)'
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   287
  $1_OPTIONS += -bottom '$$(JAVADOC_BOTTOM)'
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   288
  ifeq ($$(IS_DRAFT), true)
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   289
    $1_OPTIONS += -top '$$(JAVADOC_TOP)'
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   290
  endif
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   291
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   292
  # 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
   293
  ifneq ($$(LOG_LEVEL), trace)
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   294
    $1_LOG_OPTION += -quiet
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   295
  else
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   296
    $1_LOG_OPTION += -verbose
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   297
  endif
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   298
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   299
  # 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
   300
  # $1_OVERVIEW.
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   301
  $$(eval $$(call create_overview_file,$1))
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   302
  $1_OPTIONS += -overview $$($1_OVERVIEW)
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   303
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   304
  $$(foreach g, $$($1_GROUPS), \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   305
    $$(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
   306
  )
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   307
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   308
  $1_VARDEPS := $$($1_JAVA_ARGS) $$($1_OPTIONS) $$(MODULES_SOURCE_PATH) \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   309
      $$($1_ALL_MODULES)
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   310
  $1_VARDEPS_FILE := $$(call DependOnVariable, $1_VARDEPS, \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   311
      $$(SUPPORT_OUTPUTDIR)/docs/$1.vardeps)
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   312
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   313
  # Get a list of all files in all the source dirs for all included modules
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   314
  $1_SOURCE_DEPS := $$(call CacheFind, $$(wildcard $$(foreach module, \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   315
      $$($1_ALL_MODULES), $$(call FindModuleSrcDirs, $$(module)))))
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   316
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   317
  # Javadoc creates a lot of files but use index.html as a marker
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   318
  $$($1_TARGET_DIR)/index.html: $$(BUILD_TOOLS_JDK) $$($1_VARDEPS_FILE) \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   319
      $$($1_SOURCE_DEPS) $$($1_OVERVIEW)
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   320
	$$(call LogWarn, Generating $1 javadoc for \
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   321
	    $$(words $$($1_ALL_MODULES)) modules)
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   322
	$$(call LogInfo, Javadoc modules: $$($1_ALL_MODULES))
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   323
	$$(call MakeDir, $$($1_TARGET_DIR))
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   324
	$$(call ExecuteWithLog, $$(SUPPORT_OUTPUTDIR)/docs/$1, \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   325
	    $$(JAVA) -Djava.awt.headless=true $$($1_JAVA_ARGS) \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   326
	        $$(NEW_JAVADOC) -d $$($1_TARGET_DIR) \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   327
	        $$(JAVADOC_TAGS) $$($1_OPTIONS) $$($1_LOG_OPTION))
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   328
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   329
  $1_JAVADOC_TARGETS := $$($1_TARGET_DIR)/index.html
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   330
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   331
  ifeq ($$(ENABLE_FULL_DOCS), true)
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   332
    # We have asked ModuleGraph to generate links to png files. Now we must
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   333
    # produce the png files.
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   334
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   335
    # 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
   336
    $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
   337
      $$(if $$(shell $$(GREP) -e @moduleGraph \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   338
          $$(wildcard $$(addsuffix /module-info.java, \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   339
          $$(call FindModuleSrcDirs, $$m)))), \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   340
        $$m) \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   341
    ))
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   342
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   343
    # 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
   344
    # 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
   345
    GENGRAPHS_PROPS := \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   346
        $$(JDK_TOPDIR)/make/src/classes/build/tools/jigsaw/javadoc-graphs.properties
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   347
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   348
    $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
   349
    $1_GENGRAPHS_MARKER := $$($1_GENGRAPHS_DIR)/_gengraphs_run.marker
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   350
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   351
    $$($1_GENGRAPHS_MARKER): $$(BUILD_JIGSAW_TOOLS) $$(GENGRAPHS_PROPS)
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   352
	$$(call LogInfo, Running gengraphs for $1 documentation)
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   353
	$$(call MakeDir, $$($1_GENGRAPHS_DIR))
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   354
	$$(call ExecuteWithLog, $$($1_GENGRAPHS_DIR)/gengraphs, \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   355
	    $$(TOOL_GENGRAPHS) --spec --output $$($1_GENGRAPHS_DIR) \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   356
	    --dot-attributes $$(GENGRAPHS_PROPS) && \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   357
	    $$(TOUCH) $$($1_GENGRAPHS_MARKER))
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   358
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   359
    # For each module needing a graph, create a png file from the dot file
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   360
    # generated by the GenGraphs tool and store it in the target dir.
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   361
    # They will depend on $1_GENGRAPHS_MARKER, and will be added to $1.
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   362
    $$(foreach m, $$($1_MODULES_NEEDING_GRAPH), \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   363
      $$(eval $$(call setup_gengraph_dot_to_png,$1,$$m)) \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   364
    )
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   365
  endif
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   366
endef
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
################################################################################
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   369
# Setup generation of the JDK API documentation (javadoc + modulegraph)
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   370
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   371
# 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
   372
JavaSE_GROUP_NAME := Java SE
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   373
JavaSE_GROUP_MODULES := $(call ColonList, $(sort java.se.ee \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   374
    $(call FindTransitiveIndirectDepsForModules, java.se.ee)))
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   375
JavaSE_GROUP_DESCRIPTION := \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   376
    The Java Platform, Standard Edition ("Java SE") APIs define the core Java \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   377
    platform for general-purpose computing. These APIs are in modules with \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   378
    names starting with the string "java.". \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   379
    #
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   380
JDK_GROUPS += JavaSE
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   381
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   382
JDK_GROUP_NAME := JDK
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   383
JDK_GROUP_MODULES := jdk.*
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   384
JDK_GROUP_DESCRIPTION := \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   385
    The Java Development Kit ("JDK") APIs define an implementation of the Java \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   386
    SE Platform which may include platform-specific details. These APIs are in \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   387
    modules with names starting with the string "jdk.". \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   388
    #
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   389
JDK_GROUPS += JDK
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   390
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   391
# 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
   392
# 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
   393
# modules.
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   394
ifneq ($(findstring javafx., $(IMPORTED_MODULES)), )
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   395
  JavaFX_GROUP_NAME := JavaFX
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   396
  JavaFX_GROUP_MODULES := javafx.*
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   397
  JavaFX_GROUP_DESCRIPTION := \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   398
      The JavaFX APIs define a set of user interface (UI) controls, graphics, \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   399
      media, and web packages for developing rich client applications. These \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   400
      APIs are in modules with names starting with the string "javafx.". \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   401
      #
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   402
  JDK_GROUPS += JavaFX
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   403
endif
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   404
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   405
# All modules to have docs generated by docs-jdk-api target
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   406
JDK_MODULES := $(sort $(DOCS_MODULES))
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   407
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   408
$(eval $(call SetupApiDocsGeneration, JDK_API, \
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   409
    MODULES := $(JDK_MODULES), \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   410
    GROUPS := $(JDK_GROUPS), \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   411
    SHORT_NAME := $(JDK_SHORT_NAME), \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   412
    LONG_NAME := $(JDK_LONG_NAME), \
45103
85999d3d05f0 8175825: Stop including pubs repo
ihse
parents: 45095
diff changeset
   413
    TARGET_DIR := $(DOCS_OUTPUTDIR)/api, \
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   414
))
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   415
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   416
# 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
   417
# JDK_API_MODULEGRAPH_TARGETS.
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   418
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   419
################################################################################
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   420
# 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
   421
45233
538af025db97 8180480: Use "requires transitive" relationship when determining modules for javadoc
ihse
parents: 45229
diff changeset
   422
# The Java SE module scope is just java.se.ee and it's transitive indirect
538af025db97 8180480: Use "requires transitive" relationship when determining modules for javadoc
ihse
parents: 45229
diff changeset
   423
# exports.
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   424
JAVASE_MODULES := java.se.ee
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   425
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   426
$(eval $(call SetupApiDocsGeneration, JAVASE_API, \
45323
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   427
    MODULES := $(JAVASE_MODULES), \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   428
    SHORT_NAME := $(JAVASE_SHORT_NAME), \
52500c1d7f1f 8175824: Adapt javadoc generation to different requirements for JDK and JavaSE
ihse
parents: 45233
diff changeset
   429
    LONG_NAME := $(JAVASE_LONG_NAME), \
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   430
    TARGET_DIR := $(IMAGES_OUTPUTDIR)/javase-docs/api, \
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   431
))
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   432
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   433
# 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
   434
# JAVASE_API_MODULEGRAPH_TARGETS.
36506
17612cee3530 8142968: Module System implementation
alanb
parents: 35817
diff changeset
   435
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   436
################################################################################
45105
bf3dae998ca2 8180208: Provide a new docs bundle page
mchung
parents: 45103
diff changeset
   437
45229
88a3fab6006f 8180426: Use standard css file for new docs bundle index.html page
ihse
parents: 45108
diff changeset
   438
JDK_INDEX_HTML := $(DOCS_OUTPUTDIR)/index.html
45105
bf3dae998ca2 8180208: Provide a new docs bundle page
mchung
parents: 45103
diff changeset
   439
45610
e9dbf9eb0100 8182029: Make the top-level docs index.html to a HTML-level redirect to the API overview page
mchung
parents: 45323
diff changeset
   440
JDK_INDEX_CONTENT := \
e9dbf9eb0100 8182029: Make the top-level docs index.html to a HTML-level redirect to the API overview page
mchung
parents: 45323
diff changeset
   441
    <!DOCTYPE html> \
e9dbf9eb0100 8182029: Make the top-level docs index.html to a HTML-level redirect to the API overview page
mchung
parents: 45323
diff changeset
   442
    <html lang="en"> \
e9dbf9eb0100 8182029: Make the top-level docs index.html to a HTML-level redirect to the API overview page
mchung
parents: 45323
diff changeset
   443
    <head> \
e9dbf9eb0100 8182029: Make the top-level docs index.html to a HTML-level redirect to the API overview page
mchung
parents: 45323
diff changeset
   444
    <meta http-equiv="refresh" content="0;url=api/index.html"> \
e9dbf9eb0100 8182029: Make the top-level docs index.html to a HTML-level redirect to the API overview page
mchung
parents: 45323
diff changeset
   445
    </head> \
e9dbf9eb0100 8182029: Make the top-level docs index.html to a HTML-level redirect to the API overview page
mchung
parents: 45323
diff changeset
   446
    </html>
e9dbf9eb0100 8182029: Make the top-level docs index.html to a HTML-level redirect to the API overview page
mchung
parents: 45323
diff changeset
   447
e9dbf9eb0100 8182029: Make the top-level docs index.html to a HTML-level redirect to the API overview page
mchung
parents: 45323
diff changeset
   448
$(JDK_INDEX_HTML): 
e9dbf9eb0100 8182029: Make the top-level docs index.html to a HTML-level redirect to the API overview page
mchung
parents: 45323
diff changeset
   449
	$(ECHO) '$(JDK_INDEX_CONTENT)' > $@
45105
bf3dae998ca2 8180208: Provide a new docs bundle page
mchung
parents: 45103
diff changeset
   450
45613
3d1c96cd5479 8179556: Add specs copyright file
ihse
parents: 45610
diff changeset
   451
JDK_INDEX_TARGETS += $(JDK_INDEX_HTML)
45229
88a3fab6006f 8180426: Use standard css file for new docs bundle index.html page
ihse
parents: 45108
diff changeset
   452
88a3fab6006f 8180426: Use standard css file for new docs bundle index.html page
ihse
parents: 45108
diff changeset
   453
# Copy the global resources
88a3fab6006f 8180426: Use standard css file for new docs bundle index.html page
ihse
parents: 45108
diff changeset
   454
GLOBAL_SPECS_RESOURCES_DIR := $(JDK_TOPDIR)/make/data/docs-resources/
88a3fab6006f 8180426: Use standard css file for new docs bundle index.html page
ihse
parents: 45108
diff changeset
   455
$(eval $(call SetupCopyFiles, COPY_GLOBAL_RESOURCES, \
88a3fab6006f 8180426: Use standard css file for new docs bundle index.html page
ihse
parents: 45108
diff changeset
   456
    SRC := $(GLOBAL_SPECS_RESOURCES_DIR), \
88a3fab6006f 8180426: Use standard css file for new docs bundle index.html page
ihse
parents: 45108
diff changeset
   457
    FILES := $(call CacheFind, $(GLOBAL_SPECS_RESOURCES_DIR)), \
88a3fab6006f 8180426: Use standard css file for new docs bundle index.html page
ihse
parents: 45108
diff changeset
   458
    DEST := $(DOCS_OUTPUTDIR), \
88a3fab6006f 8180426: Use standard css file for new docs bundle index.html page
ihse
parents: 45108
diff changeset
   459
))
88a3fab6006f 8180426: Use standard css file for new docs bundle index.html page
ihse
parents: 45108
diff changeset
   460
JDK_INDEX_TARGETS += $(COPY_GLOBAL_RESOURCES)
45105
bf3dae998ca2 8180208: Provide a new docs bundle page
mchung
parents: 45103
diff changeset
   461
bf3dae998ca2 8180208: Provide a new docs bundle page
mchung
parents: 45103
diff changeset
   462
################################################################################
44733
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   463
# Copy JDK specs files
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   464
44733
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   465
# For all html documentation in $module/share/specs directories, copy it
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   466
# unmodified
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   467
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   468
ALL_MODULES := $(call FindAllModules)
44983
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44829
diff changeset
   469
COPY_SPEC_FILTER := %.html %.gif %.jpg %.mib %.css
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   470
44733
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   471
$(foreach m, $(ALL_MODULES), \
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   472
  $(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \
45095
704e6f5e9b6d 8178278: Move Standard Algorithm Names document to specs directory
ihse
parents: 44990
diff changeset
   473
  $(foreach d, $(SPECS_$m), \
704e6f5e9b6d 8178278: Move Standard Algorithm Names document to specs directory
ihse
parents: 44990
diff changeset
   474
    $(if $(filter $(COPY_SPEC_FILTER), $(call CacheFind, $d)), \
704e6f5e9b6d 8178278: Move Standard Algorithm Names document to specs directory
ihse
parents: 44990
diff changeset
   475
      $(eval $(call SetupCopyFiles, COPY_$m, \
704e6f5e9b6d 8178278: Move Standard Algorithm Names document to specs directory
ihse
parents: 44990
diff changeset
   476
          SRC := $d, \
704e6f5e9b6d 8178278: Move Standard Algorithm Names document to specs directory
ihse
parents: 44990
diff changeset
   477
          FILES := $(filter $(COPY_SPEC_FILTER), $(call CacheFind, $d)), \
45103
85999d3d05f0 8175825: Stop including pubs repo
ihse
parents: 45095
diff changeset
   478
          DEST := $(DOCS_OUTPUTDIR)/specs/, \
45095
704e6f5e9b6d 8178278: Move Standard Algorithm Names document to specs directory
ihse
parents: 44990
diff changeset
   479
      )) \
704e6f5e9b6d 8178278: Move Standard Algorithm Names document to specs directory
ihse
parents: 44990
diff changeset
   480
      $(eval JDK_SPECS_TARGETS += $(COPY_$m)) \
704e6f5e9b6d 8178278: Move Standard Algorithm Names document to specs directory
ihse
parents: 44990
diff changeset
   481
    ) \
44733
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   482
  ) \
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   483
)
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   484
44734
70bbd6884287 8179022: Add serialization spec as markdown
ihse
parents: 44733
diff changeset
   485
ifeq ($(ENABLE_FULL_DOCS), true)
70bbd6884287 8179022: Add serialization spec as markdown
ihse
parents: 44733
diff changeset
   486
  # For all markdown files in $module/share/specs directories, convert them to
70bbd6884287 8179022: Add serialization spec as markdown
ihse
parents: 44733
diff changeset
   487
  # html.
70bbd6884287 8179022: Add serialization spec as markdown
ihse
parents: 44733
diff changeset
   488
45229
88a3fab6006f 8180426: Use standard css file for new docs bundle index.html page
ihse
parents: 45108
diff changeset
   489
  GLOBAL_SPECS_DEFAULT_CSS_FILE := $(DOCS_OUTPUTDIR)/resources/jdk-default.css
44734
70bbd6884287 8179022: Add serialization spec as markdown
ihse
parents: 44733
diff changeset
   490
70bbd6884287 8179022: Add serialization spec as markdown
ihse
parents: 44733
diff changeset
   491
  $(foreach m, $(ALL_MODULES), \
70bbd6884287 8179022: Add serialization spec as markdown
ihse
parents: 44733
diff changeset
   492
    $(eval SPECS_$m := $(call FindModuleSpecsDirs, $m)) \
44983
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44829
diff changeset
   493
    $(foreach d, $(SPECS_$m), \
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44829
diff changeset
   494
      $(if $(filter %.md, $(call CacheFind, $d)), \
44989
a9bd528e3014 8179658: SetupProcessMarkdown creates long file names
ihse
parents: 44988
diff changeset
   495
        $(eval $(call SetupProcessMarkdown, CONVERT_MARKDOWN_$m_$(patsubst $(TOPDIR)/%,%,$d), \
44983
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44829
diff changeset
   496
            SRC := $d, \
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44829
diff changeset
   497
            FILES := $(filter %.md, $(call CacheFind, $d)), \
45103
85999d3d05f0 8175825: Stop including pubs repo
ihse
parents: 45095
diff changeset
   498
            DEST := $(DOCS_OUTPUTDIR)/specs/, \
44983
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44829
diff changeset
   499
            CSS := $(GLOBAL_SPECS_DEFAULT_CSS_FILE), \
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44829
diff changeset
   500
        )) \
4e216c0475ee 8179453: Add a proper SetupProcessMarkdown
ihse
parents: 44829
diff changeset
   501
      ) \
44989
a9bd528e3014 8179658: SetupProcessMarkdown creates long file names
ihse
parents: 44988
diff changeset
   502
      $(eval JDK_SPECS_TARGETS += $(CONVERT_MARKDOWN_$m_$(patsubst $(TOPDIR)/%,%,$d))) \
44734
70bbd6884287 8179022: Add serialization spec as markdown
ihse
parents: 44733
diff changeset
   503
    ) \
70bbd6884287 8179022: Add serialization spec as markdown
ihse
parents: 44733
diff changeset
   504
  )
70bbd6884287 8179022: Add serialization spec as markdown
ihse
parents: 44733
diff changeset
   505
endif
70bbd6884287 8179022: Add serialization spec as markdown
ihse
parents: 44733
diff changeset
   506
44733
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   507
# Special treatment for generated documentation
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   508
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   509
JDWP_PROTOCOL := $(SUPPORT_OUTPUTDIR)/gensrc/jdk.jdi/jdwp-protocol.html
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   510
$(eval $(call SetupCopyFiles, COPY_JDWP_PROTOCOL, \
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   511
    FILES := $(JDWP_PROTOCOL), \
45103
85999d3d05f0 8175825: Stop including pubs repo
ihse
parents: 45095
diff changeset
   512
    DEST := $(DOCS_OUTPUTDIR)/specs/jdwp, \
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   513
))
44733
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   514
JDK_SPECS_TARGETS += $(COPY_JDWP_PROTOCOL)
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   515
44733
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   516
# Get jvmti.html from the main jvm variant (all variants' jvmti.html are identical).
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   517
JVMTI_HTML := $(HOTSPOT_OUTPUTDIR)/variant-$(JVM_VARIANT_MAIN)/gensrc/jvmtifiles/jvmti.html
41260
4f71f07b30d1 8150736: Excessive disk space used by build system
erikj
parents: 41172
diff changeset
   518
$(eval $(call SetupCopyFiles, COPY_JVMTI_HTML, \
4f71f07b30d1 8150736: Excessive disk space used by build system
erikj
parents: 41172
diff changeset
   519
    FILES := $(JVMTI_HTML), \
45103
85999d3d05f0 8175825: Stop including pubs repo
ihse
parents: 45095
diff changeset
   520
    DEST := $(DOCS_OUTPUTDIR)/specs, \
41260
4f71f07b30d1 8150736: Excessive disk space used by build system
erikj
parents: 41172
diff changeset
   521
))
44733
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   522
JDK_SPECS_TARGETS += $(COPY_JVMTI_HTML)
13697
5262b00bc10c 7197849: Update new build-infra makefiles
ohair
parents:
diff changeset
   523
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   524
################################################################################
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   525
# 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
   526
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   527
JAVADOC_ZIP_NAME := jdk-$(VERSION_STRING)-docs.zip
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   528
JAVADOC_ZIP_FILE := $(OUTPUT_ROOT)/bundles/$(JAVADOC_ZIP_NAME)
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   529
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   530
$(eval $(call SetupZipArchive, BUILD_JAVADOC_ZIP, \
45103
85999d3d05f0 8175825: Stop including pubs repo
ihse
parents: 45095
diff changeset
   531
    SRC := $(DOCS_OUTPUTDIR), \
44733
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   532
    ZIP := $(JAVADOC_ZIP_FILE), \
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   533
    EXTRA_DEPS := $(JDK_API_JAVADOC_TARGETS) $(JDK_API_MODULEGRAPH_TARGETS) \
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   534
        $(JDK_SPECS_TARGETS), \
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   535
))
37034
b63fd4af003e 8154313: Generated javadoc scattered all over the place
neugens
parents: 36792
diff changeset
   536
44725
8747b14eb49c 8172312: Update docs target and image for new combined docs
ihse
parents: 44397
diff changeset
   537
ZIP_TARGETS += $(BUILD_JAVADOC_ZIP)
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   538
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   539
################################################################################
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   540
45103
85999d3d05f0 8175825: Stop including pubs repo
ihse
parents: 45095
diff changeset
   541
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
   542
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   543
docs-jdk-api-modulegraph: $(JDK_API_MODULEGRAPH_TARGETS)
44397
f932d6b9f7fe 8173303: Add module-subgraph images to main platform documentation
mchung
parents: 44071
diff changeset
   544
45103
85999d3d05f0 8175825: Stop including pubs repo
ihse
parents: 45095
diff changeset
   545
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
   546
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   547
docs-javase-api-modulegraph: $(JAVASE_API_MODULEGRAPH_TARGETS)
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   548
44733
6505f00be6f2 8178038: Copy jdwp-protocol.html to proper location
ihse
parents: 44732
diff changeset
   549
docs-jdk-specs: $(JDK_SPECS_TARGETS)
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   550
45229
88a3fab6006f 8180426: Use standard css file for new docs bundle index.html page
ihse
parents: 45108
diff changeset
   551
docs-jdk-index: $(JDK_INDEX_TARGETS)
45105
bf3dae998ca2 8180208: Provide a new docs bundle page
mchung
parents: 45103
diff changeset
   552
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   553
docs-zip: $(ZIP_TARGETS)
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   554
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   555
all: docs-jdk-api-javadoc docs-jdk-api-modulegraph docs-javase-api-javadoc \
45105
bf3dae998ca2 8180208: Provide a new docs bundle page
mchung
parents: 45103
diff changeset
   556
    docs-javase-api-modulegraph docs-jdk-specs docs-jdk-index docs-zip
41652
a0664e2b49a1 8168772: Convert javadoc generation to build-infra standards
ihse
parents: 41260
diff changeset
   557
44726
04aa2c065f5c 8176785: Add build support to generate PNG file from .dot file
ihse
parents: 44725
diff changeset
   558
.PHONY: default all docs-jdk-api-javadoc docs-jdk-api-modulegraph \
45105
bf3dae998ca2 8180208: Provide a new docs bundle page
mchung
parents: 45103
diff changeset
   559
    docs-javase-api-javadoc docs-javase-api-modulegraph docs-jdk-specs \
bf3dae998ca2 8180208: Provide a new docs bundle page
mchung
parents: 45103
diff changeset
   560
    docs-jdk-index docs-zip