8323213: Fix some javadoc broken links in ObjectReference, and other misc javadoc cleanups

Reviewed-by: sspitsyn, amenkov
This commit is contained in:
Chris Plummer 2024-01-11 18:13:11 +00:00
parent b78896b9aa
commit 93bedd7aba
2 changed files with 14 additions and 13 deletions

View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2023, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2024, 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
@ -306,7 +306,7 @@ public interface ObjectReference extends Value {
* consequently, may result in application behavior under the
* debugger that differs from its non-debugged behavior.
* @throws VMCannotBeModifiedException if the VirtualMachine is read-only
* -see {@link VirtualMachine#canBeModified()}.
* - see {@link VirtualMachine#canBeModified()}.
*/
void disableCollection();
@ -317,7 +317,7 @@ public interface ObjectReference extends Value {
* is necessary only if garbage collection was previously disabled
* with {@link #disableCollection}.
* @throws VMCannotBeModifiedException if the VirtualMachine is read-only
* -see {@link VirtualMachine#canBeModified()}.
* - see {@link VirtualMachine#canBeModified()}.
*/
void enableCollection();
@ -328,7 +328,7 @@ public interface ObjectReference extends Value {
* @return <code>true</code> if this {@link ObjectReference} has been collected;
* <code>false</code> otherwise.
* @throws VMCannotBeModifiedException if the VirtualMachine is read-only
* -see {@link VirtualMachine#canBeModified()}.
* - see {@link VirtualMachine#canBeModified()}.
*/
boolean isCollected();
@ -351,7 +351,7 @@ public interface ObjectReference extends Value {
* for a monitor.
* <p>
* Not all target VMs support this operation. See
* VirtualMachine#canGetMonitorInfo to determine if the
* {@link VirtualMachine#canGetMonitorInfo} to determine if the
* operation is supported.
*
* @return a List of {@link ThreadReference} objects. The list
@ -372,7 +372,7 @@ public interface ObjectReference extends Value {
* of ownership.
* <p>
* Not all target VMs support this operation. See
* VirtualMachine#canGetMonitorInfo to determine if the
* {@link VirtualMachine#canGetMonitorInfo} to determine if the
* operation is supported.
*
* @return the {@link ThreadReference} which currently owns the
@ -392,7 +392,7 @@ public interface ObjectReference extends Value {
* of ownership.
* <p>
* Not all target VMs support this operation. See
* VirtualMachine#canGetMonitorInfo to determine if the
* {@link VirtualMachine#canGetMonitorInfo} to determine if the
* operation is supported.
*
* @see #owningThread
@ -422,12 +422,12 @@ public interface ObjectReference extends Value {
* @param maxReferrers The maximum number of referring objects to return.
* Must be non-negative. If zero, all referring
* objects are returned.
* @return a of List of {@link ObjectReference} objects. If there are
* @return a List of {@link ObjectReference} objects. If there are
* no objects that reference this object, a zero-length list is returned..
* @throws java.lang.UnsupportedOperationException if
* the target virtual machine does not support this
* operation - see
* {@link VirtualMachine#canGetInstanceInfo() canGetInstanceInfo()}
* {@link VirtualMachine#canGetInstanceInfo()}
* @throws java.lang.IllegalArgumentException if maxReferrers is less
* than zero.
* @since 1.6

View File

@ -1,5 +1,5 @@
/*
* Copyright (c) 1998, 2022, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1998, 2024, 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
@ -427,7 +427,7 @@ public interface VirtualMachine extends Mirror {
* @return a {@link StringReference} that mirrors the newly created
* string in the target VM.
* @throws VMCannotBeModifiedException if the VirtualMachine is read-only
* -see {@link VirtualMachine#canBeModified()}.
* - see {@link VirtualMachine#canBeModified()}.
*/
StringReference mirrorOf(String value);
@ -448,7 +448,7 @@ public interface VirtualMachine extends Mirror {
* @return the {@link java.lang.Process} object for this virtual
* machine, or null if it was not launched by a {@link LaunchingConnector}.
* @throws VMCannotBeModifiedException if the VirtualMachine is read-only
* -see {@link VirtualMachine#canBeModified()}.
* - see {@link VirtualMachine#canBeModified()}.
*/
Process process();
@ -678,7 +678,8 @@ public interface VirtualMachine extends Mirror {
* Determines if the target VM supports the filtering of
* class prepare events by source name.
*
* see {@link ClassPrepareRequest#addSourceNameFilter}.
* @see ClassPrepareRequest#addSourceNameFilter
*
* @return <code>true</code> if the feature is supported,
* <code>false</code> otherwise.
*