org.incava.javadoc
Class JavadocParser

java.lang.Object
  extended by org.incava.javadoc.JavadocParser

public class JavadocParser
extends java.lang.Object

Parses Javadoc into a list of points, which represent the locations of description and tagged comments in a Javadoc comment block.


Constructor Summary
JavadocParser()
           
 
Method Summary
 java.util.List parse(java.lang.String text)
          Parses the Javadoc in the text.
 java.util.List parse(java.lang.String text, int startLine, int startColumn)
           
protected  void read(java.awt.Point pt)
          Reads to the next Javadoc field, or to the end of the comment.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

JavadocParser

public JavadocParser()
Method Detail

parse

public java.util.List parse(java.lang.String text)
Parses the Javadoc in the text. Assumes a start line of 1 and a start column of 1.


parse

public java.util.List parse(java.lang.String text,
                            int startLine,
                            int startColumn)

read

protected void read(java.awt.Point pt)
Reads to the next Javadoc field, or to the end of the comment.