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 |
---|---|
SourceDocDescription |
SourceFactory.createDocDescription()
Creates an empty doc description.
|
SourceDocDescription |
SourceFactory.createDocDescription(SourceDocTextFragment line)
Creates a doc description with a single line of text.
|
abstract SourceDocDescription |
SourceFactory.createDocDescription(SourceDocTextFragment[] lines)
Creates a doc description from the input lines of text.
|
Modifier and Type | Method and Description |
---|---|
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.
|
SourceDocComment |
SourceFactory.createDocComment(SourceDocDescription description)
Creates a doc comment with the given 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.
|
SourceDocInlineTag |
SourceFactory.createDocInlineTag(SourceDocTagName name,
SourceDocDescription description)
Creates a doc inline tag with no references.
|
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 | Method and Description |
---|---|
SourceDocDescription |
SourceDocHasDescription.getDescription()
Gets the description argument of this tag, or null for a tag with
no description.
|
SourceDocDescription |
SourceDocComment.getDescription()
Gets the main description, the text before the first block tag,
from this doc comment.
|
Modifier and Type | Method and Description |
---|---|
void |
SourceDocHasDescription.setDescription(SourceDocDescription description)
Sets the description argument of this tag.
|
Modifier and Type | Method and Description |
---|---|
void |
SourceVisitor.whenEnterDocDescription(SourceDocDescription sourceDocDescription) |
void |
SourceVisitor.whenExitDocDescription(SourceDocDescription sourceDocDescription) |