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

Clarify syntax of the @param tag

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Open
    • Priority: P4
    • Resolution: Unresolved
    • Affects Version/s: 19
    • Fix Version/s: 20
    • Component/s: tools
    • Labels:

      Description

      Clarify and possibly improve syntax of the @param tag in the case of type parameters.

      The examples below use three whitespace characters for clarity and defence against proportional fonts used by some browsers:

      1. Is the whitespace before `<` mandatory? (@param<T> vs @param <T>)
      2. Is the whitespace before `>` mandatory? (@param <T> vs @param <T >?

      Perhaps this should mimic the Java Language. That is, all such whitespace characters should be optional; for example: List <T>, List<T>, List<T >, List< T>


      Separately, the current wording only mentions "classes" in the context where it should be "classes and interfaces".

        Attachments

          Activity

            People

            Assignee:
            jjg Jonathan Gibbons
            Reporter:
            prappo Pavel Rappo
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated: