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
    • 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
    • Flags:
      Patch

      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

        Andre Steingress created issue -
        Guillaume Delcroix made changes -
        Field Original Value New Value
        Assignee Paul King [ paulk_asert ]
        Guillaume Delcroix made changes -
        Fix Version/s 1.9-beta-1 [ 17153 ]
        Resolution Fixed [ 1 ]
        Status Open [ 1 ] Resolved [ 5 ]
        Fix Version/s 1.8-rc-3 [ 17228 ]
        Fix Version/s 1.7.10 [ 17229 ]
        Paul King made changes -
        Status Resolved [ 5 ] Closed [ 6 ]
        Mark Thomas made changes -
        Project Import Sun Apr 05 13:32:57 UTC 2015 [ 1428240777691 ]
        Mark Thomas made changes -
        Workflow jira [ 12733654 ] Default workflow, editable Closed status [ 12745468 ]
        Mark Thomas made changes -
        Patch Submitted Yes [ 10763 ]
        Flags Patch [ 10430 ]
        Mark Thomas made changes -
        Project Import Mon Apr 06 02:11:23 UTC 2015 [ 1428286283443 ]
        Mark Thomas made changes -
        Workflow jira [ 12973515 ] Default workflow, editable Closed status [ 12974398 ]
        Mark Thomas made changes -
        Assignee paulk_asert [ paulk_asert ] Paul King [ paulk ]

          People

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

            Dates

            • Created:
              Updated:
              Resolved:

              Development