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

Relative href with ".." in first sentence causes sentence break warning

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Duplicate
    • Icon: P4 P4
    • None
    • 1.4.0
    • tools

      Running javadoc on this:

      /**
       * Class for <a href="../bar/baz.html#bingo">bar</a>.
       */
      public class Foo {
      }

      produces the following dubious warning, indicating that javadoc will be changed to not understand how to parse HTML correctly:

      Foo.java:4: warning - The first sentence is interpreted to be:
      "Class for <a href="../bar/baz.html#bingo">bar</a>."
      This sentence is different from what will be interpreted as the first sentence in the
      next major release (when that interpretation will be internationalized), which is:
      "Class for <a href=".."
      To avoid this note, change the doc comment to make this a proper first sentence, then
      use -breakiterator from that point forward, which will output this new sentence.

      The new sentence mistakenly stops at the dots denoting parent directory ".."
      From an HTML perspective, it should be clear that the periods
      in question are embedded inside an HTML tag, and therefore cannot
      reasonably be considered to mark the end of a sentence. The
      assertion that the next major release will consider them to
      mark the end of a sentence implies, to me, that the next major
      release will not understand what constitutes an HTML tag, that
      is, will not understand how to parse HTML correctly.

            Unassigned Unassigned
            bscheiflsunw Bob Scheifler (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: