Groovy Documentation

## org.codehaus.groovy.ant
[Java] Class Groovydoc

    java.lang.Object
      org.apache.tools.ant.ProjectComponent
          org.apache.tools.ant.Task
              org.codehaus.groovy.ant.Groovydoc

    public class Groovydoc
    extends org.apache.tools.ant.Task

Access to the GroovyDoc tool from Ant.

Version:
  \$Id\$

Constructor Summary
`Groovydoc()`

Method Summary
`LinkArgument` | `createLink()` Create link to Javadoc/GroovyDoc output at the given URL.
`void` | `execute()`
`protected java.lang.String[]` | `getClassTemplates()`
`protected java.lang.String[]` | `getDocTemplates()` Creates and returns an array of class template classpath entries.
`protected java.lang.String[]` | `getPackageTemplates()` Creates and returns an array of doc template classpath entries.
`void` | `setAccess(java.lang.String access)` Indicates the access mode or scope of interest: one of public, protected, package, or private.
`void` | `setAuthor(boolean author)` If set to false, author will not be displayed.
`void` | `setCharset(java.lang.String charset)` Specifies the charset to be used in the templates, i.e.
`void` | `setDestdir(java.io.File dir)` Set the directory where the Groovydoc output will be generated.
`void` | `setDoctitle(java.lang.String htmlTitle)` Set the title for the overview page.
`void` | `setExtensions(java.lang.String extensions)` A colon-separated list of filename extensions to look for when searching for files to process in a given directory.
`void` | `setFooter(java.lang.String footer)` Set the footer to place at the bottom of each generated html page.
`void` | `setHeader(java.lang.String header)` Specifies the header text to be placed at the top of each output file.
`void` | `setIncludeMainForScripts(boolean includeMainForScripts)` If set to false, 'public static void main' method will not be displayed.
`void` | `setOverview(java.io.File file)` Specify the file containing the overview to be included in the generated documentation.
`void` | `setPackage(boolean b)` Indicate whether only package, protected and public classes and members are to be included in the scope processed.
`void` | `setPackagenames(java.lang.String packages)` Set the package names to be processed.
`void` | `setPrivate(boolean b)` Indicate whether all classes and members are to be included in the scope processed.
`void` | `setProcessScripts(boolean processScripts)` If set to false, Scripts will not be processed.
`void` | `setProtected(boolean b)` Indicate whether only protected and public classes and members are to be included in the scope processed.
`void` | `setPublic(boolean b)` Indicate whether only public classes and members are to be included in the scope processed.
`void` | `setSourcepath(org.apache.tools.ant.types.Path src)` Specify where to find source file
`void` | `setStyleSheetFile(java.io.File styleSheetFile)` Specifies a stylesheet file to use.
`void` | `setUse(boolean b)`
`void` | `setWindowtitle(java.lang.String title)` Set the title to be placed in the HTML <title> tag of the generated documentation.

Methods inherited from class org.apache.tools.ant.Task

org.apache.tools.ant.Task#getTaskName(), org.apache.tools.ant.Task#perform(), org.apache.tools.ant.Task#bindToOwner(org.apache.tools.ant.Task), org.apache.tools.ant.Task#reconfigure(), org.apache.tools.ant.Task#setTaskName(java.lang.String), org.apache.tools.ant.Task#setOwningTarget(org.apache.tools.ant.Target), org.apache.tools.ant.Task#getRuntimeConfigurableWrapper(), org.apache.tools.ant.Task#setRuntimeConfigurableWrapper(org.apache.tools.ant.RuntimeConfigurable), org.apache.tools.ant.Task#maybeConfigure(), org.apache.tools.ant.Task#getOwningTarget(), org.apache.tools.ant.Task#getTaskType(), org.apache.tools.ant.Task#setTaskType(java.lang.String), org.apache.tools.ant.Task#log(java.lang.String), org.apache.tools.ant.Task#log(java.lang.String, int), org.apache.tools.ant.Task#log(java.lang.Throwable, int), org.apache.tools.ant.Task#log(java.lang.String, java.lang.Throwable, int), org.apache.tools.ant.Task#init(), org.apache.tools.ant.Task#execute(), org.apache.tools.ant.Task#setDescription(java.lang.String), org.apache.tools.ant.Task#getProject(), org.apache.tools.ant.Task#setProject(org.apache.tools.ant.Project), org.apache.tools.ant.Task#clone(), org.apache.tools.ant.Task#getLocation(), org.apache.tools.ant.Task#getDescription(), org.apache.tools.ant.Task#setLocation(org.apache.tools.ant.Location), org.apache.tools.ant.Task#wait(long), org.apache.tools.ant.Task#wait(long, int), org.apache.tools.ant.Task#wait(), org.apache.tools.ant.Task#equals(java.lang.Object), org.apache.tools.ant.Task#toString(), org.apache.tools.ant.Task#hashCode(), org.apache.tools.ant.Task#getClass(), org.apache.tools.ant.Task#notify(), org.apache.tools.ant.Task#notifyAll()

Methods inherited from class org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.ProjectComponent#setDescription(java.lang.String), org.apache.tools.ant.ProjectComponent#getProject(), org.apache.tools.ant.ProjectComponent#setProject(org.apache.tools.ant.Project), org.apache.tools.ant.ProjectComponent#clone(), org.apache.tools.ant.ProjectComponent#log(java.lang.String), org.apache.tools.ant.ProjectComponent#log(java.lang.String, int), org.apache.tools.ant.ProjectComponent#getLocation(), org.apache.tools.ant.ProjectComponent#getDescription(), org.apache.tools.ant.ProjectComponent#setLocation(org.apache.tools.ant.Location), org.apache.tools.ant.ProjectComponent#wait(long), org.apache.tools.ant.ProjectComponent#wait(long, int), org.apache.tools.ant.ProjectComponent#wait(), org.apache.tools.ant.ProjectComponent#equals(java.lang.Object), org.apache.tools.ant.ProjectComponent#toString(), org.apache.tools.ant.ProjectComponent#hashCode(), org.apache.tools.ant.ProjectComponent#getClass(), org.apache.tools.ant.ProjectComponent#notify(), org.apache.tools.ant.ProjectComponent#notifyAll()

