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

bad javadoc comments in Java SE classes

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Open
    • Priority: P4
    • Resolution: Unresolved
    • Affects Version/s: 9, 10, 11, 12, 13
    • Fix Version/s: tbd
    • Component/s: tools
    • Labels:
      None

      Description

      This is a result of an email discussion on running javadoc on src.zip
      http://mail.openjdk.java.net/pipermail/javadoc-dev/2018-August/000639.html

      The bottom line is that running javadoc in the simple/obvious way (NOT just "make docs") results in 918 warnings, mostly caused by bad doc comments. The list is attached.

      java.base 254
      java.compiler 1
      java.datatransfer 1
      java.desktop 189
      java.instrument 1
      java.logging 3
      java.management 117
      java.management.rmi 2
      java.naming 25
      java.net.http 7
      java.prefs 1
      java.rmi 19
      java.scripting 2
      java.se 2
      java.security.jgss 20
      java.security.sasl 3
      java.sql 6
      java.sql.rowset 31
      java.transaction.xa 1
      java.xml 303
      java.xml.crypto 9

      The bug is filed here as a placeholder; we should create subtasks for various subsets of the modules, to render the work more manageable.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              jjg Jonathan Gibbons
              Reporter:
              jjg Jonathan Gibbons
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated: