Groovy
  1. Groovy
  2. GROOVY-1713

Automated GLS documentation out of TCK test cases

    Details

    • Type: Task Task
    • Status: Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: 3.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      JSR-241 contains three key deliverables:

      • RI: the Reference Implementation
      • GLS: the Groovy Language Specificatcion
      • TCK: the Test Compatibility Kit

      The GLS consists of:

      • the grammar and its diagrams (generated by Antlr from our Antlr grammar)
      • the specification explaining how the language works

      With an appropriate tree structure and with the aggregation of some html files, we could generate the specification out of the tests and those html files.
      The folder structure would create the outline of the whole document.

      It is a nice way of simplifying, automatically testing and automating the process of writing the Groovy Language Specification.

      This work can be hooked in the futher build process used to build distributions.

        Issue Links

          Activity

          Guillaume Delcroix created issue -
          Guillaume Delcroix made changes -
          Field Original Value New Value
          Link This issue depends upon GROOVY-1711 [ GROOVY-1711 ]
          Guillaume Delcroix made changes -
          Link This issue depends upon GROOVY-1712 [ GROOVY-1712 ]
          Guillaume Delcroix made changes -
          Fix Version/s 1.1 [ 13166 ]
          Fix Version/s 2.0 [ 13489 ]
          Guillaume Delcroix made changes -
          Assignee Guillaume Laforge [ guillaume ]
          Pascal Schumacher made changes -
          Component/s Documentation [ 15462 ]
          Mark Thomas made changes -
          Project Import Sun Apr 05 13:32:57 UTC 2015 [ 1428240777691 ]
          Mark Thomas made changes -
          Workflow jira [ 12730837 ] Default workflow, editable Closed status [ 12742805 ]
          Mark Thomas made changes -
          Project Import Mon Apr 06 02:11:23 UTC 2015 [ 1428286283443 ]
          Mark Thomas made changes -
          Workflow jira [ 12969153 ] Default workflow, editable Closed status [ 12976914 ]
          Pascal Schumacher made changes -
          Assignee Guillaume Delcroix [ guillaume ]

            People

            • Assignee:
              Unassigned
              Reporter:
              Guillaume Delcroix
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:

                Development