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

javadoc of Formattable messed up by JDK-8019857

    XMLWordPrintable

    Details

    • Subcomponent:
    • Introduced In Version:
      8
    • Resolved In Build:
      b52
    • CPU:
      generic
    • OS:
      generic
    • Verification:
      Verified

      Backports

        Description

        The change in JDK-8019857 creates a multi-line code sample delimited only by {@code, which gets scrunched into one line.
        http://docs.oracle.com/javase/8/docs/api/java/util/Formattable.html
        The entire jdk javadoc should be audited for similar misformatted code samples, and the current blessed idiom (btw, where is that documented?) for code samples applied.

        --- a/src/share/classes/java/util/Formattable.java
        +++ b/src/share/classes/java/util/Formattable.java
        @@ -36,7 +36,7 @@
          * For example, the following class prints out different representations of a
          * stock's name depending on the flags and length constraints:
          *
        - * <blockquote><pre>
        + * {@code
          * import java.nio.CharBuffer;
          * import java.util.Formatter;
          * import java.util.Formattable;

          Attachments

            Issue Links

              Activity

                People

                Assignee:
                bpb Brian Burkhalter
                Reporter:
                martin Martin Buchholz
                Votes:
                0 Vote for this issue
                Watchers:
                7 Start watching this issue

                  Dates

                  Created:
                  Updated:
                  Resolved: