com.asakusafw.utils.java.parser.javadoc

Class JavadocParser

java.lang.Object

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

com.asakusafw.utils.java.parser.javadoc.JavadocParser

public final class JavadocParser
extends JavadocBaseParser

A parser for Java documentation comments.

Constructor Summary

Constructors

Constructor and Description
JavadocParser(List<? extends JavadocBlockParser> blockParsers) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
IrDocComment	parse(JavadocScanner scanner) Parses the documentation comments.
IrDocBlock	parseBlock(JavadocScanner scanner) Parses a block.

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

JavadocParser

public JavadocParser(List<? extends JavadocBlockParser> blockParsers)

Creates a new instance.

Parameters:

blockParsers - the block parsers

Throws:

IllegalArgumentException - if the parameter is null

Method Detail

parse

public IrDocComment parse(JavadocScanner scanner)
                   throws JavadocParseException

Parses the documentation comments.

Parameters:

scanner - the source scanner

Returns:

the analyzed element

Throws:

JavadocParseException - if the documentation comment is malformed

IllegalArgumentException - if the parameter is null

parseBlock

public IrDocBlock parseBlock(JavadocScanner scanner)
                      throws JavadocParseException

Parses a block.

Parameters:

scanner - the source scanner

Returns:

the analyzed block

Throws:

JavadocParseException - if the block is malformed

IllegalArgumentException - if the parameter is null