Package edu.pdx.cs410J.grader

Class APIDocumentationDoclet

java.lang.Object

edu.pdx.cs410J.grader.APIDocumentationDoclet

All Implemented Interfaces:

Doclet

public class APIDocumentationDoclet
extends Object
implements Doclet

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 (rewritten for Java 9 API in Summer 2018)

Author:

David Whitlock

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Doclet

Doclet.Option

Constructor Summary

Constructors

Constructor	Description
APIDocumentationDoclet()

Method Summary

Modifier and Type	Method	Description
String	getName()
Set<? extends Doclet.Option>	getSupportedOptions()
SourceVersion	getSupportedSourceVersion()
(package private) static void	indent(String text, int indent, PrintWriter pw)	Indents a block of text a given amount.
void	init(Locale locale, Reporter reporter)
(package private) static String	removePackageNames(String name)
boolean	run(DocletEnvironment environment)

Methods inherited from class java.lang.Object

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

Constructor Details

APIDocumentationDoclet

public APIDocumentationDoclet()

Method Details

removePackageNames

static String removePackageNames(String name)

init

public void init(Locale locale,
 Reporter reporter)

Specified by:

init in interface Doclet

getName

public String getName()

Specified by:

getName in interface Doclet

getSupportedOptions

public Set<? extends Doclet.Option> getSupportedOptions()

Specified by:

getSupportedOptions in interface Doclet

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Doclet

indent

static void indent(String text,
 int indent,
 PrintWriter pw)

Indents a block of text a given amount.

run

public boolean run(DocletEnvironment environment)

Specified by:

run in interface Doclet