Constructor Detail

• @Deprecated
  public GroovyDocWriter(GroovyDocTool tool, OutputTool output, GroovyDocTemplateEngine templateEngine, Properties properties)

  deprecated:

  Use GroovyDocWriter(OutputTool, GroovyDocTemplateEngine, Properties)

• public GroovyDocWriter(OutputTool output, GroovyDocTemplateEngine templateEngine, Properties properties)

  Creates a writer with no source-path information (resource files will not be copied).

• public GroovyDocWriter(OutputTool output, GroovyDocTemplateEngine templateEngine, Properties properties, String[] sourcepaths)

  Creates a writer with source-path information used to locate and mirror resource directories.

  Since:

  6.0.0

Method Detail

• public void writeClassToOutput(GroovyClassDoc classDoc, String destdir)

  Writes the HTML page for a single class doc if its visibility matches the configured scope.

• public void writeClasses(GroovyRootDoc rootDoc, String destdir)

  Writes HTML for every class in the root doc to the destination directory.

• public void writePackageToOutput(GroovyPackageDoc packageDoc, String destdir)

  Writes all package-level template output for a single package doc to the destination directory.

• public void writePackages(GroovyRootDoc rootDoc, String destdir)

  Writes package-level HTML pages and the package-list file to the destination directory.

• public void writeRoot(GroovyRootDoc rootDoc, String destdir)

  Creates the output area and writes the root-level documentation pages.

• public void writeRootDocToOutput(GroovyRootDoc rootDoc, String destdir)

  Writes each root-level template to the destination directory, skipping disabled pages and copying binary resources verbatim.