Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8303480: Miscellaneous fixes to mostly invisible doc comments #12826

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion make/ide/idea/jdk/template/src/idea/JdkIdeaAntLogger.java
Expand Up @@ -54,7 +54,7 @@ public final class JdkIdeaAntLogger extends DefaultLogger {
/**
* 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 {
CONTAINS() {
Expand Down
Expand Up @@ -54,7 +54,7 @@ public final class LangtoolsIdeaAntLogger extends DefaultLogger {
/**
* 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 {
CONTAINS() {
Expand Down
Expand Up @@ -255,7 +255,7 @@ private static Object invokeWithManyArguments(MethodHandle bootstrapMethod, Look

/**
* @return true iff the BSM method type exactly matches
pavelrappo marked this conversation as resolved.
Show resolved Hide resolved
* {@see java.lang.invoke.StringConcatFactory#makeConcatWithConstants(MethodHandles.Lookup,
* {@link java.lang.invoke.StringConcatFactory#makeConcatWithConstants(MethodHandles.Lookup,
* String,MethodType,String,Object...))}
*/
private static boolean isStringConcatFactoryBSM(MethodType bsmType) {
Expand All @@ -264,7 +264,7 @@ private static boolean isStringConcatFactoryBSM(MethodType bsmType) {

/**
* @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)}
*/
private static boolean isLambdaMetafactoryCondyBSM(MethodType bsmType) {
Expand All @@ -273,7 +273,7 @@ private static boolean isLambdaMetafactoryCondyBSM(MethodType bsmType) {

/**
* @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)}
*/
private static boolean isLambdaMetafactoryIndyBSM(MethodType bsmType) {
Expand All @@ -282,7 +282,7 @@ private static boolean isLambdaMetafactoryIndyBSM(MethodType bsmType) {

/**
* @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[])}
*/
private static boolean isLambdaMetafactoryAltMetafactoryBSM(MethodType bsmType) {
Expand Down
Expand Up @@ -186,7 +186,7 @@ public AccessControlContext(AccessControlContext acc,
}

/**
* package private to allow calls from (@code ProtectionDomain} without
* package private to allow calls from {@code ProtectionDomain} without
* performing the security check for
* {@linkplain SecurityConstants#CREATE_ACC_PERMISSION} permission
*/
Expand Down
Expand Up @@ -260,7 +260,7 @@ public PermissionCollection newPermissionCollection() {

/**
* {@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
* @throws IOException if an I/O error occurs
Expand Down Expand Up @@ -323,8 +323,8 @@ final class BasicPermissionCollection
private transient ConcurrentHashMap<String, Permission> perms;

/**
* This is set to {@code true} if this (@code BasicPermissionCollection}
* contains a {code BasicPermission} with '*' as its permission name.
* This is set to {@code true} if this {@code BasicPermissionCollection}
* contains a {@code BasicPermission} with '*' as its permission name.
*
* @see #serialPersistentFields
*/
Expand Down
Expand Up @@ -162,7 +162,7 @@ public boolean needsReturnBuffer() {
/**
* The size of the return buffer, if one is needed.
*
* {@see #needsReturnBuffer}
* @see #needsReturnBuffer
*
* @return the return buffer size
*/
Expand Down
2 changes: 1 addition & 1 deletion src/java.base/share/classes/jdk/internal/vm/VMSupport.java
Expand Up @@ -66,7 +66,7 @@ private static byte[] serializePropertiesToByteArray(Properties p) throws IOExce
}

/**
* @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
*/
private static Properties onlyStrings(Properties p) {
Expand Down
Expand Up @@ -169,7 +169,7 @@ public String getDisplayVariant(String vrnt, Locale locale) {
}

/**
* @inheritDoc
* {@inheritDoc}
*/
@Override
public String getDisplayUnicodeExtensionKey(String key, Locale locale) {
Expand All @@ -180,7 +180,7 @@ public String getDisplayUnicodeExtensionKey(String key, Locale locale) {
}

/**
* @inheritDoc
* {@inheritDoc}
*/
@Override
public String getDisplayUnicodeExtensionType(String extType, String key, Locale locale) {
Expand Down
Expand Up @@ -645,7 +645,7 @@ private void updateOver(boolean o) {
//------------------------------------------------------------------

/**
* @inheritDoc
* {@inheritDoc}
*
* Ensures that isPressed() will return true if the combo is pressed,
* or the arrowButton is pressed, <em>or</em> if the combo popup is
Expand All @@ -659,7 +659,7 @@ public boolean isPressed() {
}

/**
* @inheritDoc
* {@inheritDoc}
*
* Ensures that the armed state is in sync with the pressed state
* if shouldActLikeButton is true. Without this method, the arrow
Expand All @@ -674,7 +674,7 @@ public boolean isArmed() {
}

/**
* @inheritDoc
* {@inheritDoc}
*
* Ensures that isRollover() will return true if the combo is
* rolled over, or the arrowButton is rolled over.
Expand All @@ -685,7 +685,7 @@ public boolean isRollover() {
}

/**
* @inheritDoc
* {@inheritDoc}
*
* Forwards pressed states to the internal "pressed" field
*/
Expand All @@ -696,7 +696,7 @@ public void setPressed(boolean b) {
}

/**
* @inheritDoc
* {@inheritDoc}
*
* Forwards rollover states to the internal "over" field
*/
Expand Down Expand Up @@ -738,7 +738,7 @@ public void mouseClicked(MouseEvent e) {}
//------------------------------------------------------------------

/**
* @inheritDoc
* {@inheritDoc}
*
* 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,
Expand Down
Expand Up @@ -67,7 +67,7 @@ protected void configureList() {
}

/**
* @inheritDoc
* {@inheritDoc}
*
* Overridden to take into account any popup insets specified in
* SynthComboBoxUI
Expand Down
2 changes: 1 addition & 1 deletion src/java.desktop/share/classes/sun/font/GlyphLayout.java
Expand Up @@ -346,7 +346,7 @@ public static SDCache get(Font font, FontRenderContext frc) {
* @param text the text, including optional context before start and after start + count
* @param offset the start 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
* @return the laid out glyphvector, if result was passed in, it is returned
*/
Expand Down
Expand Up @@ -93,15 +93,15 @@ private StateTrackableDelegate(State state) {
}

/**
* @inheritDoc
* {@inheritDoc}
* @since 1.7
*/
public State getState() {
return theState;
}

/**
* @inheritDoc
* {@inheritDoc}
* @since 1.7
*/
public synchronized StateTracker getStateTracker() {
Expand Down
Expand Up @@ -116,7 +116,7 @@ public final void run() {
* appends arguments and sends this {@code Runnable} for the
* execution if needed.
* <p>
* This implementation uses {@see #submit} to send this
* This implementation uses {@link #submit} to send this
* {@code Runnable} for execution.
* @param args the arguments to accumulate
*/
Expand Down
4 changes: 2 additions & 2 deletions src/java.desktop/share/classes/sun/swing/SwingUtilities2.java
Expand Up @@ -2278,11 +2278,11 @@ public static boolean isFloatingPointScale(AffineTransform tx) {

/**
* 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 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.
*/
public static boolean getBoolean(JComponent component, String key) {
Expand Down
2 changes: 1 addition & 1 deletion src/java.desktop/unix/classes/sun/awt/X11/XToolkit.java
Expand Up @@ -2385,7 +2385,7 @@ public static long getEventNumber() {
private static int oops_position = 0;

/**
* @inheritDoc
* {@inheritDoc}
*/
@Override
protected boolean syncNativeQueue(long timeout) {
Expand Down
Expand Up @@ -594,7 +594,7 @@ public boolean isRaw() {
/**
* 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
* {@see IntersectionClassType} and (ii) union types {@see UnionClassType}.
* {@link IntersectionClassType} and (ii) union types {@link UnionClassType}.
*/
public boolean isCompound() {
return false;
Expand Down
Expand Up @@ -2862,7 +2862,7 @@ public boolean test(Type mt1, Type mt2, Types types) {

/**
* 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
pavelrappo marked this conversation as resolved.
Show resolved Hide resolved
* methods' clauses.
*/
Expand Down
Expand Up @@ -2445,7 +2445,7 @@ private void checkNonCyclic1(DiagnosticPosition pos, Type t, List<TypeVar> seen)
*
* @param pos Position to be used for error reporting.
* @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) {
boolean complete = true; // was the check complete?
Expand Down
Expand Up @@ -656,7 +656,7 @@ public Type instantiateFunctionalInterface(DiagnosticPosition pos, Type funcInte

/**
* 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
* according to JLS 18.5.5.
*
Expand Down
Expand Up @@ -3305,7 +3305,7 @@ static ReferenceLookupResult error(Symbol sym) {

/**
* 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.
*/
abstract class ReferenceChooser {
Expand Down
Expand Up @@ -46,7 +46,7 @@ public interface DebugDirectoryEntry {

/** Format of debugging information: this field enables support of
multiple debuggers. See
@link{sun.jvm.hotspot.debugger.win32.coff.DebugTypes}. */
{@link sun.jvm.hotspot.debugger.win32.coff.DebugTypes}. */
public int getType();

/** Size of the debug data (not including the debug directory itself). */
Expand All @@ -60,7 +60,7 @@ public interface DebugDirectoryEntry {

/** If this debug directory entry is of type
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. */
public DebugVC50 getDebugVC50();

Expand Down
Expand Up @@ -30,9 +30,9 @@

/** Describes a path from an object back to the root which is keeping
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
@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
of the path, the FieldIdentifier will be null. */

Expand Down
Expand Up @@ -98,9 +98,9 @@ private static synchronized void remove(Cleaner cl) {
/**
* 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
* subsequent call to {@link CompilerToVM#releaseClearedOopHandles()} to reclaim the
* resources of the handle itself
* @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
* resources of the handle itself
*/
abstract boolean doCleanup();

Expand Down
Expand Up @@ -629,7 +629,7 @@ private Object[] finalizeObjectPool() throws JVMCIError {
* Determines if {@code name} or {@code method} are matched by
* {@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) {
String filter = Option.DumpSerializedCode.getString();
Expand Down
Expand Up @@ -31,7 +31,7 @@

/**
* 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}.
*/
public final class JFR {
Expand All @@ -50,7 +50,7 @@ public static long now() {
}

/**
* 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}.
*/
public static final class CompilerPhaseEvent {
Expand All @@ -75,7 +75,7 @@ public static void write(long startTime, String phaseName, int compileId, int ph
}

/**
* 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}.
*/
public static final class CompilerInliningEvent {
Expand Down
Expand Up @@ -66,8 +66,8 @@ enum IntrinsicMethod {
* interpreter overhead. If the parameter forceBytecodeGeneration is set to true, the VM should
* try to generate bytecodes before this method returns.
*
* @returns {@code null} if {@code methodHandle} is not a {@link MethodHandle} or the invocation
* target is not available at this time
* @return {@code null} if {@code methodHandle} is not a {@link MethodHandle} or the invocation
* target is not available at this time
* @throws NullPointerException if {@code methodHandle} is null
*/
ResolvedJavaMethod resolveInvokeBasicTarget(JavaConstant methodHandle, boolean forceBytecodeGeneration);
Expand All @@ -77,7 +77,7 @@ enum IntrinsicMethod {
* with the given constant member name. The member name is the last parameter of the
* {@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 IllegalArgumentException if {@code memberName} is not a
* {@code java.lang.invoke.MemberName}
Expand Down