com.asakusafw.utils.java.parser.javadoc

Class ParamBlockParser

java.lang.Object

com.asakusafw.utils.java.parser.javadoc.JavadocBaseParser

com.asakusafw.utils.java.parser.javadoc.JavadocBlockParser

com.asakusafw.utils.java.parser.javadoc.AcceptableJavadocBlockParser

com.asakusafw.utils.java.parser.javadoc.ParamBlockParser

public class ParamBlockParser
extends AcceptableJavadocBlockParser

An implementation of JavadocBaseParser which parses param blocks.

Constructor Summary

Constructors

Constructor and Description
ParamBlockParser() Creates a new instance.
ParamBlockParser(String tagName, String... tagNames) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
IrDocBlock	parse(String tag, JavadocScanner scanner) Parses a block.

Methods inherited from class com.asakusafw.utils.java.parser.javadoc.AcceptableJavadocBlockParser

canAccept

Methods inherited from class com.asakusafw.utils.java.parser.javadoc.JavadocBlockParser

fetchBasicType, fetchField, fetchLinkTarget, fetchMethod, fetchName, fetchNamedType, fetchPrimitiveType, fetchRestFragments, fetchSimpleName, fetchType, newBlock

Methods inherited from class com.asakusafw.utils.java.parser.javadoc.JavadocBaseParser

getBlockParsers, parseBlock, setBlockParsers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParamBlockParser

public ParamBlockParser()

Creates a new instance.

ParamBlockParser

public ParamBlockParser(String tagName,
                        String... tagNames)

Creates a new instance.

Parameters:

tagName - the first acceptable tag name

tagNames - the rest acceptable tag names

Method Detail

parse

public IrDocBlock parse(String tag,
                        JavadocScanner scanner)
                 throws JavadocParseException

Description copied from class: JavadocBlockParser

Parses a block. The scanner will provides contents of the target block (without its block tag).

Specified by:

parse in class JavadocBlockParser

Parameters:

tag - the target tag name (without "@"), or null for synopsis blocks

scanner - the scanner for providing block contents

Returns:

the parsed block

Throws:

JavadocParseException - if error occurred while parsing the target block