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 |
---|---|
SourceDocBlockTag |
SourceFactory.createDocBlockTag(SourceDocTagName name)
Creates a doc block tag.
|
SourceDocBlockTag |
SourceFactory.createDocBlockTag(SourceDocTagName name, SourceDocDescription description)
Creates a doc block tag with no references.
|
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 SourceDocBlockTag |
SourceFactory.createDocBlockTagFromText(java.lang.String text)
Attempts to create a doc block tag with the given text.
|
Modifier and Type | Method and Description |
---|---|
SourceDocComment |
SourceFactory.createDocComment(SourceDocDescription description, SourceDocBlockTag tag)
Creates a doc comment with the given description and block tags.
|
abstract SourceDocComment |
SourceFactory.createDocComment(SourceDocDescription description, SourceDocBlockTag[] tags)
Creates a doc comment with the given description and block tags.
|
Modifier and Type | Field and Description |
---|---|
static SourceDocBlockTag[] |
SourceDocBlockTag.EMPTY_ARRAY |
Modifier and Type | Method and Description |
---|---|
SourceDocBlockTag |
SourceDocComment.findExceptionTag(java.lang.String exceptionName)
Finds the first
@exception or @throws tag in this doc comment with a specified fully-qualified name. |
SourceDocBlockTag |
SourceDocComment.findParameterTag(java.lang.String parameterName)
Finds the first
@param tag in this doc comment with a specified name. |
Modifier and Type | Method and Description |
---|---|
java.util.Collection<SourceDocBlockTag> |
SourceDocComment.findExceptionTags()
Finds the
@exception or @throws tags in this doc comment. |
java.util.List<SourceDocBlockTag> |
SourceDocComment.getBlockTags()
Gets the block tags from this doc comment.
|
Modifier and Type | Method and Description |
---|---|
void |
SourceVisitor.whenEnterDocBlockTag(SourceDocBlockTag sourceDocBlockTag) |
void |
SourceVisitor.whenExitDocBlockTag(SourceDocBlockTag sourceDocBlockTag) |