stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8153243: make docs should generate JShell API docs

Browse Source 
Reviewed-by: erikj
This commit is contained in:
Jan Lahoda 2016-04-08 11:51:53 +02:00
parent 03d53bec41
commit 2231f3da69
2 changed files with 62 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
make/Javadoc.gmk
View File

@ -74,6 +74,7 @@ ATTACH_FIRST_COPYRIGHT_YEAR = 2005
JCONSOLE_FIRST_COPYRIGHT_YEAR = 2006
SCTPAPI_FIRST_COPYRIGHT_YEAR = 2009
TRACING_FIRST_COPYRIGHT_YEAR = 2008
JSHELLAPI_FIRST_COPYRIGHT_YEAR = 2015
TREEAPI_FIRST_COPYRIGHT_YEAR = 2005
NASHORNAPI_FIRST_COPYRIGHT_YEAR = 2014
DYNALINKAPI_FIRST_COPYRIGHT_YEAR = 2015
@ -1197,6 +1198,65 @@ $(JCONSOLE_PACKAGES_FILE): $(call PackageDependencies,$(JCONSOLE_PKGS))
$(prep-target)
$(call PackageFilter,$(JCONSOLE_PKGS))
#############################################################
#
# jshellapidocs
#
ALL_OTHER_TARGETS += jshellapidocs
JSHELLAPI_DOCDIR := $(JDK_API_DOCSDIR)/jshell
JSHELLAPI2COREAPI := ../../$(JDKJRE2COREAPI)
JSHELLAPI_DOCTITLE := JShell API
JSHELLAPI_WINDOWTITLE := JShell API
JSHELLAPI_HEADER := <strong>JSHELL API</strong>
JSHELLAPI_BOTTOM := $(call CommonBottom,$(JSHELLAPI_FIRST_COPYRIGHT_YEAR))
JSHELLAPI_GROUPNAME := Packages
JSHELLAPI_REGEXP := jdk.jshell.*
# JSHELLAPI_PKGS is located in NON_CORE_PKGS.gmk
JSHELLAPI_INDEX_HTML = $(JSHELLAPI_DOCDIR)/index.html
JSHELLAPI_OPTIONS_FILE = $(DOCSTMPDIR)/jshellapi.options
JSHELLAPI_PACKAGES_FILE = $(DOCSTMPDIR)/jshellapi.packages
# The modules required to be documented
JSHELLAPI_MODULES = jdk.jshell
jshellapidocs: $(JSHELLAPI_INDEX_HTML)
# Set relative location to core api document root
$(JSHELLAPI_INDEX_HTML): GET2DOCSDIR=$(JSHELLAPI2COREAPI)/..
# Run javadoc if the index file is out of date or missing
$(JSHELLAPI_INDEX_HTML): $(JSHELLAPI_OPTIONS_FILE) $(JSHELLAPI_PACKAGES_FILE) $(COREAPI_INDEX_FILE)
$(prep-javadoc)
$(call JavadocSummary,$(JSHELLAPI_OPTIONS_FILE),$(JSHELLAPI_PACKAGES_FILE))
$(JAVADOC_CMD_SMALL) -d $(@D) \
@$(JSHELLAPI_OPTIONS_FILE) @$(JSHELLAPI_PACKAGES_FILE)
# Create file with javadoc options in it
$(JSHELLAPI_OPTIONS_FILE):
$(prep-target)
@($(call COMMON_JAVADOCFLAGS) ; \
$(call COMMON_JAVADOCTAGS) ; \
$(call OptionOnly,-Xdoclint:all) ; \
$(call OptionPair,-system,none) ; \
$(call OptionPair,-modulesourcepath,$(RELEASEDOCS_MODULESOURCEPATH)) ; \
$(call OptionPair,-addmods,$(JSHELLAPI_MODULES)) ; \
$(call OptionPair,-encoding,ascii) ; \
$(call OptionPair,-doctitle,$(JSHELLAPI_DOCTITLE)) ; \
$(call OptionPair,-windowtitle,$(JSHELLAPI_WINDOWTITLE) $(DRAFT_WINTITLE)); \
$(call OptionPair,-header,$(JSHELLAPI_HEADER)$(DRAFT_HEADER)) ; \
$(call OptionPair,-bottom,$(JSHELLAPI_BOTTOM)$(DRAFT_BOTTOM)) ; \
$(call OptionTrip,-group,$(JSHELLAPI_GROUPNAME),$(JSHELLAPI_REGEXP)); \
$(call OptionTrip,-linkoffline,$(JSHELLAPI2COREAPI),$(COREAPI_DOCSDIR)/); \
) >> $@
# Create a file with the package names in it
$(JSHELLAPI_PACKAGES_FILE): $(call PackageDependencies,$(JSHELLAPI_PKGS))
$(prep-target)
$(call PackageFilter,$(JSHELLAPI_PKGS))
#############################################################
#
# treeapidocs

2
make/common/NON_CORE_PKGS.gmk
View File

@ -80,6 +80,8 @@ ATTACH_PKGS = com.sun.tools.attach \
JCONSOLE_PKGS = com.sun.tools.jconsole
JSHELLAPI_PKGS = jdk.jshell
TREEAPI_PKGS = com.sun.source.doctree \
com.sun.source.tree \
com.sun.source.util