Constructor Detail

### Groovydoc

    public Groovydoc()

Method Detail

### createLink

    public LinkArgument createLink()

  Create link to Javadoc/GroovyDoc output at the given URL.
  Returns:
    link argument to configure

### execute

    public void execute()

### getClassTemplates

    protected java.lang.String[] getClassTemplates()

### getDocTemplates

    protected java.lang.String[] getDocTemplates()

  Creates and returns an array of class template classpath entries.

  This method is meant to be overridden by custom GroovyDoc implementations, using custom class templates.
  Returns:
    an array of class templates, whereas each entry is resolved as classpath entry, defaults to GroovyDocTemplateInfo.DEFAULT_CLASS_TEMPLATES.

### getPackageTemplates

    protected java.lang.String[] getPackageTemplates()

  Creates and returns an array of doc template classpath entries.

  This method is meant to be overridden by custom GroovyDoc implementations, using custom doc templates.
  Returns:
    an array of doc templates, whereas each entry is resolved as classpath entry, defaults to GroovyDocTemplateInfo.DEFAULT_DOC_TEMPLATES.

### setAccess

    public void setAccess(java.lang.String access)

  Indicates the access mode or scope of interest: one of public, protected, package, or private. Package scoped access is ignored for fields of Groovy classes where they correspond to properties.
  Parameters:
    `access` - one of public, protected, package, or private

### setAuthor

    public void setAuthor(boolean author)

  If set to false, author will not be displayed. Currently not used.
  Parameters:
    `author` - new value

### setCharset

    public void setCharset(java.lang.String charset)

  Specifies the charset to be used in the templates, i.e. the value output within: <meta http-equiv="Content-Type" content="text/html; charset=charset">.
  Parameters:
    `charset` - the charset value

### setDestdir

    public void setDestdir(java.io.File dir)

  Set the directory where the Groovydoc output will be generated.
  Parameters:
    `dir` - the destination directory.

### setDoctitle

    public void setDoctitle(java.lang.String htmlTitle)

  Set the title for the overview page.
  Parameters:
    `htmlTitle` - the html to use for the title.

### setExtensions

    public void setExtensions(java.lang.String extensions)

  A colon-separated list of filename extensions to look for when searching for files to process in a given directory. Default value: `.java:.groovy:.gv:.gvy:.gsh`
  Parameters:
    `extensions` - new value

### setFooter

    public void setFooter(java.lang.String footer)

  Set the footer to place at the bottom of each generated html page.
  Parameters:
    `footer` - the footer value

### setHeader

    public void setHeader(java.lang.String header)

  Specifies the header text to be placed at the top of each output file. The header will be placed to the right of the upper navigation bar. It may contain HTML tags and white space, though if it does, it must be enclosed in quotes. Any internal quotation marks within the header may have to be escaped.
  Parameters:
    `header` - the header value

### setIncludeMainForScripts

    public void setIncludeMainForScripts(boolean includeMainForScripts)

  If set to false, 'public static void main' method will not be displayed. Defaults to true. Ignored when not processing Scripts.
  Parameters:
    `includeMainForScripts` - new value

### setOverview

    public void setOverview(java.io.File file)

  Specify the file containing the overview to be included in the generated documentation.
  Parameters:
    `file` - the overview file

### setPackage

    public void setPackage(boolean b)

  Indicate whether only package, protected and public classes and members are to be included in the scope processed. Package scoped access is ignored for fields of Groovy classes where they correspond to properties.
  Parameters:
    `b` - true if scope includes package level classes and members

### setPackagenames

    public void setPackagenames(java.lang.String packages)

  Set the package names to be processed.
  Parameters:
    `packages` - a comma separated list of packages specs (may be wildcarded).

### setPrivate

    public void setPrivate(boolean b)

  Indicate whether all classes and members are to be included in the scope processed.
  Parameters:
    `b` - true if scope is to be private level.

### setProcessScripts

    public void setProcessScripts(boolean processScripts)

  If set to false, Scripts will not be processed. Defaults to true.
  Parameters:
    `processScripts` - new value

### setProtected

    public void setProtected(boolean b)

  Indicate whether only protected and public classes and members are to be included in the scope processed.
  Parameters:
    `b` - true if scope includes protected level classes and members

### setPublic

    public void setPublic(boolean b)

  Indicate whether only public classes and members are to be included in the scope processed.
  Parameters:
    `b` - true if scope only includes public level classes and members

### setSourcepath

    public void setSourcepath(org.apache.tools.ant.types.Path src)

  Specify where to find source file
  Parameters:
    `src` - a Path instance containing the various source directories.

### setStyleSheetFile

    public void setStyleSheetFile(java.io.File styleSheetFile)

  Specifies a stylesheet file to use. If not specified, a default one will be generated for you.
  Parameters:
    `styleSheetFile` - the css stylesheet file to use

### setUse

    public void setUse(boolean b)

### setWindowtitle

    public void setWindowtitle(java.lang.String title)

  Set the title to be placed in the HTML <title> tag of the generated documentation.
  Parameters:
    `title` - the window title to use.

Groovy Documentation