Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8323213

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

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: P4 P4
    • 23
    • 23
    • core-svc
    • b06

        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()}.

              cjplummer Chris Plummer
              cjplummer Chris Plummer
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: