Grails
  1. Grails
  2. GRAILS-6788

API documentation is missing for *.groovy classes

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 1.3.4, 1.3.5
    • Fix Version/s: 1.3.6, 1.4-M1
    • Component/s: Documentation
    • Labels:
      None

      Description

      API docs, in current release distribution (1.3.5), don't include documentation for *.groovy classes.
      http://forum.springsource.org/showthread.php?t=94736

        Activity

        Hide
        Damir Murat added a comment -

        I've attached a proposed patch which mainly solves this issue.

        There is one limitation, though. I didn't manage to make groovydoc's link method to work (meaning, links to the external apis doesn't exist). Whatever I tried, ended up with an exception. I'm not sure, but it seems there is a bug in Gradle's org.gradle.api.tasks.javadoc.AntGroovydoc.groovy while trying to execute org.gradle.api.tasks.javadoc.Groovydoc.java. Maybe someone can take a look at it.

        Although external links are missing, I believe that having api docs for all Grails classes (groovy and java) will be an improvement.

        Show
        Damir Murat added a comment - I've attached a proposed patch which mainly solves this issue. There is one limitation, though. I didn't manage to make groovydoc's link method to work (meaning, links to the external apis doesn't exist). Whatever I tried, ended up with an exception. I'm not sure, but it seems there is a bug in Gradle's org.gradle.api.tasks.javadoc.AntGroovydoc.groovy while trying to execute org.gradle.api.tasks.javadoc.Groovydoc.java . Maybe someone can take a look at it. Although external links are missing, I believe that having api docs for all Grails classes (groovy and java) will be an improvement.
        Hide
        Damir Murat added a comment -
        Show
        Damir Murat added a comment - Pull request added https://github.com/grails/grails-core/pull/20
        Show
        Graeme Rocher added a comment - Applied: https://github.com/grails/grails-core/commit/22a5054dc4a09b43f5552f3b023e9808fd9a8fd1 Thanks

          People

          • Assignee:
            Unassigned
            Reporter:
            Damir Murat
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development