8184225: Fix accessibility and tidy issues in jdk.jshell docs

Reviewed-by: jlahoda
This commit is contained in:
Jonathan Gibbons 2017-07-12 11:24:45 -07:00
parent 9efc4c1a60
commit cc10e3484e
2 changed files with 19 additions and 15 deletions
langtools/src/jdk.jshell/share/classes/jdk/jshell

@ -1,5 +1,5 @@
/*
* Copyright (c) 2015, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2015, 2017, 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
@ -72,7 +72,7 @@ public abstract class Snippet {
* or a static on-demand type import
* ({@link jdk.jshell.Snippet.SubKind#SINGLE_STATIC_IMPORT_SUBKIND}) --
* use {@link jdk.jshell.Snippet#subKind()} to distinguish.
* <P>
*
* @jls 8.3: importDeclaration.
* <P>
* An import declaration is {@linkplain Kind#isPersistent() persistent}.
@ -90,7 +90,7 @@ public abstract class Snippet {
* classes {@link jdk.jshell.Snippet.SubKind#CLASS_SUBKIND}, enums, and
* annotation interfaces -- see {@link jdk.jshell.Snippet.SubKind} to
* differentiate.
* <P>
*
* @jls 7.6: TypeDeclaration.
* <P>
* A type declaration is {@linkplain Kind#isPersistent() persistent}.
@ -100,7 +100,7 @@ public abstract class Snippet {
/**
* A method declaration.
* The snippet is an instance of {@link jdk.jshell.MethodSnippet}.
* <P>
*
* @jls 8.4: MethodDeclaration.
* <P>
* A method declaration is {@linkplain Kind#isPersistent() persistent}.
@ -115,7 +115,7 @@ public abstract class Snippet {
* The variable may be with or without initializer, or be a temporary
* variable representing an expression -- see
* {@link jdk.jshell.Snippet.SubKind}to differentiate.
* <P>
*
* @jls 8.3: FieldDeclaration.
* <P>
* A variable declaration is {@linkplain Kind#isPersistent() persistent}.
@ -132,7 +132,7 @@ public abstract class Snippet {
* names) -- see {@link jdk.jshell.Snippet.SubKind} to differentiate.
* All other expression forms (operators, method calls, ...) generate a
* scratch variable and so are instead of the VAR Kind.
* <P>
*
* @jls 15: Expression.
*/
EXPRESSION(false),
@ -140,7 +140,7 @@ public abstract class Snippet {
/**
* A statement.
* The snippet is an instance of {@link jdk.jshell.StatementSnippet}.
* <P>
*
* @jls 14.5: Statement.
*/
STATEMENT(false),

@ -90,33 +90,37 @@ public class JdiExecutionControlProvider implements ExecutionControlProvider {
* {@code ExecutionControlProvider}. The map can optionally be modified;
* Modified or unmodified it can be passed to
* {@link #generate(jdk.jshell.spi.ExecutionEnv, java.util.Map) }.
* <table>
* <table class="striped">
* <caption>Parameters</caption>
* <thead>
* <tr>
* <th>Parameter</th>
* <th>Description</th>
* <th>Constant Field</th>
* <th scope="col">Parameter</th>
* <th scope="col">Description</th>
* <th scope="col">Constant Field</th>
* </tr>
* </thead>
* <tbody>
* <tr>
* <td>remoteAgent</td>
* <th scope="row">remoteAgent</th>
* <td>the remote agent to launch</td>
* <td>{@link #PARAM_REMOTE_AGENT}</td>
* </tr>
* <tr>
* <td>timeout</td>
* <th scope="row">timeout</th>
* <td>milliseconds before connect timeout</td>
* <td>{@link #PARAM_TIMEOUT}</td>
* </tr>
* <tr>
* <td>launch</td>
* <th scope="row">launch</th>
* <td>"true" for JDI controlled launch</td>
* <td>{@link #PARAM_LAUNCH}</td>
* </tr>
* <tr>
* <td>hostname</td>
* <th scope="row">hostname</th>
* <td>connect to the named of the local host ("" for discovered)</td>
* <td>{@link #PARAM_HOST_NAME}</td>
* </tr>
* </tbody>
* </table>
*
* @return the default parameter map