1 # Copyright (c) 1997, 2019, Oracle and/or its affiliates. All rights reserved.
2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 #
4 # This code is free software; you can redistribute it and/or modify it
5 # under the terms of the GNU General Public License version 2 only, as
6 # published by the Free Software Foundation. Oracle designates this
7 # particular file as subject to the "Classpath" exception as provided
8 # by Oracle in the LICENSE file that accompanied this code.
9 #
10 # This code is distributed in the hope that it will be useful, but WITHOUT
11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 # version 2 for more details (a copy is included in the LICENSE file that
14 # accompanied this code).
15 #
16 # You should have received a copy of the GNU General Public License version
17 # 2 along with this work; if not, write to the Free Software Foundation,
18 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 #
20 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 # or visit www.oracle.com if you need additional information or have any
40 ################################################################################
41 # Hook to include the corresponding custom file, if present.
42 $(eval $(call IncludeCustomExtension, Docs.gmk))
43
44 ################################################################################
45 # This file generates all documentation for OpenJDK.
46 #
47 # We will generate API documentation for two different selections of the source
48 # code: "Java SE", which contains just the modules covered by the top-level
49 # module java.se and "JDK", which covers all of Java SE and also all
50 # other available modules that should be documented, including imported modules,
51 # if any.
52 #
53 # We will also generate separate, free-standing specifications from either
54 # markdown or existing html files.
55 #
56
57 ################################################################################
58 # Javadoc settings
59
60 # On top of the sources that was used to compile the JDK, we need some
61 # extra java.rmi sources that are used just for javadoc.
62 MODULES_SOURCE_PATH := $(call PathList, $(call GetModuleSrcPath) \
63 $(SUPPORT_OUTPUTDIR)/rmic/* $(TOPDIR)/src/*/share/doc/stub)
64
65 # URLs
66 JAVADOC_BASE_URL := https://docs.oracle.com/pls/topic/lookup?ctx=javase$(VERSION_NUMBER)&id=homepage
67 BUG_SUBMIT_URL := https://bugreport.java.com/bugreport/
68 COPYRIGHT_URL := legal/copyright.html
69 LICENSE_URL := https://www.oracle.com/technetwork/java/javase/terms/license/java$(VERSION_NUMBER)speclicense.html
70 REDISTRIBUTION_URL := https://www.oracle.com/technetwork/java/redist-137594.html
71
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.
74 JAVADOC_TAGS := \
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:' \
|
1 # Copyright (c) 1997, 2020, Oracle and/or its affiliates. All rights reserved.
2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 #
4 # This code is free software; you can redistribute it and/or modify it
5 # under the terms of the GNU General Public License version 2 only, as
6 # published by the Free Software Foundation. Oracle designates this
7 # particular file as subject to the "Classpath" exception as provided
8 # by Oracle in the LICENSE file that accompanied this code.
9 #
10 # This code is distributed in the hope that it will be useful, but WITHOUT
11 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 # version 2 for more details (a copy is included in the LICENSE file that
14 # accompanied this code).
15 #
16 # You should have received a copy of the GNU General Public License version
17 # 2 along with this work; if not, write to the Free Software Foundation,
18 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 #
20 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
21 # or visit www.oracle.com if you need additional information or have any
40 ################################################################################
41 # Hook to include the corresponding custom file, if present.
42 $(eval $(call IncludeCustomExtension, Docs.gmk))
43
44 ################################################################################
45 # This file generates all documentation for OpenJDK.
46 #
47 # We will generate API documentation for two different selections of the source
48 # code: "Java SE", which contains just the modules covered by the top-level
49 # module java.se and "JDK", which covers all of Java SE and also all
50 # other available modules that should be documented, including imported modules,
51 # if any.
52 #
53 # We will also generate separate, free-standing specifications from either
54 # markdown or existing html files.
55 #
56
57 ################################################################################
58 # Javadoc settings
59
60 # On top of the sources that was used to compile the JDK, we need some extra sources
61 MODULES_SOURCE_PATH := $(call PathList, $(call GetModuleSrcPath) )
62
63 # URLs
64 JAVADOC_BASE_URL := https://docs.oracle.com/pls/topic/lookup?ctx=javase$(VERSION_NUMBER)&id=homepage
65 BUG_SUBMIT_URL := https://bugreport.java.com/bugreport/
66 COPYRIGHT_URL := legal/copyright.html
67 LICENSE_URL := https://www.oracle.com/technetwork/java/javase/terms/license/java$(VERSION_NUMBER)speclicense.html
68 REDISTRIBUTION_URL := https://www.oracle.com/technetwork/java/redist-137594.html
69
70 # In order to get a specific ordering it's necessary to specify the total
71 # ordering of tags as the tags are otherwise ordered in order of definition.
72 JAVADOC_TAGS := \
73 -tag beaninfo:X \
74 -tag revised:X \
75 -tag since.unbundled:X \
76 -tag spec:X \
77 -tag specdefault:X \
78 -tag Note:X \
79 -tag ToDo:X \
80 -tag 'apiNote:a:API Note:' \
81 -tag 'implSpec:a:Implementation Requirements:' \
|