org.codehaus.groovy.ant
Class Groovydoc

java.lang.Object
  extended by org.apache.tools.ant.ProjectComponent
      extended by org.apache.tools.ant.Task
          extended by org.codehaus.groovy.ant.Groovydoc
All Implemented Interfaces:
java.lang.Cloneable

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

Access to the GroovyDoc tool from Ant.

Version:
$Id$

Nested Class Summary
static class Groovydoc.LinkArgument
          Represents a link pair (href, packages).
 
Field Summary
private  java.io.File destDir
           
private  java.util.List excludePackageNames
           
private  boolean includeNoSourcePackages
           
private  java.util.List links
           
private  LoggingHelper log
           
private  java.util.List packageNames
           
private  java.util.List packageSets
           
private  boolean privateScope
           
private  java.util.List sourceFilesToDoc
           
private  org.apache.tools.ant.types.Path sourcePath
           
private  boolean useDefaultExcludes
           
private  java.lang.String windowTitle
           
 
Fields inherited from class org.apache.tools.ant.Task
target, taskName, taskType, wrapper
 
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
 
Constructor Summary
Groovydoc()
           
 
Method Summary
 Groovydoc.LinkArgument createLink()
          Create link to Javadoc/GroovyDoc output at the given URL.
 void execute()
           
private  void parsePackages(java.util.List resultantPackages, org.apache.tools.ant.types.Path sp)
          Add the directories matched by the nested dirsets to the Vector and the base directories of the dirsets to the Path.
 void setDestdir(java.io.File dir)
          Set the directory where the Javadoc output will be generated.
 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 setSourcepath(org.apache.tools.ant.types.Path src)
          Specify where to find source file
 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
bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 
Methods inherited from class org.apache.tools.ant.ProjectComponent
clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

private final LoggingHelper log

sourcePath

private org.apache.tools.ant.types.Path sourcePath

destDir

private java.io.File destDir

packageNames

private java.util.List packageNames

excludePackageNames

private java.util.List excludePackageNames

windowTitle

private java.lang.String windowTitle

privateScope

private boolean privateScope

useDefaultExcludes

private boolean useDefaultExcludes

includeNoSourcePackages

private boolean includeNoSourcePackages

packageSets

private java.util.List packageSets

sourceFilesToDoc

private java.util.List sourceFilesToDoc

links

private java.util.List links
Constructor Detail

Groovydoc

public Groovydoc()
Method Detail

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.

setDestdir

public void setDestdir(java.io.File dir)
Set the directory where the Javadoc output will be generated.

Parameters:
dir - the destination directory.

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).

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.

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.

parsePackages

private void parsePackages(java.util.List resultantPackages,
                           org.apache.tools.ant.types.Path sp)
Add the directories matched by the nested dirsets to the Vector and the base directories of the dirsets to the Path. It also handles the packages and excludepackages attributes and elements.

Since:
1.5

execute

public void execute()
             throws org.apache.tools.ant.BuildException
Overrides:
execute in class org.apache.tools.ant.Task
Throws:
org.apache.tools.ant.BuildException

createLink

public Groovydoc.LinkArgument createLink()
Create link to Javadoc/GroovyDoc output at the given URL.

Returns:
link argument to configure


Copyright © ${year} The Codehaus. All Rights Reserved.