Uploaded image for project: 'Groovy'
  1. Groovy
  2. GROOVY-7034

groovydoc for package-info embeds doc within the <h2> tag -- creates malformed HTML

    XMLWordPrintableJSON

Details

    • Bug
    • Status: Closed
    • Minor
    • Resolution: Fixed
    • 2.3.1, 2.4.0-beta-2
    • 2.4.2
    • GroovyDoc
    • None

    Description

      The groovydoc Ant task generates documentation for the package-info.java, but it places the generated documentation into the HTML twice, once in an illegal spot in the middle of an "H2" tag and once in a legal, but incorrect spot--inside the H2 tag. I think it's supposed to go after the H2 tag.

      My Web browser (Firefox 20) renders this as large blocky text, but does not show it twice.

      The snippet of HTML generated from the repro looks like this:

      <div class="header">
      <h2 title=" <p>This is the description for a sample package named "groovydoctest"</p>
      <p>This is the second paragraph</p>
      <pre>This is some sample code</pre>
      " class="title"> <p>This is the description for a sample package named "groovydoctest"</p>
      <p>This is the second paragraph</p>
      <pre>This is some sample code</pre>

      </h2>
      </div>

      I have attached a ZIP file which contains a tiny project that you can use to reproduce the problem. You'll have to change the location of groovy-all.jar in the build.xml. Then you can run "ant all" to build both the GroovyDoc form and the JavaDoc form.

      I have included the generated HTML in the .ZIP file. I have separately attached the package-summary.html that it generates on my machine, from which the above snippet was taken. Note that this was placed in the DefaultPackage directory, not the actual package directory.

      I first noticed this in groovy-2.3.1 and confirmed that it's still reproducible with groovy-all-2.4.0-beta-2.jar.

      Attachments

        1. package-summary.html
          3 kB
          David Costanzo
        2. groovydocbug.zip
          60 kB
          David Costanzo

        Activity

          People

            paulk Paul King
            david_costanzo David Costanzo
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: