Uses of Interface
com.asakusafw.utils.java.parser.javadoc.JavadocScanner

Packages that use JavadocScanner

Package	Description
com.asakusafw.utils.java.parser.javadoc	Parses Java documentation comments and converts them to Java DOMs.

Uses of JavadocScanner in com.asakusafw.utils.java.parser.javadoc

Classes in com.asakusafw.utils.java.parser.javadoc that implement JavadocScanner

Modifier and Type	Class and Description
class	DefaultJavadocScanner A basic implementation of JavadocScanner.

Methods in com.asakusafw.utils.java.parser.javadoc that return JavadocScanner

Modifier and Type	Method and Description
JavadocScanner	JavadocBlockInfo.getBlockScanner() Returns the scanner which provides the block contents.

Methods in com.asakusafw.utils.java.parser.javadoc with parameters of type JavadocScanner

Modifier and Type	Method and Description
static int	JavadocScannerUtil.consumeLineEnd(JavadocScanner scanner, boolean multiline) Consumes the next line-break, and its consequent white-space, and asterisk tokens.
static int	JavadocScannerUtil.countUntil(Collection<JavadocTokenKind> kinds, JavadocScanner scanner, int start) Returns the number of tokens from the starting index until each token has the specified kind.
static int	JavadocScannerUtil.countUntilBlockEnd(JavadocScanner scanner, int start) Returns the number of tokens from the starting index until the current block was closed.
static int	JavadocScannerUtil.countUntilCommentEnd(JavadocScanner scanner, boolean returnMinusIfMissing, int start) Returns the number of tokens from the starting index until the end of this comment.
static int	JavadocScannerUtil.countUntilNextLineStart(JavadocScanner scanner, int start) Returns the number of tokens from the starting index until the next printable token on the subsequent lines.
static int	JavadocScannerUtil.countUntilNextPrintable(JavadocScanner scanner, int start) Returns the number of tokens from the starting index until the next printable token.
static int	JavadocScannerUtil.countWhile(Collection<JavadocTokenKind> kinds, JavadocScanner scanner, int start) Returns the number of tokens from the starting index while each token has the specified kind.
static int	JavadocBlockParserUtil.countWhileTagName(JavadocScanner scanner, int start) Returns the number of tokens in the current block body.
IrDocBasicType	JavadocBlockParser.fetchBasicType(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded basic type.
static IrDocBasicType	JavadocBlockParserUtil.fetchBasicType(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded basic type.
static JavadocBlockInfo	JavadocBlockParserUtil.fetchBlockInfo(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded inline block.
IrDocField	JavadocBlockParser.fetchField(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded field.
static IrDocField	JavadocBlockParserUtil.fetchField(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded field.
IrDocFragment	JavadocBlockParser.fetchLinkTarget(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded link target.
static IrDocFragment	JavadocBlockParserUtil.fetchLinkTarget(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded link target.
IrDocMethod	JavadocBlockParser.fetchMethod(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded method or constructor.
static IrDocMethod	JavadocBlockParserUtil.fetchMethod(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded method or constructor.
IrDocName	JavadocBlockParser.fetchName(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded (simple or qualified) name.
static IrDocName	JavadocBlockParserUtil.fetchName(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded (simple or qualified) name.
IrDocNamedType	JavadocBlockParser.fetchNamedType(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded named type.
static IrDocNamedType	JavadocBlockParserUtil.fetchNamedType(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded named type.
IrDocBasicType	JavadocBlockParser.fetchPrimitiveType(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded primitive type.
static IrDocBasicType	JavadocBlockParserUtil.fetchPrimitiveType(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded primitive type.
List<IrDocFragment>	JavadocBlockParser.fetchRestFragments(JavadocScanner scanner) Consumes all tokens from the scanner, and converts them to a list of IrDocFragments.
IrDocSimpleName	JavadocBlockParser.fetchSimpleName(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded simple name.
static IrDocSimpleName	JavadocBlockParserUtil.fetchSimpleName(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded simple name.
static IrDocText	JavadocBlockParserUtil.fetchText(JavadocScanner scanner, boolean trimHead, boolean trimTail) Consumes tokens from the scanner and returns the corresponded plain text.
IrDocType	JavadocBlockParser.fetchType(JavadocScanner scanner) Consumes tokens from the scanner and returns the corresponded type.
static IrDocType	JavadocBlockParserUtil.fetchType(JavadocScanner scanner, Set<JavadocTokenKind> follow) Consumes tokens from the scanner and returns the corresponded type.
static List<JavadocToken>	JavadocScannerUtil.lookaheadTokens(JavadocScanner scanner, int start, int count) Returns the a sequence of tokens.
IrDocComment	JavadocParser.parse(JavadocScanner scanner) Parses the documentation comments.
IrDocBlock	FollowsReferenceBlockParser.parse(String tag, JavadocScanner scanner)
IrDocBlock	SerialFieldBlockParser.parse(String tag, JavadocScanner scanner)
IrDocBlock	ParamBlockParser.parse(String tag, JavadocScanner scanner)
IrDocBlock	FollowsNamedTypeBlockParser.parse(String tag, JavadocScanner scanner)
IrDocBlock	DefaultJavadocBlockParser.parse(String tag, JavadocScanner scanner)
abstract IrDocBlock	JavadocBlockParser.parse(String tag, JavadocScanner scanner) Parses a block.
IrDocBlock	JavadocParser.parseBlock(JavadocScanner scanner) Parses a block.

Constructors in com.asakusafw.utils.java.parser.javadoc with parameters of type JavadocScanner

Constructor and Description
DefaultJavadocTokenStream(JavadocScanner scanner) Creates a new instance.