Grails
  1. Grails
  2. GRAILS-6530

Groovydoc generation includes duplicates

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 1.3.2, 1.3.3
    • Fix Version/s: 2.0-M1
    • Component/s: Documentation
    • Labels:
      None
    • Environment:
      Windows 7
    • Testcase included:
      yes

      Description

      The generation of groovydocs performed by "grails doc" will result in duplicates for each class. If you have a class doctest.DocTest the groovydoc will be generated for this class and for a non-existent default package (see attached example application). This is more of a groovydoc bug, but I think this issue might serve as a hint for those facing the same problem.

      A possible workaround:
      In the _GrailsDocs.groovy script line 114 change the sourcepath from "." to "grails-app". This skips the "src" directory though, which is not an acceptable solution.

      1. _GrailsDocs.groovy
        10 kB
        Timothy Overly
      2. doctest.tar.gz
        167 kB
        Daniel Rosowski

        Issue Links

          Activity

          Hide
          Timothy Overly added a comment -

          Happens in 1.3.5 too.

          Show
          Timothy Overly added a comment - Happens in 1.3.5 too.
          Hide
          Timothy Overly added a comment -

          Made a workaround for this issue:

          Does all the folders in grails-app and src/groovy and src/java.

          If someone could point me in the direction of passing variables to this script, I could modify this to accept additional directories. Not really familiar with how grails is passing variables.

          Show
          Timothy Overly added a comment - Made a workaround for this issue: Does all the folders in grails-app and src/groovy and src/java. If someone could point me in the direction of passing variables to this script, I could modify this to accept additional directories. Not really familiar with how grails is passing variables.
          Hide
          Timothy Overly added a comment -

          Workaround

          Show
          Timothy Overly added a comment - Workaround
          Hide
          Patrick Huber added a comment -

          Still happens (1.3.6). A fix would be nice...

          Show
          Patrick Huber added a comment - Still happens (1.3.6). A fix would be nice...
          Hide
          Mike Sandman added a comment -

          Timothy Overly's patch worked for me. Thanks!

          Grails 1.3.7

          Groovy Version: 1.7.0 JVM: 1.6.0_24

          java version "1.6.0_24"
          Java(TM) SE Runtime Environment (build 1.6.0_24-b07)
          Java HotSpot(TM) 64-Bit Server VM (build 19.1-b02, mixed mode)

          Distributor ID: Ubuntu
          Description: Ubuntu 10.10
          Release: 10.10
          Codename: maverick

          Show
          Mike Sandman added a comment - Timothy Overly's patch worked for me. Thanks! Grails 1.3.7 Groovy Version: 1.7.0 JVM: 1.6.0_24 java version "1.6.0_24" Java(TM) SE Runtime Environment (build 1.6.0_24-b07) Java HotSpot(TM) 64-Bit Server VM (build 19.1-b02, mixed mode) Distributor ID: Ubuntu Description: Ubuntu 10.10 Release: 10.10 Codename: maverick
          Hide
          Volnei Munhoz added a comment -

          Can you schedulle this bug for 1.4 M1?

          Thanks...

          Show
          Volnei Munhoz added a comment - Can you schedulle this bug for 1.4 M1? Thanks...
          Hide
          Peter Ledbrook added a comment -

          Thanks for the patch. I used it as the basis for the final fix.

          Show
          Peter Ledbrook added a comment - Thanks for the patch. I used it as the basis for the final fix.

            People

            • Assignee:
              Peter Ledbrook
              Reporter:
              Daniel Rosowski
            • Votes:
              10 Vote for this issue
              Watchers:
              8 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development