changeset 39590:5a2a47b882ec

8160035: JShell API: Add javadoc overview and package files Reviewed-by: jlahoda
author rfield
date Wed, 06 Jul 2016 20:53:55 -0700
parents 0cbaed77814c
children 1442e6092461
files langtools/src/jdk.jshell/share/classes/jdk/jshell/execution/package-info.java langtools/src/jdk.jshell/share/classes/jdk/jshell/overview.html langtools/src/jdk.jshell/share/classes/jdk/jshell/package-info.java langtools/src/jdk.jshell/share/classes/jdk/jshell/spi/package-info.java langtools/src/jdk.jshell/share/classes/module-info.java
diffstat 5 files changed, 86 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jshell/share/classes/jdk/jshell/execution/package-info.java	Wed Jul 06 20:53:55 2016 -0700
@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/**
+ * Provides implementation support for building JShell execution engines.
+ * Includes concrete and abstract implementations of the
+ * {@link jdk.jshell.spi.ExecutionControl} interface.
+ * Also, provides related communication utilities.
+ * This package may be used to define alternative execution engines.
+ * The default JShell execution engine is included.
+ */
+package jdk.jshell.execution;
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/jdk.jshell/share/classes/jdk/jshell/overview.html	Wed Jul 06 20:53:55 2016 -0700
@@ -0,0 +1,38 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<html>
+<head>
+<!--
+
+Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+
+This code is free software; you can redistribute it and/or modify it
+under the terms of the GNU General Public License version 2 only, as
+published by the Free Software Foundation.  Oracle designates this
+particular file as subject to the "Classpath" exception as provided
+by Oracle in the LICENSE file that accompanied this code.
+
+This code is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+version 2 for more details (a copy is included in the LICENSE file that
+accompanied this code).
+
+You should have received a copy of the GNU General Public License version
+2 along with this work; if not, write to the Free Software Foundation,
+Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+or visit www.oracle.com if you need additional information or have any
+questions.
+-->
+
+</head>
+<body bgcolor="white">
+
+This document is the API specification for JShell -- support for
+Java&#x2122; Programming Language 'snippet' evaluating tools, such as
+Read-Eval-Print Loops (REPLs).
+
+</body>
+</html>
--- a/langtools/src/jdk.jshell/share/classes/jdk/jshell/package-info.java	Wed Jul 06 15:27:36 2016 -0700
+++ b/langtools/src/jdk.jshell/share/classes/jdk/jshell/package-info.java	Wed Jul 06 20:53:55 2016 -0700
@@ -38,7 +38,8 @@
  * {@link jdk.jshell.Snippet}. For example, a statement is represented by an
  * instance of {@link jdk.jshell.StatementSnippet}, and a method declaration is
  * represented by an instance of {@link jdk.jshell.MethodSnippet}.
- * Snippets are created when {@link jdk.jshell.JShell#eval(java.lang.String)}
+ * Snippets are created when
+ * {@link jdk.jshell.JShell#eval(java.lang.String) JShell.eval(String)}
  * is invoked with an input which includes one or more snippets of code.
  * <p>
  * Any change to the compilation status of a snippet is reported with a
@@ -84,7 +85,7 @@
  *                     if (input == null) {
  *                         break;
  *                     }
- *                     List&lt;SnippetEvent&gt; events = js.eval(input);
+ *                     List<SnippetEvent> events = js.eval(input);
  *                     for (SnippetEvent e : events) {
  *                         StringBuilder sb = new StringBuilder();
  *                         if (e.causeSnippet == null) {
--- a/langtools/src/jdk.jshell/share/classes/jdk/jshell/spi/package-info.java	Wed Jul 06 15:27:36 2016 -0700
+++ b/langtools/src/jdk.jshell/share/classes/jdk/jshell/spi/package-info.java	Wed Jul 06 20:53:55 2016 -0700
@@ -24,16 +24,16 @@
  */
 
 /**
- * Provides support for alternate implementations of the JShell execution
- * engine.  The JShell core tracks and compiles Snippets then sends them
+ * Defines the Service Provider Interface for pluggable JShell execution engines.
+ * The JShell core tracks and compiles Snippets then sends them
  * (represented in a wrapper class) to the execution engine for loading,
  * and in the case of executable Snippets, execution.  The JShell
  * implementation includes a default execution engine (currently a remote
  * process which is JDI controlled).  By implementing the
- * {@link ExecutionControl} interface and installing it with
+ * {@link jdk.jshell.spi.ExecutionControl} interface and installing it with
  * {@link jdk.jshell.JShell.Builder#executionEngine(jdk.jshell.spi.ExecutionControl) }
  * other execution engines can be used.
- * <p>
- * This is not a part of the JShell API.
+ *
+ * @see jdk.jshell.execution jdk.jshell.execution for execution implementation support
  */
 package jdk.jshell.spi;
--- a/langtools/src/jdk.jshell/share/classes/module-info.java	Wed Jul 06 15:27:36 2016 -0700
+++ b/langtools/src/jdk.jshell/share/classes/module-info.java	Wed Jul 06 20:53:55 2016 -0700
@@ -23,6 +23,11 @@
  * questions.
  */
 
+/**
+ * This document is the API specification for JShell -- support for
+ * Java&#x2122; Programming Language 'snippet' evaluating tools, such as
+ * Read-Eval-Print Loops (REPLs).
+ */
 module jdk.jshell {
     requires public java.compiler;
     requires java.desktop;
@@ -33,4 +38,5 @@
 
     exports jdk.jshell;
     exports jdk.jshell.spi;
+    exports jdk.jshell.execution;
 }