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

@link tag arguments need correction for ElementType documentation

XMLWordPrintable

    • b165
    • Not verified

        FULL PRODUCT VERSION :
        java version "1.8.0_121"
        Java(TM) SE Runtime Environment (build 1.8.0_121-b13)
        Java HotSpot(TM) 64-Bit Server VM (build 25.121-b13, mixed mode)

        ADDITIONAL OS VERSION INFORMATION :
        Doesn't matter. This occurs on all OS's :-)

        A DESCRIPTION OF THE PROBLEM :
        This is a minor oversight on Joshua Bloch's part. See the javadoc comment for java.lang.ElementType annotation:

         * The constants of this enumerated type provide a simple classification of the
         * syntactic locations where annotations may appear in a Java program. These
         * constants are used in {@link Target java.lang.annotation.Target}
         * meta-annotations to specify where it is legal to write annotations of a
         * given type.

        The @link tag should be: {@link java.lang.annotation.Target Target} i.e. swap the II and III arguments.

        STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
        None specific.

        EXPECTED VERSUS ACTUAL BEHAVIOR :
        EXPECTED -
        Correct Javadoc with standard Javadoc tool.
        ACTUAL -
        Slightly incorrect output by the Javadoc tool.

        REPRODUCIBILITY :
        This bug can be reproduced always.

              darcy Joe Darcy
              webbuggrp Webbug Group
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Created:
                Updated:
                Resolved: