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

All Superinterfaces:

JavadocTaskDecorator, TargetConfigurable<T>, TaskDecorator, ValidatingDecorator

All Known Implementing Classes:

AbstractStandardDocletDecorator, ExtStandardDocletDecorator

public interface StandardDocletDecorator<T extends StandardDocletDecorator<T>>
extends JavadocTaskDecorator, TargetConfigurable<T>

A decorator for generating Javadoc documentation using the standard doclet.

Since:

0.5

Author:

Karl Gustafsson

Method Summary

T	addExcludeDocFilesSubdir(String name) Corresponds to one segment of the Standard doclet's -excludedocfilessubdir parameter.
T	addExcludeDocFilesSubdirs(Object o) Corresponds to setting a segment of the Standard doclet's -excludedocfilessubdir parameter for each object in the collection.
T	addGroup(JavadocPackageGroup pg) Add one package group.
T	addGroup(String heading, String packages) Add one package group.
T	addGroups(Object o) Add a collection of package groups.
T	addLink(String l) Corresponds to the Standard doclet's -link parameter.
T	addLinks(Object o) Add a collection of links to the Standard doclet.
T	addNoQualifierPackage(String name) Corresponds to one segment of the Standard doclet's -noqualifier parameter.
T	addNoQualifierPackages(Object o) Corresponds to setting a segment of the Standard doclet's -noqualifier parameter for each object in the collection.
T	addOfflineLink(String l) Corresponds to the Standard doclet's -linkoffline parameter.
T	addOfflineLinks(Object o) Add a collection of links.
T	disableComment(boolean b) Corresponds to the Standard doclet's -nocomment flag.
T	disableDeprecated(boolean b) Corresponds to the Standard doclet's -nodeprecated flag.
T	disableDeprecatedList(boolean b) Corresponds to the Standard doclet's -nodeprecatedlist flag.
T	disableHelp(boolean b) Corresponds to the Standard doclet's -nohelp flag.
T	disableIndex(boolean b) Corresponds to the Standard doclet's -noindex flag.
T	disableNavbar(boolean b) Corresponds to the Standard doclet's -nonavbar flag.
T	disableSince(boolean b) Corresponds to the Standard doclet's -nosince flag.
T	disableTimestamp(boolean b) Corresponds to the Standard doclet's -notimestamp flag.
T	disableTree(boolean b) Corresponds to the Standard doclet's -notree flag.
T	setAuthor(boolean b) Corresponds to the Standard doclet's -author flag.
T	setBottom(String bottom) Corresponds to the Standard doclet's -bottom parameter.
T	setCharset(String name) Corresponds to the Standard doclet's -charset parameter.
T	setDocEncoding(String name) Corresponds to the Standard doclet's -docencoding parameter.
T	setDocFilesSubdirs(boolean b) Corresponds to the Standard doclet's -docfilessubdirs flag.
T	setDocTitle(String title) Corresponds to the Standard doclet's -doctitle parameter.
T	setFooter(String footer) Corresponds to the Standard doclet's -footer parameter.
T	setHeader(String header) Corresponds to the Standard doclet's -header parameter.
T	setHelpFile(Object o) Corresponds to the Standard doclet's -helpfile parameter.
T	setKeywords(boolean b) Corresponds to the Standard doclet's -keywords flag.
T	setLinkSource(boolean b) Corresponds to the Standard doclet's -linksource flag.
T	setSerialWarn(boolean b) Corresponds to the Standard doclet's -serialwarn flag.
T	setSplitIndex(boolean b) Corresponds to the Standard doclet's -splitindex flag.
T	setStylesheetFile(Object o) Corresponds to the Standard doclet's -stylesheetfile flag.
T	setUse(boolean b) Corresponds to the Standard doclet's -use flag.
T	setVersion(boolean b) Corresponds to the Standard doclet's -version flag.
T	setWindowTitle(String title) Corresponds to the Standard doclet's -windowtitle parameter.

Methods inherited from interface org.schmant.task.ValidatingDecorator

validate

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

setTarget

Method Detail

setUse

T setUse(boolean b)

Corresponds to the Standard doclet's -use flag.

The default value for this property is false.

Parameters:

b - Generate usage pages for each documented class and package?

Returns:

this.

setVersion

T setVersion(boolean b)

Corresponds to the Standard doclet's -version flag.

The default value for this property is false.

Parameters:

b - Should version information be included?

Returns:

this

setAuthor

T setAuthor(boolean b)

Corresponds to the Standard doclet's -author flag.

The default value for this property is false.

Parameters:

b - Should author information be included?

Returns:

this

setSplitIndex

T setSplitIndex(boolean b)

Corresponds to the Standard doclet's -splitindex flag.

The default value for this property is false.

Parameters:

b - Should the index file be split into multiple files?

Returns:

this

setWindowTitle

T setWindowTitle(String title)

Corresponds to the Standard doclet's -windowtitle parameter.

The default value for this property is the value of the docTitle property. (See setDocTitle(String).)

Parameters:

title - The value of the HTML title tag in the generated documentation.

Returns:

this

See Also:

setDocTitle(String)

setDocTitle

T setDocTitle(String title)

Corresponds to the Standard doclet's -doctitle parameter.

The default value for this property is empty.

Parameters:

title - The title for the overview summary file in the documentation.

Returns:

this

See Also:

setWindowTitle(String)

setHeader

T setHeader(String header)

Corresponds to the Standard doclet's -header parameter.

The default value for this property is empty.

Parameters:

header - The header placed at the top of each generated file.

Returns:

this

setFooter

T setFooter(String footer)

Corresponds to the Standard doclet's -footer parameter.

The default value for this property is empty.

Parameters:

footer - The footer text placed at the bottom of each generated file.

Returns:

this

setBottom

T setBottom(String bottom)

Corresponds to the Standard doclet's -bottom parameter.

The default value for this property is empty.

Parameters:

bottom - The text placed at the bottom of each generated file.

Returns:

this

addLink

T addLink(String l)

Corresponds to the Standard doclet's -link parameter.

The default value for this property is empty.

Parameters:

l - An URL for external API documentation.

Returns:

this

addLinks

T addLinks(Object o)

Add a collection of links to the Standard doclet. This corresponds to using the -link parameter for each link in the collection.

Parameters:

o - A collection of links.

Returns:

this

addOfflineLink

T addOfflineLink(String l)

Corresponds to the Standard doclet's -linkoffline parameter.

The default value for this property is empty.

Parameters:

l - An URL for external API documentation.

Returns:

this

addOfflineLinks

T addOfflineLinks(Object o)

Add a collection of links. This corresponds to using the -offlinelink parameter for each link in the collection.

Parameters:

o - A collection of links.

Returns:

this

setLinkSource

T setLinkSource(boolean b)

Corresponds to the Standard doclet's -linksource flag.

The default value for this property is false.

Parameters:

b - Should a HTML version of each source file be generated?

Returns:

this

addGroup

T addGroup(String heading,
           String packages)

Add one package group. Corresponds to the Standard doclet's -group parameter.

Parameters:

heading - The group name.

packages - The packages included in the group.

Returns:

this

addGroup

T addGroup(JavadocPackageGroup pg)

Add one package group. Corresponds to the Standard doclet's -group parameter.

Parameters:

pg - The package group.

Returns:

this

addGroups

T addGroups(Object o)

Add a collection of package groups. Corresponds to giving the Standard doclet's -group parameter for each object in the collection.

Parameters:

o - The collection

Returns:

this

disableDeprecated

T disableDeprecated(boolean b)

Corresponds to the Standard doclet's -nodeprecated flag.

The default value for this property is false.

Parameters:

b - Should the generation of documentation for deprecated items be disabled?

Returns:

this

disableDeprecatedList

T disableDeprecatedList(boolean b)

Corresponds to the Standard doclet's -nodeprecatedlist flag.

The default value for this property is false.

Parameters:

b - Should the generation of the deprecation list file (deprecated-list.html) be disabled?

Returns:

this

disableSince

T disableSince(boolean b)

Corresponds to the Standard doclet's -nosince flag.

The default value for this property is false.

