33 |
33 |
34 # This is needed to properly setup DOCS_MODULES. |
34 # This is needed to properly setup DOCS_MODULES. |
35 $(eval $(call ReadImportMetaData)) |
35 $(eval $(call ReadImportMetaData)) |
36 |
36 |
37 ################################################################################ |
37 ################################################################################ |
|
38 |
|
39 # Hook to include the corresponding custom file, if present. |
|
40 $(eval $(call IncludeCustomExtension, , Javadoc.gmk)) |
|
41 |
|
42 ################################################################################ |
38 # Javadoc settings |
43 # Javadoc settings |
39 |
44 |
40 # On top of the sources that was used to compile the JDK, we need some |
45 # On top of the sources that was used to compile the JDK, we need some |
41 # extra java.rmi sources that are used just for javadoc. |
46 # extra java.rmi sources that are used just for javadoc. |
42 MODULES_SOURCE_PATH := $(call PathList, $(call GetModuleSrcPath) \ |
47 MODULES_SOURCE_PATH := $(call PathList, $(call GetModuleSrcPath) \ |
43 $(SUPPORT_OUTPUTDIR)/rmic/* $(JDK_TOPDIR)/src/*/share/doc/stub) |
48 $(SUPPORT_OUTPUTDIR)/rmic/* $(JDK_TOPDIR)/src/*/share/doc/stub) |
44 |
49 |
45 # Should we use -Xdocrootparent? Allow custom to overwrite. |
50 # Should we use -Xdocrootparent? Allow custom to overwrite. |
46 DOCROOTPARENT_FLAG = TRUE |
51 DOCROOTPARENT_FLAG ?= TRUE |
47 |
52 |
48 # URLs |
53 # URLs |
49 JAVADOC_BASE_URL := http://docs.oracle.com/javase/$(VERSION_SPECIFICATION)/docs |
54 JAVADOC_BASE_URL := http://docs.oracle.com/javase/$(VERSION_SPECIFICATION)/docs |
50 BUG_SUBMIT_URL := http://bugreport.java.com/bugreport/ |
55 BUG_SUBMIT_URL := http://bugreport.java.com/bugreport/ |
51 COPYRIGHT_URL := {@docroot}/../legal/cpyr.html |
56 COPYRIGHT_URL := {@docroot}/../legal/cpyr.html |
75 -tag 'jvms:a:See <cite>The Java™ Virtual Machine Specification</cite>:' \ |
80 -tag 'jvms:a:See <cite>The Java™ Virtual Machine Specification</cite>:' \ |
76 -tag 'jls:a:See <cite>The Java™ Language Specification</cite>:' \ |
81 -tag 'jls:a:See <cite>The Java™ Language Specification</cite>:' \ |
77 -taglet build.tools.taglet.ExtLink \ |
82 -taglet build.tools.taglet.ExtLink \ |
78 -taglet build.tools.taglet.Incubating \ |
83 -taglet build.tools.taglet.Incubating \ |
79 -tagletpath $(BUILDTOOLS_OUTPUTDIR)/jdk_tools_classes \ |
84 -tagletpath $(BUILDTOOLS_OUTPUTDIR)/jdk_tools_classes \ |
|
85 $(CUSTOM_JAVADOC_TAGS) \ |
80 # |
86 # |
81 |
87 |
82 # Which doclint checks to ignore |
88 # Which doclint checks to ignore |
83 JAVADOC_DISABLED_DOCLINT := accessibility html missing syntax reference |
89 JAVADOC_DISABLED_DOCLINT := accessibility html missing syntax reference |
84 |
90 |
216 |
222 |
217 # Create a string like "-Xdoclint:all,-syntax,-html,..." |
223 # Create a string like "-Xdoclint:all,-syntax,-html,..." |
218 $1_OPTIONS += -Xdoclint:all,$$(call CommaList, $$(addprefix -, \ |
224 $1_OPTIONS += -Xdoclint:all,$$(call CommaList, $$(addprefix -, \ |
219 $$(JAVADOC_DISABLED_DOCLINT))) |
225 $$(JAVADOC_DISABLED_DOCLINT))) |
220 |
226 |
221 ifneq ($$($$DOCROOTPARENT_FLAG), ) |
227 ifeq ($$($$DOCROOTPARENT_FLAG), TRUE) |
222 $1_OPTIONS += -Xdocrootparent $$(JAVADOC_BASE_URL) |
228 $1_OPTIONS += -Xdocrootparent $$(JAVADOC_BASE_URL) |
223 endif |
229 endif |
224 |
230 |
225 $1_OPTIONS += -doctitle '$$($1_DOC_TITLE)' |
231 $1_OPTIONS += -doctitle '$$($1_DOC_TITLE)' |
226 $1_OPTIONS += -windowtitle '$$($1_WINDOW_TITLE)' |
232 $1_OPTIONS += -windowtitle '$$($1_WINDOW_TITLE)' |
428 |
434 |
429 ZIP_TARGETS += $(BUILD_JAVADOC_ZIP) |
435 ZIP_TARGETS += $(BUILD_JAVADOC_ZIP) |
430 |
436 |
431 ################################################################################ |
437 ################################################################################ |
432 |
438 |
433 # Hook to include the corresponding custom file, if present. |
|
434 $(eval $(call IncludeCustomExtension, , Javadoc.gmk)) |
|
435 |
|
436 ################################################################################ |
|
437 |
|
438 docs-jdk-api-javadoc: $(JDK_API_JAVADOC_TARGETS) |
439 docs-jdk-api-javadoc: $(JDK_API_JAVADOC_TARGETS) |
439 |
440 |
440 docs-jdk-api-modulegraph: $(JDK_API_MODULEGRAPH_TARGETS) |
441 docs-jdk-api-modulegraph: $(JDK_API_MODULEGRAPH_TARGETS) |
441 |
442 |
442 docs-javase-api-javadoc: $(JAVASE_API_JAVADOC_TARGETS) |
443 docs-javase-api-javadoc: $(JAVASE_API_JAVADOC_TARGETS) |