protoj.lang.internal.ant
Class JavadocTask

java.lang.Object
  protoj.lang.internal.ant.JavadocTask

public final class JavadocTask
extends java.lang.Object

A convenience class for creating javadocs. Use the constructors to specify the minimal and most widely anticipated configuration and the initXXX methods for the less common configuration options.

Author:

Ashley Williams

Field Summary

static java.lang.String

ERROR

Constructor Summary

JavadocTask(java.io.File srcDir, java.io.File destDir)
Accepts the information required for creating javadocs.

Method Summary

void	execute()
org.apache.tools.ant.taskdefs.Javadoc	getjavadoc()
org.apache.tools.ant.types.DirSet	getPackageSet() A reference to the package set added to the javadoc ant task.
void	initDefault(java.lang.String memory) Ensures that all packages are included in the javadoc execution and that default excludes are applied.
void	initLogging(java.io.File logFile) Enables logging to the specified log file at Project.MSG_INFO level.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ERROR

public static final java.lang.String ERROR

See Also:

Constant Field Values

Constructor Detail

JavadocTask

public JavadocTask(java.io.File srcDir,
                   java.io.File destDir)

Accepts the information required for creating javadocs.

Parameters:

srcDir -

destDir -

Method Detail

initDefault

public void initDefault(java.lang.String memory)

Ensures that all packages are included in the javadoc execution and that default excludes are applied.

Parameters:

memory - the maximum amount of memory to allocate to the javadoc vm.

execute

public void execute()

getPackageSet

public org.apache.tools.ant.types.DirSet getPackageSet()

A reference to the package set added to the javadoc ant task.

Returns:

getjavadoc

public org.apache.tools.ant.taskdefs.Javadoc getjavadoc()

initLogging

public void initLogging(java.io.File logFile)

Enables logging to the specified log file at Project.MSG_INFO level.

Parameters:

logFile -