| Package | Description |
|---|---|
| oracle.javatools.parser.java.v2 |
The parser API.
|
| oracle.javatools.parser.java.v2.model.doc |
The parser model API for doc elements.
|
| oracle.javatools.parser.java.v2.util |
Various utilities for use with the parser.
|
| Modifier and Type | Method and Description |
|---|---|
SourceDocReference |
SourceFactory.createDocClassReference(java.lang.String qualifiedName)
Creates a doc reference with the class reference syntax.
|
SourceDocReference |
SourceFactory.createDocMemberReference(java.lang.String classString,
java.lang.String memberName)
Creates a doc reference with the member reference syntax.
|
abstract SourceDocReference |
SourceFactory.createDocMemberReferenceFromText(java.lang.String text)
Attempts to create a doc member reference with the given text.
|
SourceDocReference |
SourceFactory.createDocMethodReference(java.lang.String classString,
java.lang.String methodName,
java.lang.String[] parameterTypes)
Creates a doc reference with the method reference syntax.
|
abstract SourceDocReference |
SourceFactory.createDocParameterReference(java.lang.String parameterName)
Creates a doc reference with the parameter syntax.
|
abstract SourceDocReference |
SourceFactory.createDocReference(java.lang.String classString,
java.lang.String memberName,
java.lang.String[] parameterTypes)
Creates a doc reference.
|
| Modifier and Type | Method and Description |
|---|---|
abstract SourceDocBlockTag |
SourceFactory.createDocBlockTag(SourceDocTagName name,
SourceDocReference[] references,
SourceDocDescription description)
Creates a doc block tag with many references.
|
SourceDocBlockTag |
SourceFactory.createDocBlockTag(SourceDocTagName name,
SourceDocReference reference,
SourceDocDescription description)
Creates a doc block tag with one reference.
|
abstract SourceDocInlineTag |
SourceFactory.createDocInlineTag(SourceDocTagName name,
SourceDocReference[] references,
SourceDocDescription description)
Creates a doc inline tag with many references.
|
SourceDocInlineTag |
SourceFactory.createDocInlineTag(SourceDocTagName name,
SourceDocReference reference,
SourceDocDescription description)
Creates a doc inline tag with one reference.
|
| Modifier and Type | Field and Description |
|---|---|
static SourceDocReference[] |
SourceDocReference.EMPTY_ARRAY |
| Modifier and Type | Method and Description |
|---|---|
SourceDocReference |
SourceDocTag.getFieldNameReference()
Gets the field name reference argument of this tag, or null if this is
not a
@serialField tag. |
SourceDocReference |
SourceDocTag.getFieldTypeReference()
Gets the field type refernce argument of this tag, or null if this is
not a
@serialField tag. |
SourceDocReference |
SourceDocTag.getReference()
Gets the reference argument of this tag, or null if this is not an
@exception, @link, @linkplain,
@param, @see, @throws, or
two-argument @value tag. |
| Modifier and Type | Method and Description |
|---|---|
java.util.Collection<SourceDocReference> |
SourceDocElement.getReferences()
Gets the references from this element.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Usages.useFieldInDocComment(SourceDocReference s,
JavaField field)
Usage of a field or enum constant in a doc comment.
|
void |
Usages.useMethodInDocComment(SourceDocReference s,
JavaMethod method)
Usage of a method or constructor in a doc comment.
|
void |
Usages.useParameterInDocComment(SourceDocReference s,
JavaLocalVariable parameter)
Usage of a local variable or formal parameter in an expression.
|
void |
Usages.useTypeInDocComment(SourceDocReference s,
JavaType type)
Usage of a type in a doc comment.
|
void |
SourceVisitor.whenEnterDocReference(SourceDocReference sourceDocReference) |
void |
SourceVisitor.whenExitDocReference(SourceDocReference sourceDocReference) |