Grails
  1. Grails
  2. GRAILS-7920

Add documentation elements to the grails.dsld file

    Details

    • Type: Improvement Improvement
    • Status: Open
    • Priority: Major Major
    • Resolution: Unresolved
    • Affects Version/s: 2.0-M1
    • Fix Version/s: None
    • Component/s: None
    • Labels:

      Description

      The groovy-eclipse dsld language supports adding javadoc-like tags to contribution elements. You can add documentation inside of a contribution block like this:

      currentType().accept {
         method name:"myMethod", ... doc: """
              Here is some documentation.  
              Some <b>standard</b> html tags are recognized."""
      
        property name:"myProp", ... doc: """
              properties also accept documentation"""
      }
      

      Please let me know if you need any help with constructing the documentation.

      I don't think it is necessary to provide too much documentation. Just perhaps a sentence or two and a link to the documentation online.

        Activity

        There are no comments yet on this issue.

          People

          • Assignee:
            Unassigned
            Reporter:
            Andrew Eisenberg
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Last Reviewed:

              Development