RFR 8223595: Consider updating jdk.jshell module description

Robert Field robert.field at oracle.com
Mon May 13 23:25:15 UTC 2019


Version 01, after Alex's comment in the bug --

Bug: https://bugs.openjdk.java.net/browse/JDK-8223595


    src/jdk.jshell/share/classes/module-info.java

------------------------------------------------------------------------
*** 22,34 ****
    * or visit www.oracle.com if you need additional information or have any
    * questions.
    */
   
   /**
!  * This module provides support for
!  * Java Programming Language 'snippet' evaluating tools, such as
!  * Read-Eval-Print Loops (REPLs), including the <em>{@index jshell jshell tool}</em> tool.
    * Separate packages support building tools, configuring the execution of tools,
    * and programmatically launching the existing Java shell tool.
    * <p>
    *     The {@link jdk.jshell} is the package for creating 'snippet' evaluating tools.
    *     Generally, this is only package that would be needed for creating tools.
--- 22,35 ----
    * or visit www.oracle.com if you need additional information or have any
    * questions.
    */
   
   /**
!  * Defines the JShell API and provides the <em>{@index jshell jshell tool}</em> tool
!  * for evaluating snippets of Java code.
!  * The JShell API supports Java Programming Language 'snippet' evaluating tools,
!  * such as Read-Eval-Print Loops (REPLs).
    * Separate packages support building tools, configuring the execution of tools,
    * and programmatically launching the existing Java shell tool.
    * <p>
    *     The {@link jdk.jshell} is the package for creating 'snippet' evaluating tools.
    *     Generally, this is only package that would be needed for creating tools.


Old module description:

    jdk.jshell
    <https://docs.oracle.com/en/java/javase/12/docs/api/jdk.jshell/module-summary.html>
    	
    This module provides support for Java Programming Language 'snippet'
    evaluating tools, such as Read-Eval-Print Loops (REPLs), including
    the jshell tool.


New module description:

    jdk.jshell 	
    Provides the jshell tool for evaluating snippets of Java code, and
    defines a JDK-specific API for modeling and executing snippets.


Module doc:

    Provides the jshell tool for evaluating snippets of Java code, and
    defines a JDK-specific API for modeling and executing snippets. The
    JShell API supports Java Programming Language 'snippet' evaluating
    tools, such as Read-Eval-Print Loops (REPLs). Separate packages
    support building tools, configuring the execution of tools, and
    programmatically launching the existing Java shell tool.

    The jdk.jshell is the package for creating 'snippet' evaluating
    tools. Generally, this is only package that would be needed for
    creating tools.

    The jdk.jshell.spi package specifies a Service Provider Interface
    (SPI) for defining execution engine implementations for tools based
    on the jdk.jshell API. The jdk.jshell.execution package provides
    standard implementations of jdk.jshell.spi interfaces and supporting
    code. It also serves as a library of functionality for defining new
    execution engine implementations.

    The jdk.jshell.tool package supports programmatically launching
    the jshell tool.

    The jdk.jshell.execution package contains implementations of the
    interfaces in jdk.jshell.spi. Otherwise, the four packages are
    independent, operate at different levels, and do not share
    functionality or definitions.

    Tool Guides:
        jshell
        <https://docs.oracle.com/pls/topic/lookup?ctx=javase13&id=jshell_tool_reference>

    Since:
        9

-Robert



More information about the kulla-dev mailing list