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

Chris Plummer cjplummer at openjdk.org
Mon Jan 8 20:22:31 UTC 2024


Fix some broken links and other minor cleanups:

 There are a few broken links in the javadoc for ObjectReference.java. For example:


     * Not all target VMs support this operation. See
     * VirtualMachine#canGetMonitorInfo to determine if the
     * operation is supported.


Which should be:


     * Not all target VMs support this operation. See
     * {@link VirtualMachine#canGetMonitorInfo} to determine if the
     * operation is supported.



The following does not need to include the link text:

`     * {@link VirtualMachine#canGetInstanceInfo() canGetInstanceInfo()}`

Instead just use:

`     * {@link VirtualMachine#canGetInstanceInfo()}`


There are many places where we embed a "see" rather than use @see. The formatting convention is:

`     * @throws VMCannotBeModifiedException if the VirtualMachine is read-only - see {@link VirtualMachine#canBeModified()}.`

However, there are a few places that are missing a space before the "see":


     * @throws VMCannotBeModifiedException if the VirtualMachine is read-only
     * -see {@link VirtualMachine#canBeModified()}.

-------------

Commit messages:
 - Minor cleanup of some javadocs

Changes: https://git.openjdk.org/jdk/pull/17311/files
 Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=17311&range=00
  Issue: https://bugs.openjdk.org/browse/JDK-8323213
  Stats: 14 lines in 2 files changed: 1 ins; 0 del; 13 mod
  Patch: https://git.openjdk.org/jdk/pull/17311.diff
  Fetch: git fetch https://git.openjdk.org/jdk.git pull/17311/head:pull/17311

PR: https://git.openjdk.org/jdk/pull/17311


More information about the serviceability-dev mailing list