Uploaded image for project: 'Groovy'
  1. Groovy
  2. GROOVY-4724

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

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: 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.

        Attachments

          Activity

            People

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

              Dates

              • Created:
                Updated:
                Resolved: