groovy
  1. groovy
  2. GROOVY-4724

add support for overriding package-, doc- or class-templates in Groovydoc descendant classes

    Details

    • Type: Improvement Improvement
    • Status: Closed Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.7.10, 1.8-rc-3, 1.9-beta-1
    • Component/s: GroovyDoc
    • Labels:
      None
    • Testcase included:
      yes
    • Patch Submitted:
      Yes
    • Number of attachments :
      1

      Description

      currently it is not possible to specify custom GroovyDoc package-, doc- or class-templates. additionally, as template files are loaded by the class loader (see ClasspathResourceManager), it is not possible to define templates outside the classpath.

      see Groovydoc.execute():

       
      GroovyDocTool htmlTool = new GroovyDocTool(
        new ClasspathResourceManager(),
        sourcePath.list(),
        GroovyDocTemplateInfo.DEFAULT_DOC_TEMPLATES,
        GroovyDocTemplateInfo.DEFAULT_PACKAGE_TEMPLATES,
        GroovyDocTemplateInfo.DEFAULT_CLASS_TEMPLATES,
        links,
        properties);
      

      This issue targets to allow Groovydoc descendant classes to override the default template classpath locations (and still relying on the classloader resource manager implementation).

      The attached patch adds three protected methods for retrieving package-, doc- and class-templates and has a test-case for specifying a custom class template.

        Activity

        Guillaume Laforge made changes -
        Field Original Value New Value
        Assignee Paul King [ paulk_asert ]
        Guillaume Laforge made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Fix Version/s 1.7.10 [ 17229 ]
        Fix Version/s 1.8-rc-3 [ 17228 ]
        Fix Version/s 1.9-beta-1 [ 17153 ]
        Resolution Fixed [ 1 ]
        Paul King made changes -
        Status Resolved [ 5 ] Closed [ 6 ]

          People

          • Assignee:
            Paul King
            Reporter:
            Andre Steingress
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: