groovy
  1. groovy
  2. GROOVY-3736

GroovyDoc processes first paragraph correctly but not the rest of overview.html

    Details

    • Type: Bug Bug
    • Status: Closed Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 1.6.7, 1.7.0
    • Fix Version/s: 1.7.3, 1.6.9, 1.8-beta-1
    • Component/s: GroovyDoc
    • Labels:
      None
    • Number of attachments :
      0

      Description

      JavaDoc uses the first paragraph of overview.html (or whatever file is nominated at the overview file), above the package listing of the overview page, and all of the content below. GroovyDoc puts the first paragraph above but then does not put the rest below.

        Activity

        Hide
        Paul King added a comment -

        Should be fixed - seems to generate Gant overview appropriately.

        Show
        Paul King added a comment - Should be fixed - seems to generate Gant overview appropriately.
        Hide
        Paul King added a comment -

        GroovyDoc is currently designed to put the entire overview.html above. This is slightly different behavior to JavaDoc but seemed a reasonable compromise. So I guess there are two issues here:

        • sometimes it must not be getting the complete overview
        • should it mimic JavaDoc exactly to avoid surprises for Java developers

        I suspect both should be fixed.

        Show
        Paul King added a comment - GroovyDoc is currently designed to put the entire overview.html above. This is slightly different behavior to JavaDoc but seemed a reasonable compromise. So I guess there are two issues here: sometimes it must not be getting the complete overview should it mimic JavaDoc exactly to avoid surprises for Java developers I suspect both should be fixed.

          People

          • Assignee:
            Paul King
            Reporter:
            Russel Winder
          • Votes:
            1 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: