edu.pdx.cs399J.grader
Class APIDocumentationDoclet

java.lang.Object
  edu.pdx.cs399J.grader.APIDocumentationDoclet

public class APIDocumentationDoclet
extends Object

This doclet extracts the API documentation (Javadocs) from a student's project submission and produces a text summary of them. It is used for grading a student's Javadocs.

Since:

Summer 2004

Version:

$Revision: 1.1 $

Author:

David Whitlock

Constructor Summary

APIDocumentationDoclet()

Method Summary

static int	optionLength(String option) Since there are no options, we always return zero.
static boolean	start(RootDoc root) Print out a summary of each class, field, and method to standard out.
static boolean	validOptions(String[][] options, DocErrorReporter reporter) This doclet has no valid options

Methods inherited from class java.lang.Object

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

Constructor Detail

APIDocumentationDoclet

public APIDocumentationDoclet()

Method Detail

validOptions

public static boolean validOptions(String[][] options,
                                   DocErrorReporter reporter)

This doclet has no valid options

optionLength

public static int optionLength(String option)

Since there are no options, we always return zero.

start

public static boolean start(RootDoc root)

Print out a summary of each class, field, and method to standard out.