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

javadoc is throwing breakiterator warnings at '?' on java.lang.Exception

    XMLWordPrintable

Details

    • Bug
    • Resolution: Not an Issue
    • P4
    • None
    • 5.0
    • docs
    • generic
    • generic

    Description

      I did a recent javadoc build and found several warnings regarding the
      -breakiterator switch when parsing the java.lang.Exception class and
      it's descendents. Many of these warning were propagated into the
      JSN world by fixing 4496095.

      I filed the following before finding out the root cause was actually
      in Exception.

      4901502
      4901491
      4901492

      -------
      /security/home/wetmore/ws/tiger-bolt/src/share/javax/net/ssl/SSLException.java:6
      3: warning - The first sentence is interpreted to be:
      "Creates a <code>SSLException</code> with the specified cause
       and a detail message of <tt>(cause==null ? null : cause.toString())</tt>
       (which typically contains the class and detail message of
       <tt>cause</tt>)."
      This sentence is different from what would be generated using -breakiterator:
      "Creates a <code>SSLException</code> with the specified cause
       and a detail message of <tt>(cause==null ? "
      -------

      Talking to Josh (fixer of "4209652 Chained Exception Facility" which
      started these warnings), he made the following suggestion.

      ======
      We need to attack this problem systematically, probably by adding a new Javadoc tag to delimit the initial sentence, where required. (This is just a half-assed suggestion, but I think something along these lines will be required.) I think that we should pass the problem off to the Javadoc team when they have the time. Right now they're probably wilting under the strain of Generics/Varargs/Enums/Annotations:(

      Josh
      ======

      Not sure what the best solution is, but needs to be addressed before
      the "next major revision" changes the behaviour. :)

      Thanks,

      ###@###.### 2003-08-06

      Attachments

        Issue Links

          Activity

            People

              dkramersunw Douglas Kramer (Inactive)
              wetmore Bradford Wetmore
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:
                Imported:
                Indexed: