Groovy
  1. Groovy
  2. GROOVY-3736

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

    Details

    • Type: Bug Bug
    • Status: 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

      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

        Transition Time In Source Status Execution Times Last Executer Last Execution Date
        Open Open Resolved Resolved
        230d 20h 30m 1 Paul King 02/May/10 07:41
        Resolved Resolved Closed Closed
        44d 21h 8m 1 Guillaume Delcroix 16/Jun/10 04:50
        Mark Thomas made changes -
        Workflow jira [ 12970408 ] Default workflow, editable Closed status [ 12978177 ]
        Mark Thomas made changes -
        Project Import Mon Apr 06 02:11:23 UTC 2015 [ 1428286283443 ]
        Mark Thomas made changes -
        Workflow jira [ 12732718 ] Default workflow, editable Closed status [ 12744459 ]
        Mark Thomas made changes -
        Project Import Sun Apr 05 13:32:57 UTC 2015 [ 1428240777691 ]
        Guillaume Delcroix made changes -
        Status Resolved [ 5 ] Closed [ 6 ]
        Paul King made changes -
        Assignee Paul King [ paulk ]
        Resolution Fixed [ 1 ]
        Status Open [ 1 ] Resolved [ 5 ]
        Fix Version/s 1.6.9 [ 16236 ]
        Fix Version/s 1.7.3 [ 16356 ]
        Fix Version/s 1.8-beta-1 [ 16013 ]
        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.
        Paul King made changes -
        Component/s GroovyDoc [ 14303 ]
        Paul King made changes -
        Field Original Value New Value
        Affects Version/s 1.7.0 [ 14665 ]
        Affects Version/s 1.6.7 [ 16012 ]
        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.
        Russel Winder created issue -

          People

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

            Dates

            • Created:
              Updated:
              Resolved:

              Development