|
|||||||||
| 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.
| 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 | |
|---|---|
LinkArgument |
createLink()
Create link to Javadoc/GroovyDoc output at the given URL. |
void |
execute()
|
void |
setAuthor(boolean author)
If set to false, author will not be displayed. |
void |
setDestdir(File dir)
Set the directory where the Groovydoc output will be generated. |
void |
setDoctitle(String htmlTitle)
Set the title for the overview page. |
void |
setFooter(String footer)
Set the footer to place at the bottom of each generated html page. |
void |
setHeader(String header)
Specifies the header text to be placed at the top of each output file. |
void |
setOverview(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(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 |
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(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 setAuthor(boolean author)
author - new valuepublic 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 setDoctitle(String htmlTitle)
htmlTitle - the html to use for the title.public void setOverview(File file)
file - the overview filepublic void setPrivate(boolean b)
b - true if scope is to be private level.public void setPublic(boolean b)
b - true if scope only includes public level classes and memberspublic void setProtected(boolean b)
b - true if scope includes protected level classes and memberspublic void setPackage(boolean b)
b - true if scope includes package level classes and memberspublic void setFooter(String footer)
footer - the footer valuepublic void setHeader(String header)
header - the header value
public void execute()
throws BuildException
execute in class TaskBuildExceptionpublic LinkArgument createLink()
|
Copyright © 2003-2009 The Codehaus. All rights reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||