Javadoc tool for parameterized java (JSR-14, aka "Java 1.5").
See: Description
| Interface Summary | |
|---|---|
| ArrayType |
The ArrayType interface represents a java array type.
|
| ClassDoc |
The ClassDoc interface represents a java class and
raw type and provides access to information about the class, the
class' comment and tags, and the members of the class. |
| ClassType |
The ClassType interface represents a concrete java class or
primitive data type. |
| ClassTypeVariable |
The ClassTypeVariable interface represents a type variable
declared as a formal parameter to a generic class or interface.
|
| ConstructorDoc |
The ConstructorDoc interface represents a constructor of
a java class.
|
| Doc |
The Doc class is the abstract base class representing
all java language constructs (classes, packages, methods, etc) which
have comments and have been processed by this run of SinjDoc. |
| DocErrorReporter |
The DocErrorReporter interface provides error, warning, and
notice printing.
|
| ExecutableMemberDoc |
The ExecutableMemberDoc class represents a method or
constructor of a java class.
|
| FieldDoc |
The FieldDoc class represents a field in a java class.
|
| MemberDoc |
The MemberDoc class represents a member of a java class:
field, constructor, or method. |
| MethodDoc |
The MethodDoc class represents a (non-constructor) member of
a java class.
|
| MethodTypeVariable |
The MethodTypeVariable interface represents a type
variable declared as a formal parameter to a generic method.
|
| PackageDoc |
The PackageDoc class represents a java package. |
| Parameter |
The Parameter interface represents parameter information,
including parameter type and parameter name.
|
| ParameterizedType |
The ParameterizedType interface represents a parameterized
type such as Collection<Integer> or
HashMap<String,Double>.
|
| ParamTag |
The ParamTag class represents a @param documentation tag.
|
| ProgramElementDoc |
The ProgramElementDoc class represents a java program
element: class, interface, field, constructor, or method. |
| RootDoc |
The RootDoc class holds the information from one run of
SinjDoc; in particular the packages, classes, and options specified by
the user.
|
| SeeTag |
The SeeTag class represents a "see also" documentation
tag. |
| SerialFieldTag |
The SerialFieldTag class documents a Serializable field
defined by an ObjectStreamField.
|
| SourcePosition |
The SourcePosition interface describes a source position:
filename, line number, and column number.
|
| Tag |
The Tag class represents a documentation tag. |
| ThrowsTag |
The ThrowsTag class represents a @throws or @exception
documentation tag.
|
| Type |
The Type interface represents a java type. |
| TypeArgument |
A TypeArgument is either a type or a wildcard
specification such as "? extends Number",
"? super Integer", or "?".
|
| TypeVariable |
The TypeVariable interface represents a type
variable declared as a formal parameter to a generic class,
interface, or method. |
| Class Summary | |
|---|---|
| Doclet |
The Doclet class provides the entry-point methods for
a documentation generator.
|
| Main |
Main implements a javadoc-alike that properly handles
JSR-14 java code (-source 1.5). |
| TagVisitor<T> |
TagVisitor implements the visitor pattern for Tag
objects. |
| TypeVisitor<T> |
TypeVisitor implements the visitor pattern for
objects representing Types. |
java net.cscott.sinjdoc.Main.