com.asakusafw.utils.java.parser.javadoc

Class JavadocConverter

java.lang.Object

com.asakusafw.utils.java.parser.javadoc.JavadocConverter

public class JavadocConverter
extends Object

Converts IrDocComment models into Java DOM models.

Constructor Summary

Constructors

Constructor and Description
JavadocConverter(ModelFactory factory) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
Javadoc	convert(String content, int offset) Analyzes the documentation comment string and returns the corresponded Javadoc object.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavadocConverter

public JavadocConverter(ModelFactory factory)

Creates a new instance.

Parameters:

factory - the Java DOM factory

Throws:

IllegalArgumentException - if the parameter is null

Method Detail

convert

public Javadoc convert(String content,
                       int offset)
                throws JavadocParseException

Analyzes the documentation comment string and returns the corresponded Javadoc object.

Parameters:

content - the documentation content

offset - the starting character offset of the comment string in the compilation unit

Returns:

the analyzed object

Throws:

JavadocParseException - if the documentation comment is malformed

IllegalArgumentException - if the parameter is null