groovy
  1. groovy
  2. GROOVY-5389

Integrate all Groovy API documentation

    Details

    • Type: Improvement Improvement
    • Status: Open Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: groovy-jdk
    • Labels:
      None
    • Number of attachments :
      0

      Description

      I currently have three links for Groovy-related API documentation: the JDK, the Groovy JDK, and the Groovy API docs. This makes it hard for users that are new to Groovy since they have to look in 3 different locations for docs.

      All three should be integrated together as the Groovy API documentation, with individual entries indicating whether they are part of core Java, methods or properties added to those classes, or Groovy-only classes. This is probably non-trivial but worth the investment in effort.

      One difficulty of course is knowing which Java API docs to integrate with the Groovy docs, but I would recommend whatever is the latest publicly available Java release.

        Activity

        No work has yet been logged on this issue.

          People

          • Assignee:
            Unassigned
            Reporter:
            Peter Ledbrook
          • Votes:
            11 Vote for this issue
            Watchers:
            7 Start watching this issue

            Dates

            • Created:
              Updated: