com.gemstone.gemfire

Class UnitTestDoclet

java.lang.Object

com.gemstone.gemfire.UnitTestDoclet

public class UnitTestDoclet
extends Object

This class is a Javadoc doclet that generates a text file that summarizes unit test classes and methods.

Since:

3.0

See Also:

Doclet

Constructor Summary

Constructors

Constructor and Description
UnitTestDoclet()

Method Summary

Modifier and Type	Method and Description
static void	document(com.sun.javadoc.ClassDoc c, PrintWriter pw) Summarizes the test methods of the given class
static int	optionLength(String option) Returns the number of arguments for the given command option (include the option itself)
static boolean	start(com.sun.javadoc.RootDoc root) The entry point for the doclet
static boolean	validOptions(String[][] options, com.sun.javadoc.DocErrorReporter reporter)

Methods inherited from class java.lang.Object

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

Constructor Detail

UnitTestDoclet

public UnitTestDoclet()

Method Detail

optionLength

public static int optionLength(String option)

Returns the number of arguments for the given command option (include the option itself)

validOptions

public static boolean validOptions(String[][] options,
                                   com.sun.javadoc.DocErrorReporter reporter)

start

public static boolean start(com.sun.javadoc.RootDoc root)

The entry point for the doclet

document

public static void document(com.sun.javadoc.ClassDoc c,
                            PrintWriter pw)
                     throws IOException

Summarizes the test methods of the given class

Throws:

IOException