equal
deleted
inserted
replaced
1 # Copyright (c) 1997, 2017, Oracle and/or its affiliates. All rights reserved. |
1 # Copyright (c) 1997, 2018, Oracle and/or its affiliates. All rights reserved. |
2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
2 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
3 # |
3 # |
4 # This code is free software; you can redistribute it and/or modify it |
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 |
5 # under the terms of the GNU General Public License version 2 only, as |
6 # published by the Free Software Foundation. Oracle designates this |
6 # published by the Free Software Foundation. Oracle designates this |
42 ################################################################################ |
42 ################################################################################ |
43 # This file generates all documentation for OpenJDK. |
43 # This file generates all documentation for OpenJDK. |
44 # |
44 # |
45 # We will generate API documentation for two different selections of the source |
45 # We will generate API documentation for two different selections of the source |
46 # code: "Java SE", which contains just the modules covered by the top-level |
46 # code: "Java SE", which contains just the modules covered by the top-level |
47 # module java.se.ee, and "JDK", which covers all of Java SE and also all |
47 # module java.se and "JDK", which covers all of Java SE and also all |
48 # other available modules that should be documented, including imported modules, |
48 # other available modules that should be documented, including imported modules, |
49 # if any. |
49 # if any. |
50 # |
50 # |
51 # We will also generate separate, free-standing specifications from either |
51 # We will also generate separate, free-standing specifications from either |
52 # markdown or existing html files. |
52 # markdown or existing html files. |
59 # extra java.rmi sources that are used just for javadoc. |
59 # extra java.rmi sources that are used just for javadoc. |
60 MODULES_SOURCE_PATH := $(call PathList, $(call GetModuleSrcPath) \ |
60 MODULES_SOURCE_PATH := $(call PathList, $(call GetModuleSrcPath) \ |
61 $(SUPPORT_OUTPUTDIR)/rmic/* $(TOPDIR)/src/*/share/doc/stub) |
61 $(SUPPORT_OUTPUTDIR)/rmic/* $(TOPDIR)/src/*/share/doc/stub) |
62 |
62 |
63 # URLs |
63 # URLs |
64 JAVADOC_BASE_URL := http://www.oracle.com/pls/topic/lookup?ctx=javase9&id=homepage |
64 JAVADOC_BASE_URL := http://www.oracle.com/pls/topic/lookup?ctx=javase10&id=homepage |
65 BUG_SUBMIT_URL := http://bugreport.java.com/bugreport/ |
65 BUG_SUBMIT_URL := http://bugreport.java.com/bugreport/ |
66 COPYRIGHT_URL := {@docroot}/../legal/copyright.html |
66 COPYRIGHT_URL := {@docroot}/../legal/copyright.html |
67 LICENSE_URL := http://www.oracle.com/technetwork/java/javase/terms/license/java10speclicense.html |
67 LICENSE_URL := http://www.oracle.com/technetwork/java/javase/terms/license/java10speclicense.html |
68 REDISTRIBUTION_URL := http://www.oracle.com/technetwork/java/redist-137594.html |
68 REDISTRIBUTION_URL := http://www.oracle.com/technetwork/java/redist-137594.html |
69 |
69 |
198 # param 1: SetupJavadocGeneration namespace ($1) |
198 # param 1: SetupJavadocGeneration namespace ($1) |
199 # param 2: module name |
199 # param 2: module name |
200 # |
200 # |
201 define setup_gengraph_dot_to_png |
201 define setup_gengraph_dot_to_png |
202 $1_$2_DOT_SRC := $$($1_GENGRAPHS_DIR)/$2.dot |
202 $1_$2_DOT_SRC := $$($1_GENGRAPHS_DIR)/$2.dot |
203 $1_$2_PNG_TARGET := $$($1_TARGET_DIR)/$2-graph.png |
203 $1_$2_PNG_TARGET := $$($1_TARGET_DIR)/$2/module-graph.png |
204 |
204 |
205 # For each module needing a graph, create a png file from the dot file |
205 # For each module needing a graph, create a png file from the dot file |
206 # generated by the GenGraphs tool and store it in the target dir. |
206 # generated by the GenGraphs tool and store it in the target dir. |
207 $$($1_$2_PNG_TARGET): $$($1_GENGRAPHS_MARKER) |
207 $$($1_$2_PNG_TARGET): $$($1_GENGRAPHS_MARKER) |
208 $$(call MakeDir, $$(@D)) |
208 $$(call MakeDir, $$(@D)) |
394 ################################################################################ |
394 ################################################################################ |
395 # Setup generation of the JDK API documentation (javadoc + modulegraph) |
395 # Setup generation of the JDK API documentation (javadoc + modulegraph) |
396 |
396 |
397 # Define the groups of the JDK API documentation |
397 # Define the groups of the JDK API documentation |
398 JavaSE_GROUP_NAME := Java SE |
398 JavaSE_GROUP_NAME := Java SE |
399 JavaSE_GROUP_MODULES := $(call ColonList, $(sort java.se.ee \ |
399 JavaSE_GROUP_MODULES := $(call ColonList, $(sort java.se \ |
400 $(call FindTransitiveIndirectDepsForModules, java.se.ee))) |
400 $(call FindTransitiveIndirectDepsForModules, java.se))) |
401 JavaSE_GROUP_DESCRIPTION := \ |
401 JavaSE_GROUP_DESCRIPTION := \ |
402 The Java Platform, Standard Edition (Java SE) APIs define the core Java \ |
402 The Java Platform, Standard Edition (Java SE) APIs define the core Java \ |
403 platform for general-purpose computing. These APIs are in modules whose \ |
403 platform for general-purpose computing. These APIs are in modules whose \ |
404 names start with {@code java}. \ |
404 names start with {@code java}. \ |
405 # |
405 # |
443 # JDK_API_MODULEGRAPH_TARGETS. |
443 # JDK_API_MODULEGRAPH_TARGETS. |
444 |
444 |
445 ################################################################################ |
445 ################################################################################ |
446 # Setup generation of the Java SE API documentation (javadoc + modulegraph) |
446 # Setup generation of the Java SE API documentation (javadoc + modulegraph) |
447 |
447 |
448 # The Java SE module scope is just java.se.ee and its transitive indirect |
448 # The Java SE module scope is just java.se and its transitive indirect |
449 # exports. |
449 # exports. |
450 JAVASE_MODULES := java.se.ee |
450 JAVASE_MODULES := java.se |
451 |
451 |
452 $(eval $(call SetupApiDocsGeneration, JAVASE_API, \ |
452 $(eval $(call SetupApiDocsGeneration, JAVASE_API, \ |
453 MODULES := $(JAVASE_MODULES), \ |
453 MODULES := $(JAVASE_MODULES), \ |
454 SHORT_NAME := $(JAVASE_SHORT_NAME), \ |
454 SHORT_NAME := $(JAVASE_SHORT_NAME), \ |
455 LONG_NAME := $(JAVASE_LONG_NAME), \ |
455 LONG_NAME := $(JAVASE_LONG_NAME), \ |