8303480: Miscellaneous fixes to mostly invisible doc comments

Reviewed-by: mullan, prr, cjplummer, aivanov, jjg, lancea, rriggs, ihse
This commit is contained in:
Pavel Rappo 2023-03-07 15:31:42 +00:00
parent 43288bbd68
commit 45a616a891
39 changed files with 75 additions and 75 deletions

View File

@ -54,7 +54,7 @@ public final class JdkIdeaAntLogger extends DefaultLogger {
/** /**
* This is just a way to pass in customized binary string predicates; * This is just a way to pass in customized binary string predicates;
* *
* TODO: replace with @code{BiPredicate<String, String>} and method reference when moving to 8 * TODO: replace with {@code BiPredicate<String, String>} and method reference when moving to 8
*/ */
enum StringBinaryPredicate { enum StringBinaryPredicate {
CONTAINS() { CONTAINS() {

View File

@ -54,7 +54,7 @@ public final class LangtoolsIdeaAntLogger extends DefaultLogger {
/** /**
* This is just a way to pass in customized binary string predicates; * This is just a way to pass in customized binary string predicates;
* *
* TODO: replace with @code{BiPredicate<String, String>} and method reference when moving to 8 * TODO: replace with {@code BiPredicate<String, String>} and method reference when moving to 8
*/ */
enum StringBinaryPredicate { enum StringBinaryPredicate {
CONTAINS() { CONTAINS() {

View File

@ -255,7 +255,7 @@ final class BootstrapMethodInvoker {
/** /**
* @return true iff the BSM method type exactly matches * @return true iff the BSM method type exactly matches
* {@see java.lang.invoke.StringConcatFactory#makeConcatWithConstants(MethodHandles.Lookup, * {@link java.lang.invoke.StringConcatFactory#makeConcatWithConstants(MethodHandles.Lookup,
* String,MethodType,String,Object...))} * String,MethodType,String,Object...))}
*/ */
private static boolean isStringConcatFactoryBSM(MethodType bsmType) { private static boolean isStringConcatFactoryBSM(MethodType bsmType) {
@ -264,7 +264,7 @@ final class BootstrapMethodInvoker {
/** /**
* @return true iff the BSM method type exactly matches * @return true iff the BSM method type exactly matches
* {@see java.lang.invoke.LambdaMetafactory#metafactory( * {@link java.lang.invoke.LambdaMetafactory#metafactory(
* MethodHandles.Lookup,String,Class,MethodType,MethodHandle,MethodType)} * MethodHandles.Lookup,String,Class,MethodType,MethodHandle,MethodType)}
*/ */
private static boolean isLambdaMetafactoryCondyBSM(MethodType bsmType) { private static boolean isLambdaMetafactoryCondyBSM(MethodType bsmType) {
@ -273,7 +273,7 @@ final class BootstrapMethodInvoker {
/** /**
* @return true iff the BSM method type exactly matches * @return true iff the BSM method type exactly matches
* {@see java.lang.invoke.LambdaMetafactory#metafactory( * {@link java.lang.invoke.LambdaMetafactory#metafactory(
* MethodHandles.Lookup,String,MethodType,MethodType,MethodHandle,MethodType)} * MethodHandles.Lookup,String,MethodType,MethodType,MethodHandle,MethodType)}
*/ */
private static boolean isLambdaMetafactoryIndyBSM(MethodType bsmType) { private static boolean isLambdaMetafactoryIndyBSM(MethodType bsmType) {
@ -282,7 +282,7 @@ final class BootstrapMethodInvoker {
/** /**
* @return true iff the BSM method type exactly matches * @return true iff the BSM method type exactly matches
* {@see java.lang.invoke.LambdaMetafactory#altMetafactory( * {@link java.lang.invoke.LambdaMetafactory#altMetafactory(
* MethodHandles.Lookup,String,MethodType,Object[])} * MethodHandles.Lookup,String,MethodType,Object[])}
*/ */
private static boolean isLambdaMetafactoryAltMetafactoryBSM(MethodType bsmType) { private static boolean isLambdaMetafactoryAltMetafactoryBSM(MethodType bsmType) {

View File

@ -186,7 +186,7 @@ public final class AccessControlContext {
} }
/** /**
* package private to allow calls from (@code ProtectionDomain} without * package private to allow calls from {@code ProtectionDomain} without
* performing the security check for * performing the security check for
* {@linkplain SecurityConstants#CREATE_ACC_PERMISSION} permission * {@linkplain SecurityConstants#CREATE_ACC_PERMISSION} permission
*/ */

View File

@ -260,7 +260,7 @@ public abstract class BasicPermission extends Permission
/** /**
* {@code readObject} is called to restore the state of the * {@code readObject} is called to restore the state of the
* (@code BasicPermission} from a stream. * {@code BasicPermission} from a stream.
* *
* @param s the {@code ObjectInputStream} from which data is read * @param s the {@code ObjectInputStream} from which data is read
* @throws IOException if an I/O error occurs * @throws IOException if an I/O error occurs
@ -323,8 +323,8 @@ final class BasicPermissionCollection
private transient ConcurrentHashMap<String, Permission> perms; private transient ConcurrentHashMap<String, Permission> perms;
/** /**
* This is set to {@code true} if this (@code BasicPermissionCollection} * This is set to {@code true} if this {@code BasicPermissionCollection}
* contains a {code BasicPermission} with '*' as its permission name. * contains a {@code BasicPermission} with '*' as its permission name.
* *
* @see #serialPersistentFields * @see #serialPersistentFields
*/ */

View File

@ -162,7 +162,7 @@ public class CallingSequence {
/** /**
* The size of the return buffer, if one is needed. * The size of the return buffer, if one is needed.
* *
* {@see #needsReturnBuffer} * @see #needsReturnBuffer
* *
* @return the return buffer size * @return the return buffer size
*/ */

View File

@ -66,7 +66,7 @@ public class VMSupport {
} }
/** /**
* @returns a Properties object containing only the entries in {@code p} * @return a Properties object containing only the entries in {@code p}
* whose key and value are both Strings * whose key and value are both Strings
*/ */
private static Properties onlyStrings(Properties p) { private static Properties onlyStrings(Properties p) {

View File

@ -169,7 +169,7 @@ public class LocaleNameProviderImpl extends LocaleNameProvider implements Availa
} }
/** /**
* @inheritDoc * {@inheritDoc}
*/ */
@Override @Override
public String getDisplayUnicodeExtensionKey(String key, Locale locale) { public String getDisplayUnicodeExtensionKey(String key, Locale locale) {
@ -180,7 +180,7 @@ public class LocaleNameProviderImpl extends LocaleNameProvider implements Availa
} }
/** /**
* @inheritDoc * {@inheritDoc}
*/ */
@Override @Override
public String getDisplayUnicodeExtensionType(String extType, String key, Locale locale) { public String getDisplayUnicodeExtensionType(String extType, String key, Locale locale) {

View File

@ -645,7 +645,7 @@ public class SynthComboBoxUI extends BasicComboBoxUI implements
//------------------------------------------------------------------ //------------------------------------------------------------------
/** /**
* @inheritDoc * {@inheritDoc}
* *
* Ensures that isPressed() will return true if the combo is pressed, * Ensures that isPressed() will return true if the combo is pressed,
* or the arrowButton is pressed, <em>or</em> if the combo popup is * or the arrowButton is pressed, <em>or</em> if the combo popup is
@ -659,7 +659,7 @@ public class SynthComboBoxUI extends BasicComboBoxUI implements
} }
/** /**
* @inheritDoc * {@inheritDoc}
* *
* Ensures that the armed state is in sync with the pressed state * Ensures that the armed state is in sync with the pressed state
* if shouldActLikeButton is true. Without this method, the arrow * if shouldActLikeButton is true. Without this method, the arrow
@ -674,7 +674,7 @@ public class SynthComboBoxUI extends BasicComboBoxUI implements
} }
/** /**
* @inheritDoc * {@inheritDoc}
* *
* Ensures that isRollover() will return true if the combo is * Ensures that isRollover() will return true if the combo is
* rolled over, or the arrowButton is rolled over. * rolled over, or the arrowButton is rolled over.
@ -685,7 +685,7 @@ public class SynthComboBoxUI extends BasicComboBoxUI implements
} }
/** /**
* @inheritDoc * {@inheritDoc}
* *
* Forwards pressed states to the internal "pressed" field * Forwards pressed states to the internal "pressed" field
*/ */
@ -696,7 +696,7 @@ public class SynthComboBoxUI extends BasicComboBoxUI implements
} }
/** /**
* @inheritDoc * {@inheritDoc}
* *
* Forwards rollover states to the internal "over" field * Forwards rollover states to the internal "over" field
*/ */
@ -738,7 +738,7 @@ public class SynthComboBoxUI extends BasicComboBoxUI implements
//------------------------------------------------------------------ //------------------------------------------------------------------
/** /**
* @inheritDoc * {@inheritDoc}
* *
* Ensures that the combo box is repainted when the popup is closed. * Ensures that the combo box is repainted when the popup is closed.
* This avoids a bug where clicking off the combo wasn't causing a repaint, * This avoids a bug where clicking off the combo wasn't causing a repaint,

View File

@ -67,7 +67,7 @@ class SynthComboPopup extends BasicComboPopup {
} }
/** /**
* @inheritDoc * {@inheritDoc}
* *
* Overridden to take into account any popup insets specified in * Overridden to take into account any popup insets specified in
* SynthComboBoxUI * SynthComboBoxUI

View File

@ -346,7 +346,7 @@ public final class GlyphLayout {
* @param text the text, including optional context before start and after start + count * @param text the text, including optional context before start and after start + count
* @param offset the start of the text to lay out * @param offset the start of the text to lay out
* @param count the length of the text to lay out * @param count the length of the text to lay out
* @param flags bidi and context flags {@see #java.awt.Font} * @param flags bidi and context flags {@link java.awt.Font}
* @param result a StandardGlyphVector to modify, can be null * @param result a StandardGlyphVector to modify, can be null
* @return the laid out glyphvector, if result was passed in, it is returned * @return the laid out glyphvector, if result was passed in, it is returned
*/ */

View File

@ -93,7 +93,7 @@ public final class StateTrackableDelegate implements StateTrackable {
} }
/** /**
* @inheritDoc * {@inheritDoc}
* @since 1.7 * @since 1.7
*/ */
public State getState() { public State getState() {
@ -101,7 +101,7 @@ public final class StateTrackableDelegate implements StateTrackable {
} }
/** /**
* @inheritDoc * {@inheritDoc}
* @since 1.7 * @since 1.7
*/ */
public synchronized StateTracker getStateTracker() { public synchronized StateTracker getStateTracker() {

View File

@ -116,7 +116,7 @@ public abstract class AccumulativeRunnable<T> implements Runnable {
* appends arguments and sends this {@code Runnable} for the * appends arguments and sends this {@code Runnable} for the
* execution if needed. * execution if needed.
* <p> * <p>
* This implementation uses {@see #submit} to send this * This implementation uses {@link #submit} to send this
* {@code Runnable} for execution. * {@code Runnable} for execution.
* @param args the arguments to accumulate * @param args the arguments to accumulate
*/ */

View File

@ -2278,11 +2278,11 @@ public class SwingUtilities2 {
/** /**
* Returns the client property for the given key if it is set; otherwise * Returns the client property for the given key if it is set; otherwise
* returns the {@L&F} property. * returns the {@literal L&F} property.
* *
* @param component the component * @param component the component
* @param key an {@code String} specifying the key for the desired boolean value * @param key an {@code String} specifying the key for the desired boolean value
* @return the boolean value of the client property if it is set or the {@L&F} * @return the boolean value of the client property if it is set or the {@literal L&F}
* property in other case. * property in other case.
*/ */
public static boolean getBoolean(JComponent component, String key) { public static boolean getBoolean(JComponent component, String key) {

View File

@ -2385,7 +2385,7 @@ public final class XToolkit extends UNIXToolkit implements Runnable {
private static int oops_position = 0; private static int oops_position = 0;
/** /**
* @inheritDoc * {@inheritDoc}
*/ */
@Override @Override
protected boolean syncNativeQueue(long timeout) { protected boolean syncNativeQueue(long timeout) {

View File

@ -594,7 +594,7 @@ public abstract class Type extends AnnoConstruct implements TypeMirror, PoolCons
/** /**
* A compound type is a special class type whose supertypes are used to store a list * A compound type is a special class type whose supertypes are used to store a list
* of component types. There are two kinds of compound types: (i) intersection types * of component types. There are two kinds of compound types: (i) intersection types
* {@see IntersectionClassType} and (ii) union types {@see UnionClassType}. * {@link IntersectionClassType} and (ii) union types {@link UnionClassType}.
*/ */
public boolean isCompound() { public boolean isCompound() {
return false; return false;

View File

@ -2862,7 +2862,7 @@ public class Types {
/** /**
* Merge multiple abstract methods. The preferred method is a method that is a subsignature * Merge multiple abstract methods. The preferred method is a method that is a subsignature
* of all the other signatures and whose return type is more specific {@see MostSpecificReturnCheck}. * of all the other signatures and whose return type is more specific {@link MostSpecificReturnCheck}.
* The resulting preferred method has a thrown clause that is the intersection of the merged * The resulting preferred method has a thrown clause that is the intersection of the merged
* methods' clauses. * methods' clauses.
*/ */

View File

@ -2445,7 +2445,7 @@ public class Check {
* *
* @param pos Position to be used for error reporting. * @param pos Position to be used for error reporting.
* @param t The type referred to. * @param t The type referred to.
* @returns True if the check completed on all attributed classes * @return True if the check completed on all attributed classes
*/ */
private boolean checkNonCyclicInternal(DiagnosticPosition pos, Type t) { private boolean checkNonCyclicInternal(DiagnosticPosition pos, Type t) {
boolean complete = true; // was the check complete? boolean complete = true; // was the check complete?

View File

@ -656,7 +656,7 @@ public class Infer {
/** /**
* Infer record type for pattern matching. Given an expression type * Infer record type for pattern matching. Given an expression type
* (@code expressionType}), and a given record ({@code patternTypeSymbol}), * ({@code expressionType}), and a given record ({@code patternTypeSymbol}),
* a parameterized type of {@code patternTypeSymbol} is inferred * a parameterized type of {@code patternTypeSymbol} is inferred
* according to JLS 18.5.5. * according to JLS 18.5.5.
* *

View File

@ -3305,7 +3305,7 @@ public class Resolve {
/** /**
* This abstract class embodies the logic that converts one (bound lookup) or two (unbound lookup) * This abstract class embodies the logic that converts one (bound lookup) or two (unbound lookup)
* {@code ReferenceLookupResult} objects into a (@code Symbol), which is then regarded as the * {@code ReferenceLookupResult} objects into a {@code Symbol}, which is then regarded as the
* result of method reference resolution. * result of method reference resolution.
*/ */
abstract class ReferenceChooser { abstract class ReferenceChooser {

View File

@ -46,7 +46,7 @@ public interface DebugDirectoryEntry {
/** Format of debugging information: this field enables support of /** Format of debugging information: this field enables support of
multiple debuggers. See multiple debuggers. See
@link{sun.jvm.hotspot.debugger.win32.coff.DebugTypes}. */ {@link sun.jvm.hotspot.debugger.win32.coff.DebugTypes}. */
public int getType(); public int getType();
/** Size of the debug data (not including the debug directory itself). */ /** Size of the debug data (not including the debug directory itself). */
@ -60,7 +60,7 @@ public interface DebugDirectoryEntry {
/** If this debug directory entry is of type /** If this debug directory entry is of type
IMAGE_DEBUG_TYPE_CODEVIEW (see IMAGE_DEBUG_TYPE_CODEVIEW (see
@link{sun.jvm.hotspot.debugger.win32.coff.DebugTypes}), returns {@link sun.jvm.hotspot.debugger.win32.coff.DebugTypes}), returns
the contents as a DebugVC50 object; otherwise, returns null. */ the contents as a DebugVC50 object; otherwise, returns null. */
public DebugVC50 getDebugVC50(); public DebugVC50 getDebugVC50();

View File

@ -30,9 +30,9 @@ import sun.jvm.hotspot.oops.*;
/** Describes a path from an object back to the root which is keeping /** Describes a path from an object back to the root which is keeping
it alive. Elements of the path are (object, field) pairs, where it alive. Elements of the path are (object, field) pairs, where
the object is expressed as a @link{sun.jvm.hotspot.oops.Oop}, and the object is expressed as a {@link sun.jvm.hotspot.oops.Oop}, and
where the field is expressed as a where the field is expressed as a
@link{sun.jvm.hotspot.oops.FieldIdentifier}. If the element {@link sun.jvm.hotspot.oops.FieldIdentifier}. If the element
reflects a root, the Oop will be null. If the element is the end reflects a root, the Oop will be null. If the element is the end
of the path, the FieldIdentifier will be null. */ of the path, the FieldIdentifier will be null. */

View File

@ -98,9 +98,9 @@ abstract class Cleaner extends WeakReference<Object> {
/** /**
* Performs the cleanup action now that this object's referent has become weakly reachable. * Performs the cleanup action now that this object's referent has become weakly reachable.
* *
* @returns true if the clean up action cleared the referent of an oop handle and requires a * @return true if the clean up action cleared the referent of an oop handle and requires a
* subsequent call to {@link CompilerToVM#releaseClearedOopHandles()} to reclaim the * subsequent call to {@link CompilerToVM#releaseClearedOopHandles()} to reclaim the
* resources of the handle itself * resources of the handle itself
*/ */
abstract boolean doCleanup(); abstract boolean doCleanup();

View File

@ -629,7 +629,7 @@ final class HotSpotCompiledCodeStream implements AutoCloseable {
* Determines if {@code name} or {@code method} are matched by * Determines if {@code name} or {@code method} are matched by
* {@link Option#DumpSerializedCode}. * {@link Option#DumpSerializedCode}.
* *
* @returns the matched value or null if no match was made * @return the matched value or null if no match was made
*/ */
private static String shouldDump(String name, HotSpotCompiledNmethod nmethod) { private static String shouldDump(String name, HotSpotCompiledNmethod nmethod) {
String filter = Option.DumpSerializedCode.getString(); String filter = Option.DumpSerializedCode.getString();

View File

@ -31,7 +31,7 @@ import jdk.vm.ci.meta.ResolvedJavaMethod;
/** /**
* Helper methods for interacting with the Java Flight Recorder (JFR) to register events and notify * Helper methods for interacting with the Java Flight Recorder (JFR) to register events and notify
* it when events occur. The JFR events are defined in {see @code * it when events occur. The JFR events are defined in {@code
* src/share/jfr/metadata/metadata.xml}. * src/share/jfr/metadata/metadata.xml}.
*/ */
public final class JFR { public final class JFR {
@ -50,7 +50,7 @@ public final class JFR {
} }
/** /**
* Helper methods for managing JFR CompilerPhase events. The events are defined in {see @code * Helper methods for managing JFR CompilerPhase events. The events are defined in {@code
* src/share/jfr/metadata/metadata.xml}. * src/share/jfr/metadata/metadata.xml}.
*/ */
public static final class CompilerPhaseEvent { public static final class CompilerPhaseEvent {
@ -75,7 +75,7 @@ public final class JFR {
} }
/** /**
* Helper methods for managing JFR CompilerInlining events. The events are defined in {see @code * Helper methods for managing JFR CompilerInlining events. The events are defined in {@code
* src/share/jfr/metadata/metadata.xml}. * src/share/jfr/metadata/metadata.xml}.
*/ */
public static final class CompilerInliningEvent { public static final class CompilerInliningEvent {

View File

@ -66,8 +66,8 @@ public interface MethodHandleAccessProvider {
* interpreter overhead. If the parameter forceBytecodeGeneration is set to true, the VM should * interpreter overhead. If the parameter forceBytecodeGeneration is set to true, the VM should
* try to generate bytecodes before this method returns. * try to generate bytecodes before this method returns.
* *
* @returns {@code null} if {@code methodHandle} is not a {@link MethodHandle} or the invocation * @return {@code null} if {@code methodHandle} is not a {@link MethodHandle} or the invocation
* target is not available at this time * target is not available at this time
* @throws NullPointerException if {@code methodHandle} is null * @throws NullPointerException if {@code methodHandle} is null
*/ */
ResolvedJavaMethod resolveInvokeBasicTarget(JavaConstant methodHandle, boolean forceBytecodeGeneration); ResolvedJavaMethod resolveInvokeBasicTarget(JavaConstant methodHandle, boolean forceBytecodeGeneration);
@ -77,7 +77,7 @@ public interface MethodHandleAccessProvider {
* with the given constant member name. The member name is the last parameter of the * with the given constant member name. The member name is the last parameter of the
* {@code linkTo*} method. * {@code linkTo*} method.
* *
* @returns {@code null} if the invocation target is not available at this time * @return {@code null} if the invocation target is not available at this time
* @throws NullPointerException if {@code memberName} is null * @throws NullPointerException if {@code memberName} is null
* @throws IllegalArgumentException if {@code memberName} is not a * @throws IllegalArgumentException if {@code memberName} is not a
* {@code java.lang.invoke.MemberName} * {@code java.lang.invoke.MemberName}

View File

@ -94,7 +94,7 @@ public class Head extends Content {
} }
/** /**
* Sets the charset to be declared in a META [@code Content-TYPE} element. * Sets the charset to be declared in a META {@code Content-TYPE} element.
* *
* @param charset the charset * @param charset the charset
* @return this object * @return this object
@ -123,7 +123,7 @@ public class Head extends Content {
} }
/** /**
* Adds a list of keywords to appear in META [@code keywords} elements. * Adds a list of keywords to appear in META {@code keywords} elements.
* *
* @param keywords the list of keywords, or null if none need to be added * @param keywords the list of keywords, or null if none need to be added
* @return this object * @return this object

View File

@ -513,12 +513,12 @@ public class LogParser extends DefaultHandler implements ErrorHandler {
private HashMap<String, Method> methods = new HashMap<>(); private HashMap<String, Method> methods = new HashMap<>();
/** /**
* Map compilation IDs ({@see #makeId()}) to newly created nmethods. * Map compilation IDs ({@link #makeId()}) to newly created nmethods.
*/ */
private LinkedHashMap<String, NMethod> nmethods = new LinkedHashMap<>(); private LinkedHashMap<String, NMethod> nmethods = new LinkedHashMap<>();
/** /**
* Map compilation task IDs {@see #makeId()}) to {@link Compilation} * Map compilation task IDs {@link #makeId()}) to {@link Compilation}
* objects. * objects.
*/ */
private HashMap<String, Compilation> compiles = new HashMap<>(); private HashMap<String, Compilation> compiles = new HashMap<>();
@ -544,9 +544,9 @@ public class LogParser extends DefaultHandler implements ErrorHandler {
* originating from that scope. * originating from that scope.
* *
* New scopes are typically pushed when parse log events are encountered * New scopes are typically pushed when parse log events are encountered
* ({@see #startElement()}) and popped when parsing of a given Java method * ({@link #startElement()}) and popped when parsing of a given Java method
* is done ({@see #endElement()}). Parsing events can be nested. Several * is done ({@link #endElement()}). Parsing events can be nested. Several
* other events add information to scopes ({@see #startElement()}). * other events add information to scopes ({@code startElement()}).
*/ */
private Deque<CallSite> scopes = new ArrayDeque<>(); private Deque<CallSite> scopes = new ArrayDeque<>();

View File

@ -190,7 +190,7 @@ public class TestFramework {
/** /**
* Creates an instance acting as a builder to test {@code testClass}. * Creates an instance acting as a builder to test {@code testClass}.
* Use this constructor if you want to use multiple run options (flags, helper classes, scenarios). * Use this constructor if you want to use multiple run options (flags, helper classes, scenarios).
* Use the associated add methods ({@link #addFlags(String...)}, @link #addScenarios(Scenario...)}, * Use the associated add methods ({@link #addFlags(String...)}, {@link #addScenarios(Scenario...)},
* {@link #addHelperClasses(Class...)}) to set up everything and then start the testing by invoking {@link #start()}. * {@link #addHelperClasses(Class...)}) to set up everything and then start the testing by invoking {@link #start()}.
* *
* @param testClass the class to be tested by the framework. * @param testClass the class to be tested by the framework.

View File

@ -42,7 +42,7 @@ public class PlabGCStatistics {
/** /**
* Checks if the statistics contains the requested type. * Checks if the statistics contains the requested type.
* @param reportType * @param reportType
* @returns true, if contains, false otherwise * @return true, if contains, false otherwise
*/ */
public boolean containsKey(ReportType reportType) { public boolean containsKey(ReportType reportType) {
return plabGCStatistics.containsKey(reportType); return plabGCStatistics.containsKey(reportType);

View File

@ -67,7 +67,7 @@ public interface MultiRunner extends Runnable {
/** /**
* Get execution controller for current thread. * Get execution controller for current thread.
* *
* @returns execution controller for current thread * @return execution controller for current thread
*/ */
public ExecutionController getExecutionController(); public ExecutionController getExecutionController();
} }

View File

@ -401,7 +401,7 @@ public class TestLibrary {
/** /**
* Creates an RMI {@link Registry} on a random, un-reserved port. * Creates an RMI {@link Registry} on a random, un-reserved port.
* *
* @returns an RMI Registry, using a random port. * @return an RMI Registry, using a random port.
* @throws RemoteException if there was a problem creating a Registry. * @throws RemoteException if there was a problem creating a Registry.
*/ */
public static Registry createRegistryOnUnusedPort() throws RemoteException { public static Registry createRegistryOnUnusedPort() throws RemoteException {
@ -411,7 +411,7 @@ public class TestLibrary {
/** /**
* Creates an RMI {@link Registry} on an ephemeral port. * Creates an RMI {@link Registry} on an ephemeral port.
* *
* @returns an RMI Registry * @return an RMI Registry
* @throws RemoteException if there was a problem creating a Registry. * @throws RemoteException if there was a problem creating a Registry.
*/ */
public static Registry createRegistryOnEphemeralPort() throws RemoteException { public static Registry createRegistryOnEphemeralPort() throws RemoteException {

View File

@ -209,7 +209,7 @@ public class TestExampleCode {
* same chronology. * same chronology.
* @param <D> a parameterized ChronoLocalDate * @param <D> a parameterized ChronoLocalDate
* @param date a specific date extending ChronoLocalDate * @param date a specific date extending ChronoLocalDate
* @return a [@code ChronoLocalDateTime<D>} using the change chronology. * @return a {@code ChronoLocalDateTime<D>} using the change chronology.
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
private <D extends ChronoLocalDate> ChronoLocalDateTime<D> tomorrowNoon(D date) { private <D extends ChronoLocalDate> ChronoLocalDateTime<D> tomorrowNoon(D date) {

View File

@ -231,7 +231,7 @@ public class SigSchemePropOrdering extends SSLEngineTemplate {
* *
* @param data the ByteBuffer containing the ClientHello bytes * @param data the ByteBuffer containing the ClientHello bytes
* *
* @returns A List of the signature schemes in string form. If no * @return A List of the signature schemes in string form. If no
* signature_algorithms extension is present in the client hello then * signature_algorithms extension is present in the client hello then
* an empty list will be returned. * an empty list will be returned.
*/ */
@ -302,7 +302,7 @@ public class SigSchemePropOrdering extends SSLEngineTemplate {
* *
* @param data the ByteBuffer containing the CertificateRequest bytes * @param data the ByteBuffer containing the CertificateRequest bytes
* *
* @returns A List of the signature schemes in string form. If no * @return A List of the signature schemes in string form. If no
* signature_algorithms extension is present in the CertificateRequest * signature_algorithms extension is present in the CertificateRequest
* then an empty list will be returned. * then an empty list will be returned.
*/ */

View File

@ -311,9 +311,9 @@ public class KeyToolTest {
/** /**
* Helper method, load a keystore * Helper method, load a keystore
* @param file file for keystore, null or "NONE" for PKCS11 * @param file file for keystore, null or "NONE" for PKCS11
* @pass password for the keystore * @param pass password for the keystore
* @type keystore type * @param type keystore type
* @returns the KeyStore object * @return the KeyStore object
* @exception Exception if anything goes wrong * @exception Exception if anything goes wrong
*/ */
KeyStore loadStore(String file, String pass, String type) throws Exception { KeyStore loadStore(String file, String pass, String type) throws Exception {

View File

@ -44,7 +44,7 @@ public class SerializableProxy implements Serializable {
/** /**
* Returns a deserialized object. * Returns a deserialized object.
* *
* @returns the deserialized object * @return the deserialized object
*/ */
public SerializableProxy readResolve() { public SerializableProxy readResolve() {
return new SerializableProxy(x, y); return new SerializableProxy(x, y);

View File

@ -110,7 +110,7 @@ public class ByteCodeLoader extends SecureClassLoader {
* @param className The name of the class * @param className The name of the class
* @param byteCode The byte code for the class * @param byteCode The byte code for the class
* @throws ClassNotFoundException if the class can't be loaded * @throws ClassNotFoundException if the class can't be loaded
* @return A {@see Class} object representing the class * @return A {@code Class} object representing the class
*/ */
public static Class<?> load(String className, byte[] byteCode) throws ClassNotFoundException { public static Class<?> load(String className, byte[] byteCode) throws ClassNotFoundException {
return new ByteCodeLoader(className, byteCode).loadClass(className); return new ByteCodeLoader(className, byteCode).loadClass(className);

View File

@ -81,7 +81,7 @@ public class UIBuilder {
/** /**
* Returns this {@code DialogBuilder} setting the dialog's title to a new value. * Returns this {@code DialogBuilder} setting the dialog's title to a new value.
* @param title a string value * @param title a string value
* @returns this DialogBuilder * @return this DialogBuilder
*/ */
public DialogBuilder setTitle(String title) { public DialogBuilder setTitle(String title) {
dialog.setTitle(title); dialog.setTitle(title);
@ -92,7 +92,7 @@ public class UIBuilder {
* Returns this {@code DialogBuilder} setting the instruction text to a new * Returns this {@code DialogBuilder} setting the instruction text to a new
* value. * value.
* @param instruction a string value * @param instruction a string value
* @returns this DialogBuilder * @return this DialogBuilder
*/ */
public DialogBuilder setInstruction(String instruction) { public DialogBuilder setInstruction(String instruction) {
instructionsText.setText("Test instructions:\n" + instruction); instructionsText.setText("Test instructions:\n" + instruction);
@ -102,7 +102,7 @@ public class UIBuilder {
/** /**
* Returns this {@code DialogBuilder} setting the message text to a new value. * Returns this {@code DialogBuilder} setting the message text to a new value.
* @param message a string value * @param message a string value
* @returns this DialogBuilder * @return this DialogBuilder
*/ */
public DialogBuilder setMessage(String message) { public DialogBuilder setMessage(String message) {
messageText.setText(message); messageText.setText(message);
@ -113,7 +113,7 @@ public class UIBuilder {
* Returns this {@code DialogBuilder} setting pass button action to * Returns this {@code DialogBuilder} setting pass button action to
* {@link java.awt.event.ActionListener}. * {@link java.awt.event.ActionListener}.
* @param action an action to perform on button click * @param action an action to perform on button click
* @returns this DialogBuilder * @return this DialogBuilder
*/ */
public DialogBuilder setPassAction(ActionListener action) { public DialogBuilder setPassAction(ActionListener action) {
pass.addActionListener(action); pass.addActionListener(action);
@ -124,7 +124,7 @@ public class UIBuilder {
* Returns this {@code DialogBuilder} setting fail button action to * Returns this {@code DialogBuilder} setting fail button action to
* {@link java.awt.event.ActionListener}. * {@link java.awt.event.ActionListener}.
* @param action an action to perform on button click * @param action an action to perform on button click
* @returns this DialogBuilder * @return this DialogBuilder
*/ */
public DialogBuilder setFailAction(ActionListener action) { public DialogBuilder setFailAction(ActionListener action) {
fail.addActionListener(action); fail.addActionListener(action);
@ -135,7 +135,7 @@ public class UIBuilder {
* Returns this {@code DialogBuilder} setting window-closing action to * Returns this {@code DialogBuilder} setting window-closing action to
* {@link java.lang.Runnable}. * {@link java.lang.Runnable}.
* @param action a runnerable action to perform on window close * @param action a runnerable action to perform on window close
* @returns this DialogBuilder * @return this DialogBuilder
*/ */
public DialogBuilder setCloseAction(Runnable action) { public DialogBuilder setCloseAction(Runnable action) {
dialog.addWindowListener(new WindowAdapter() { dialog.addWindowListener(new WindowAdapter() {
@ -150,7 +150,7 @@ public class UIBuilder {
/** /**
* Returns a {@link javax.swing.JDialog} window. * Returns a {@link javax.swing.JDialog} window.
* @returns a JDialog * @return a JDialog
*/ */
public JDialog build() { public JDialog build() {
dialog.pack(); dialog.pack();

View File

@ -83,7 +83,7 @@ public class TsaSigner {
/** /**
* Sign data. * Sign data.
* *
* @returns the time-stamping response data * @return the time-stamping response data
*/ */
public byte[] sign() throws Exception { public byte[] sign() throws Exception {
TsaParam requestParam = parseRequestParam(); TsaParam requestParam = parseRequestParam();