Skip navigation links
C E I N O P R S T U V 

C

compareTo(RequireJavadoc.Undocumented) - Method in class org.plumelib.javadoc.RequireJavadoc.Undocumented
Not consistent with equals.

E

errors - Variable in class org.plumelib.javadoc.RequireJavadoc
All the errors this doclet will report.

I

isEnumValuesOrValueOf(MethodDoc) - Method in class org.plumelib.javadoc.RequireJavadoc
Return true if the method is values or valueOf for an enum.
isOverride(MethodDoc) - Method in class org.plumelib.javadoc.RequireJavadoc
Return true if this method is annotated with @Override.
isSyntheticForNestedConstructor(ConstructorDoc) - Method in class org.plumelib.javadoc.RequireJavadoc
Return true if this method is a synthetic default constructor.

N

name - Variable in class org.plumelib.javadoc.RequireJavadoc.Undocumented
The identifier that is not documented.

O

optionLength(String) - Static method in class org.plumelib.javadoc.RequireJavadoc
Given a command-line option of this doclet, returns the number of arguments you must specify on the command line for the given option.
org.plumelib.javadoc - package org.plumelib.javadoc
 

P

packages - Variable in class org.plumelib.javadoc.RequireJavadoc
All packages that have been seen and checked so far.
position - Variable in class org.plumelib.javadoc.RequireJavadoc.Undocumented
The position (file and line number) where it is defined.
processClass(ClassDoc) - Method in class org.plumelib.javadoc.RequireJavadoc
Require documentation of the given class and its package.

R

relativePaths - Static variable in class org.plumelib.javadoc.RequireJavadoc
If true, print filenames relative to working directory.
requireCommentText(Doc) - Method in class org.plumelib.javadoc.RequireJavadoc
Require a documentation string for the given Java element.
RequireJavadoc - Class in org.plumelib.javadoc
A Javadoc doclet that issues an error for any package, class, method, or field that lacks a Javadoc comment.
RequireJavadoc() - Constructor for class org.plumelib.javadoc.RequireJavadoc
Creates a new RequireJavadoc instance.
RequireJavadoc.Undocumented - Class in org.plumelib.javadoc
An undocumented identifier and the file and line number where it appears.

S

skip - Static variable in class org.plumelib.javadoc.RequireJavadoc
If non-null, matches classes where no problems should be reported.
start(RootDoc) - Static method in class org.plumelib.javadoc.RequireJavadoc
The entry point to this doclet.

T

toString() - Method in class org.plumelib.javadoc.RequireJavadoc.Undocumented
 

U

Undocumented(String, SourcePosition) - Constructor for class org.plumelib.javadoc.RequireJavadoc.Undocumented
Create a new Undocumented.
USAGE - Static variable in class org.plumelib.javadoc.RequireJavadoc
 

V

validOptions(String[][], DocErrorReporter) - Static method in class org.plumelib.javadoc.RequireJavadoc
Tests the validity of command-line arguments passed to this doclet.
C E I N O P R S T U V 
Skip navigation links