Parameters:

b - Should the @since tag be ignored?

Returns:

this

disableTree

T disableTree(boolean b)

Corresponds to the Standard doclet's -notree flag.

The default value for this property is false.

Parameters:

b - Should the generation of class/interface hierarchy pages be disabled?

Returns:

this

disableIndex

T disableIndex(boolean b)

Corresponds to the Standard doclet's -noindex flag.

The default value for this property is false.

Parameters:

b - Should the generation of the documentation index page be disabled?

Returns:

this

disableHelp

T disableHelp(boolean b)

Corresponds to the Standard doclet's -nohelp flag.

The default value for this property is false.

Parameters:

b - Should the HELP link be disabled?

Returns:

this

disableNavbar

T disableNavbar(boolean b)

Corresponds to the Standard doclet's -nonavbar flag.

The default value for this property is false.

Parameters:

b - Should the generation of the navigation bar be disabled?

Returns:

this

setHelpFile

T setHelpFile(Object o)

Corresponds to the Standard doclet's -helpfile parameter.

Set the path to an external help file. The path is interpreted by InterpretAsFileStrategy.

The default value for this property is empty.

Parameters:

o - The path to a help file.

Returns:

this

setStylesheetFile

T setStylesheetFile(Object o)

Corresponds to the Standard doclet's -stylesheetfile flag.

Set the path to an external stylesheet (CSS) file. The path is interpreted by InterpretAsFileStrategy.

The default value for this property is empty.

Parameters:

o - The path to an external stylesheet file.

Returns:

this

setSerialWarn

T setSerialWarn(boolean b)

Corresponds to the Standard doclet's -serialwarn flag.

The default value for this property is false.

Parameters:

b - Should the Javadoc compiler warn on missing @serial tags?

Returns:

this

setCharset

T setCharset(String name)

Corresponds to the Standard doclet's -charset parameter.

The default value for this property is empty.

Parameters:

name - The MIME name for a charset.

Returns:

this

See Also:

setDocEncoding(String)

setDocEncoding

T setDocEncoding(String name)

Corresponds to the Standard doclet's -docencoding parameter.

The default value for this property is empty.

Parameters:

name - The MIME name for a charset.

Returns:

this

See Also:

setCharset(String)

setKeywords

T setKeywords(boolean b)

Corresponds to the Standard doclet's -keywords flag.

The default value for this property is false.

Parameters:

b - Should HTML META tag keywords be added for each class?

Returns:

this

setDocFilesSubdirs

T setDocFilesSubdirs(boolean b)

Corresponds to the Standard doclet's -docfilessubdirs flag.

The default value for this property is false.

Parameters:

b - Enable deep copying of doclet files?

Returns:

this

addExcludeDocFilesSubdir

T addExcludeDocFilesSubdir(String name)

Corresponds to one segment of the Standard doclet's -excludedocfilessubdir parameter.

Parameters:

name - A doc file subdir to exclude.

Returns:

this

addExcludeDocFilesSubdirs

T addExcludeDocFilesSubdirs(Object o)

Corresponds to setting a segment of the Standard doclet's -excludedocfilessubdir parameter for each object in the collection.

Parameters:

o - A collection of doc files subdirs to exclude.

Returns:

this

addNoQualifierPackage

T addNoQualifierPackage(String name)

Corresponds to one segment of the Standard doclet's -noqualifier parameter.

Parameters:

name - A name for a package that should not be fully qualified in the documentation.

Returns:

this

addNoQualifierPackages

T addNoQualifierPackages(Object o)

Corresponds to setting a segment of the Standard doclet's -noqualifier parameter for each object in the collection.

Parameters:

o - A collection of names.

Returns:

this

disableTimestamp

T disableTimestamp(boolean b)

Corresponds to the Standard doclet's -notimestamp flag.

The default value for this property is false.

Parameters:

b - Disable the timestamp hidden in each documentation file?

Returns:

this

disableComment

T disableComment(boolean b)

Corresponds to the Standard doclet's -nocomment flag.

The default value for this property is false.

Parameters:

b - Disable the entire comment body?

Returns:

this