OpenJPA
  1. OpenJPA
  2. OPENJPA-1099

<xmp> tag in Javadoc comments causes Javadoc corruption

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 1.1.0, 1.2.0, 1.2.1
    • Fix Version/s: 2.0.0-M2
    • Component/s: None
    • Labels:
      None
    • Environment:
      Windows maven (and nightly snapshots and releases)

      Description

      Two files (J2DoPrivHelper.java, and SequencedActionsTest.java) have <xmp>...</xmp> in their Javadoc comments. I don't know what the purpose of these tags may be in some environments. IMO, they should be replaced by <pre>...</pre> tags which do not cause problems for the Javadoc. The problem can be readily seen by opening the Javadoc of OpenJPA in a browser and clicking on index, then scroll down to the J2DoPrivHelper class entry. I'll leave this bug open for a few days to allow a chance for comments, in case I'm missing something.

        Activity

        Hide
        Michael Dick added a comment -

        It's my understanding that <xmp> is deprecated and we should replace with <pre></pre> using &lt &gt where appropriate.

        I think it's supported by some browsers though (or at least was for a while after it was deprecated). Regardless we should fix it.

        Show
        Michael Dick added a comment - It's my understanding that <xmp> is deprecated and we should replace with <pre></pre> using &lt &gt where appropriate. I think it's supported by some browsers though (or at least was for a while after it was deprecated). Regardless we should fix it.
        Hide
        David Ezzio added a comment -

        Fix in revision 777539.

        Show
        David Ezzio added a comment - Fix in revision 777539.

          People

          • Assignee:
            David Ezzio
            Reporter:
            David Ezzio
          • Votes:
            1 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development