|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.codehaus.groovy.ant.Groovydoc
public class Groovydoc
Access to the GroovyDoc tool from Ant.
| Nested Class Summary | |
|---|---|
static class |
Groovydoc.LinkArgument
Represents a link pair (href, packages). |
| Field Summary |
|---|
| 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()
|
void |
setDestdir(File dir)
Set the directory where the Javadoc output will be generated. |
void |
setPackagenames(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(Path src)
Specify where to find source file |
void |
setUse(boolean b)
|
void |
setWindowtitle(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 |
| Constructor Detail |
|---|
public Groovydoc()
| Method Detail |
|---|
public void setSourcepath(Path src)
src - a Path instance containing the various source directories.public void setDestdir(File dir)
dir - the destination directory.public void setPackagenames(String packages)
packages - a comma separated list of packages specs
(may be wildcarded).public void setUse(boolean b)
public void setWindowtitle(String title)
title - the window title to use.public void setPrivate(boolean b)
b - true if scope is to be private level.
public void execute()
throws BuildException
execute in class TaskBuildExceptionpublic Groovydoc.LinkArgument createLink()
|
Copyright © 2003-2008 The Codehaus. All rights reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||