org.schmant.task.template.jdk.javadoc
Interface JavadocTaskConfigurable<T extends JavadocTaskConfigurable<T>>

All Superinterfaces:

ClasspathConfigurable<T>, SourceConfigurable<T>, TaskDecoratorConfigurable<T,JavadocTaskDecorator>

All Known Implementing Classes:

AbstractJavadocTaskFactory, ExtJavadocTF

public interface JavadocTaskConfigurable<T extends JavadocTaskConfigurable<T>>
extends ClasspathConfigurable<T>, SourceConfigurable<T>, TaskDecoratorConfigurable<T,JavadocTaskDecorator>

Configuration options for the Javadoc tool

Since:

0.5

Author:

Karl Gustafsson

Method Summary

T	addExcludePackage(String s)
T	addExcludePackages(Object o) Add one or several exclude packages.
T	addExtDirectories(Object o) Add one or several ext directories.
T	addExtDirectory(Object o) Add one or several ext directories.
T	addPackageName(String packageName)
T	addPackageNames(Object o) Add one or several package names.
T	addSourceFileName(String n)
T	addSourceFileNames(Object o) Add one or several source file names.
T	addTag(JavadocTagDefinition t) Corresponds to the -tag parameter.
T	addTag(String s) Corresponds to the -tag parameter.
T	addTaglet(String fqn) Corresponds to the -taglet parameter.
T	addTagletPath(Object o) Add one or several taglet paths.
T	addTagletPaths(Object o) This method does the same as addTagletPath(Object).
T	addTaglets(Object o) Add a collection of taglets.
T	addTags(Object o) Add one or several custom tags.
T	clearExcludePackages()
T	clearExtDirectories()
T	clearPackageNames()
T	clearSourceFileNames()
T	clearTagletPaths()
T	clearTaglets()
T	clearTags()
T	setBreakIterator(boolean b)
T	setEncoding(String name)
T	setLocale(String name)
T	setOverview(Object o)
T	setSourceCodeVersion(String version)
T	setSubPackages(boolean b)
T	setVisibilityLevel(JavadocVisibilityLevel l)

Methods inherited from interface org.schmant.task.confable.ClasspathConfigurable

addClasspathDecorator, addClasspathDecorators, addClasspathEntries, addClasspathEntry, clearClasspathDecorators, clearClasspathEntries

Methods inherited from interface org.schmant.task.confable.SourceConfigurable

addSource, addSources, clearSources, setRelativeToBase, setSource, setSources

Methods inherited from interface org.schmant.task.confable.TaskDecoratorConfigurable

addDecorator, addDecorators, clearDecorators

Method Detail

addPackageName

T addPackageName(String packageName)

addPackageNames

T addPackageNames(Object o)

Add one or several package names.

Parameters:

o - One string or an array or collection of strings.

clearPackageNames

T clearPackageNames()

setSubPackages

T setSubPackages(boolean b)

addSourceFileName

T addSourceFileName(String n)

addSourceFileNames

T addSourceFileNames(Object o)

Add one or several source file names.

Parameters:

o - One string or an array or collection of strings.

clearSourceFileNames

T clearSourceFileNames()

setOverview

T setOverview(Object o)

setVisibilityLevel

T setVisibilityLevel(JavadocVisibilityLevel l)

setSourceCodeVersion

T setSourceCodeVersion(String version)

addExcludePackage

T addExcludePackage(String s)

addExcludePackages

T addExcludePackages(Object o)

Add one or several exclude packages.

Parameters:

o - One package name or an array or collection of package names (strings).

clearExcludePackages

T clearExcludePackages()

addExtDirectory

T addExtDirectory(Object o)

Add one or several ext directories.

Parameters:

o - One directory or an array or collection of directories. This argument is interpreted. See the task reference documentation.

addExtDirectories

T addExtDirectories(Object o)

Add one or several ext directories.

Parameters:

o - One directory or an array or collection of directories. This argument is interpreted. See the task reference documentation.

clearExtDirectories

T clearExtDirectories()

setBreakIterator

T setBreakIterator(boolean b)

setLocale

T setLocale(String name)

setEncoding

T setEncoding(String name)

addTag

T addTag(String s)

Corresponds to the -tag parameter.

Add one custom tag.

Parameters:

s - The tag definition on String format.

Returns:

this

addTag

T addTag(JavadocTagDefinition t)

Corresponds to the -tag parameter.

Add one custom tag.

Parameters:

t - The tag definition represented as a JavadocTagDefinition object.

Returns:

this

addTags

T addTags(Object o)

Add one or several custom tags.

Corresponds to giving the -tag parameter for each added tag.

Parameters:

o - One or an array or collection of JavadocTagDefinition objects.

Returns:

this

clearTags

T clearTags()

addTaglet

T addTaglet(String fqn)

Corresponds to the -taglet parameter.

Parameters:

fqn - The fully qualified name of a taglet class.

Returns:

this

addTaglets

T addTaglets(Object o)

Add a collection of taglets.

Corresponds to giving the -taglet parameter for each added object.

Parameters:

o - One or an array or collection of taglet names (strings).

Returns:

this

clearTaglets

T clearTaglets()

addTagletPath

T addTagletPath(Object o)

Add one or several taglet paths. This corresponds to the -tagletpath parameter. The path is interpreted by InterpretAsFileStrategy.

Parameters:

o - The path to a taglet class directory. If this is a Collection or an array, it is flattened (see FlatteningList).

Returns:

this

addTagletPaths

T addTagletPaths(Object o)

This method does the same as addTagletPath(Object).

Parameters:

o - A collection of paths. See addTagletPath(Object).

Returns:

this

clearTagletPaths

T clearTagletPaths()