273 define OptionPair # opt arg
274 $(PRINTF) "%s '%s'\n" "$(strip $1)" '$(strip $2)'
275 endef
276
277 define OptionTrip # opt arg arg
278 $(PRINTF) "%s '%s' '%s'\n" "$(strip $1)" '$(strip $2)' '$(strip $3)'
279 endef
280
281 # Core api bottom argument (with special sauce)
282 COREAPI_BOTTOM = <font size="-1"> $(BUG_SUBMIT_LINE)\
283 <br>For further API reference and developer documentation, \
284 see <a href="$(DEV_DOCS_URL)" target="_blank">Java SE Documentation</a>. \
285 That documentation contains more detailed, developer-targeted descriptions, \
286 with conceptual overviews, definitions of terms, workarounds, \
287 and working code examples.<br>\
288 $(call CopyrightLine,$(COPYRIGHT_URL),$(FIRST_COPYRIGHT_YEAR),)\
289 </font>
290
291 # Common javadoc options used by all bundles
292
293 ifdef OPENJDK
294 ADDITIONAL_JAVADOCFLAGS = \
295 -Xdocrootparent $(DOCS_BASE_URL)
296 else
297 ADDITIONAL_JAVADOCFLAGS =
298 endif
299
300 define COMMON_JAVADOCFLAGS
301 $(call OptionOnly,-XDignore.symbol.file=true) ; \
302 $(call OptionOnly,-quiet) ; \
303 $(call OptionOnly,-use) ; \
304 $(call OptionOnly,-keywords) ; \
305 $(call OptionOnly,$(ADDITIONAL_JAVADOCFLAGS))
306 endef
307
308 # Common javadoc tags used by all bundles
309
310 # Java language specification cite
311 TAG_JLS = jls:a:See <cite> \
312 The Java™ Language Specification</cite>:
313
314 # Java virtual machine specification cite
315 TAG_JVMS = jvms:a:See <cite> \
316 The Java™ Virtual Machine Specification</cite>:
317
318 # In order to get a specific ordering it's necessary to specify the total
319 # ordering of tags as the tags are otherwise ordered in order of definition.
320 define COMMON_JAVADOCTAGS
321 $(call OptionPair,-tag,beaninfo:X) ; \
322 $(call OptionPair,-tag,revised:X) ; \
323 $(call OptionPair,-tag,since.unbundled:X) ; \
324 $(call OptionPair,-tag,spec:X) ; \
325 $(call OptionPair,-tag,specdefault:X) ; \
1021 $(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1022 $(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \
1023 $(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \
1024 $(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \
1025 ) >> $@
1026
1027 # Create a file with the package names in it
1028 $(HTTPSERVER_PACKAGES_FILE): $(call PackageDependencies,$(HTTPSERVER_PKGS))
1029 $(prep-target)
1030 $(call PackageFilter,$(HTTPSERVER_PKGS))
1031
1032 #############################################################
1033 #
1034 # mgmtdocs
1035 #
1036
1037 ALL_OTHER_TARGETS += mgmtdocs
1038
1039 MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension
1040 MGMT2COREAPI := ../../$(JDKJRE2COREAPI)
1041 JVM_MIB_NAME := JVM-MANAGEMENT-MIB.mib
1042 JVM_MIB_SRC := $(JDK_TOPDIR)/src/closed/jdk.snmp/share/classes/sun/management/snmp/$(JVM_MIB_NAME)
1043 MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform
1044 MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform
1045 MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong>
1046 MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR))
1047 MGMT_OVERVIEW := $(JDK_TOPDIR)/src/java.management/share/classes/mgmt-overview.html
1048 # MGMT_PKGS is located in NON_CORE_PKGS.gmk
1049
1050 # The index.html, options, and packages files
1051 MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html
1052 MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options
1053 MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages
1054
1055 # The modules required to be documented
1056 MGMT_MODULES = jdk.management
1057
1058 mgmtdocs: $(MGMT_INDEX_FILE)
1059
1060 # Set relative location to core api document root
1061 $(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/..
1062
1063 # Run javadoc if the index file is out of date or missing
1064 $(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1065 $(prep-javadoc)
1066 @if [ -f $(JVM_MIB_SRC) ] ; then \
1067 $(CP) $(JVM_MIB_SRC) $(@D)/.. ; \
1068 else \
1069 $(ECHO) "WARNING: File $(JVM_MIB_NAME) not available."; \
1070 fi
1071 $(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE))
1072 $(JAVADOC_CMD_SMALL) -d $(@D) \
1073 @$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE)
1074
1075 # Create file with javadoc options in it
1076 $(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW)
1077 $(prep-target)
1078 @($(call COMMON_JAVADOCFLAGS) ; \
1079 $(call COMMON_JAVADOCTAGS) ; \
1080 $(call OptionOnly,-Xdoclint:none) ; \
1081 $(call OptionPair,-system,none) ; \
1082 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
1083 $(call OptionPair,-addmods,$(MGMT_MODULES)) ; \
1084 $(call OptionPair,-encoding,ascii) ; \
1085 $(call OptionOnly,-nodeprecatedlist) ; \
1086 $(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \
1087 $(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \
1088 $(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1089 $(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \
1090 $(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \
1688 #
1689
1690 $(JAVADOC_ARCHIVE): $(COREAPI_INDEX_FILE)
1691 $(call LogInfo, Compressing javadoc to single $(JAVADOC_ARCHIVE_NAME))
1692 $(MKDIR) -p $(JAVADOC_ARCHIVE_DIR)
1693 $(RM) -r $(JAVADOC_ARCHIVE_ASSEMBLY_DIR)
1694 $(MKDIR) -p $(JAVADOC_ARCHIVE_ASSEMBLY_DIR)
1695 all_roots=`$(FIND) $(DOCSDIR) | $(GREP) index.html | grep -v old/doclet`; \
1696 pushd $(JAVADOC_ARCHIVE_ASSEMBLY_DIR); \
1697 for index_file in $${all_roots} ; do \
1698 target_dir=`dirname $${index_file}`; \
1699 name=`$(ECHO) $${target_dir} | $(SED) "s;/spec;;" | $(SED) "s;.*/;;"`; \
1700 $(LN) -s $${target_dir} $${name}; \
1701 done; \
1702 $(ZIP) -q -r $(JAVADOC_ARCHIVE) * ; \
1703 popd ;
1704
1705 #############################################################
1706 .PHONY: all docs coredocs otherdocs \
1707 $(ALL_OTHER_TARGETS) zip-docs
|
273 define OptionPair # opt arg
274 $(PRINTF) "%s '%s'\n" "$(strip $1)" '$(strip $2)'
275 endef
276
277 define OptionTrip # opt arg arg
278 $(PRINTF) "%s '%s' '%s'\n" "$(strip $1)" '$(strip $2)' '$(strip $3)'
279 endef
280
281 # Core api bottom argument (with special sauce)
282 COREAPI_BOTTOM = <font size="-1"> $(BUG_SUBMIT_LINE)\
283 <br>For further API reference and developer documentation, \
284 see <a href="$(DEV_DOCS_URL)" target="_blank">Java SE Documentation</a>. \
285 That documentation contains more detailed, developer-targeted descriptions, \
286 with conceptual overviews, definitions of terms, workarounds, \
287 and working code examples.<br>\
288 $(call CopyrightLine,$(COPYRIGHT_URL),$(FIRST_COPYRIGHT_YEAR),)\
289 </font>
290
291 # Common javadoc options used by all bundles
292
293 # This flag may be overridden from a custom makefile
294 DOCROOTPARENT_FLAG = -Xdocrootparent $(DOCS_BASE_URL)
295
296 define COMMON_JAVADOCFLAGS
297 $(call OptionOnly,-XDignore.symbol.file=true) ; \
298 $(call OptionOnly,-quiet) ; \
299 $(call OptionOnly,-use) ; \
300 $(call OptionOnly,-keywords) ; \
301 $(call OptionOnly,$(DOCROOTPARENT_FLAG))
302 endef
303
304 # Common javadoc tags used by all bundles
305
306 # Java language specification cite
307 TAG_JLS = jls:a:See <cite> \
308 The Java™ Language Specification</cite>:
309
310 # Java virtual machine specification cite
311 TAG_JVMS = jvms:a:See <cite> \
312 The Java™ Virtual Machine Specification</cite>:
313
314 # In order to get a specific ordering it's necessary to specify the total
315 # ordering of tags as the tags are otherwise ordered in order of definition.
316 define COMMON_JAVADOCTAGS
317 $(call OptionPair,-tag,beaninfo:X) ; \
318 $(call OptionPair,-tag,revised:X) ; \
319 $(call OptionPair,-tag,since.unbundled:X) ; \
320 $(call OptionPair,-tag,spec:X) ; \
321 $(call OptionPair,-tag,specdefault:X) ; \
1017 $(call OptionPair,-windowtitle,$(HTTPSERVER_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1018 $(call OptionPair,-header,$(HTTPSERVER_HEADER)$(DRAFT_HEADER)); \
1019 $(call OptionPair,-bottom,$(HTTPSERVER_BOTTOM)$(DRAFT_BOTTOM)); \
1020 $(call OptionTrip,-linkoffline,$(HTTPSERVER2COREAPI),$(COREAPI_DOCSDIR)/); \
1021 ) >> $@
1022
1023 # Create a file with the package names in it
1024 $(HTTPSERVER_PACKAGES_FILE): $(call PackageDependencies,$(HTTPSERVER_PKGS))
1025 $(prep-target)
1026 $(call PackageFilter,$(HTTPSERVER_PKGS))
1027
1028 #############################################################
1029 #
1030 # mgmtdocs
1031 #
1032
1033 ALL_OTHER_TARGETS += mgmtdocs
1034
1035 MGMT_DOCDIR := $(JRE_API_DOCSDIR)/management/extension
1036 MGMT2COREAPI := ../../$(JDKJRE2COREAPI)
1037 MGMT_DOCTITLE := Monitoring and Management Interface for the Java$(TRADEMARK) Platform
1038 MGMT_WINDOWTITLE := Monitoring and Management Interface for the Java Platform
1039 MGMT_HEADER := <strong>Monitoring and Management Interface for the Java Platform</strong>
1040 MGMT_BOTTOM := $(call CommonBottom,$(MGMT_FIRST_COPYRIGHT_YEAR))
1041 MGMT_OVERVIEW := $(JDK_TOPDIR)/src/java.management/share/classes/mgmt-overview.html
1042 # MGMT_PKGS is located in NON_CORE_PKGS.gmk
1043
1044 # The index.html, options, and packages files
1045 MGMT_INDEX_FILE = $(MGMT_DOCDIR)/index.html
1046 MGMT_OPTIONS_FILE = $(DOCSTMPDIR)/mgmt.options
1047 MGMT_PACKAGES_FILE = $(DOCSTMPDIR)/mgmt.packages
1048
1049 # The modules required to be documented
1050 MGMT_MODULES = jdk.management
1051
1052 mgmtdocs: $(MGMT_INDEX_FILE)
1053
1054 # Set relative location to core api document root
1055 $(MGMT_INDEX_FILE): GET2DOCSDIR=$(MGMT2COREAPI)/..
1056
1057 # Run javadoc if the index file is out of date or missing
1058 $(MGMT_INDEX_FILE): $(MGMT_OPTIONS_FILE) $(MGMT_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
1059 $(prep-javadoc)
1060 $(call JavadocSummary,$(MGMT_OPTIONS_FILE),$(MGMT_PACKAGES_FILE))
1061 $(JAVADOC_CMD_SMALL) -d $(@D) \
1062 @$(MGMT_OPTIONS_FILE) @$(MGMT_PACKAGES_FILE)
1063
1064 # Create file with javadoc options in it
1065 $(MGMT_OPTIONS_FILE): $(MGMT_OVERVIEW)
1066 $(prep-target)
1067 @($(call COMMON_JAVADOCFLAGS) ; \
1068 $(call COMMON_JAVADOCTAGS) ; \
1069 $(call OptionOnly,-Xdoclint:none) ; \
1070 $(call OptionPair,-system,none) ; \
1071 $(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
1072 $(call OptionPair,-addmods,$(MGMT_MODULES)) ; \
1073 $(call OptionPair,-encoding,ascii) ; \
1074 $(call OptionOnly,-nodeprecatedlist) ; \
1075 $(call OptionPair,-overview,$(MGMT_OVERVIEW)) ; \
1076 $(call OptionPair,-doctitle,$(MGMT_DOCTITLE)) ; \
1077 $(call OptionPair,-windowtitle,$(MGMT_WINDOWTITLE) $(DRAFT_WINTITLE)); \
1078 $(call OptionPair,-header,$(MGMT_HEADER)$(DRAFT_HEADER)) ; \
1079 $(call OptionPair,-bottom,$(MGMT_BOTTOM)$(DRAFT_BOTTOM)) ; \
1677 #
1678
1679 $(JAVADOC_ARCHIVE): $(COREAPI_INDEX_FILE)
1680 $(call LogInfo, Compressing javadoc to single $(JAVADOC_ARCHIVE_NAME))
1681 $(MKDIR) -p $(JAVADOC_ARCHIVE_DIR)
1682 $(RM) -r $(JAVADOC_ARCHIVE_ASSEMBLY_DIR)
1683 $(MKDIR) -p $(JAVADOC_ARCHIVE_ASSEMBLY_DIR)
1684 all_roots=`$(FIND) $(DOCSDIR) | $(GREP) index.html | grep -v old/doclet`; \
1685 pushd $(JAVADOC_ARCHIVE_ASSEMBLY_DIR); \
1686 for index_file in $${all_roots} ; do \
1687 target_dir=`dirname $${index_file}`; \
1688 name=`$(ECHO) $${target_dir} | $(SED) "s;/spec;;" | $(SED) "s;.*/;;"`; \
1689 $(LN) -s $${target_dir} $${name}; \
1690 done; \
1691 $(ZIP) -q -r $(JAVADOC_ARCHIVE) * ; \
1692 popd ;
1693
1694 #############################################################
1695 .PHONY: all docs coredocs otherdocs \
1696 $(ALL_OTHER_TARGETS) zip-docs
1697
1698 ################################################################################
1699
1700 $(eval $(call IncludeCustomExtension, , Javadoc-post.gmk))
|