com.whitestein.lsps.lang.doc

Class DocCommentParser

java.lang.Object

com.whitestein.lsps.lang.doc.DocCommentParser

public class DocCommentParser
extends Object

A documentation comment parser.

Note: This class is not thread-safe!

Author:

jsa

See Also:

parse(String)

Constructor Summary

Constructors

Constructor and Description
DocCommentParser()

Method Summary

Modifier and Type	Method and Description
Doc	parse(String comment) Parses the documentation comment and produces a structured representation of the documentation.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocCommentParser

public DocCommentParser()

Method Detail

parse

public Doc parse(String comment)

Parses the documentation comment and produces a structured representation of the documentation. The structure of the comment must be the following:

• Description
• Tags:
  • Tag1
  • Tag2
  • ...

Tags can be:

• inline: {@code}, {@link ...}
• block: @param, @return, @throws

Other tags will be ignored.

Example:

 /**
  * Returns the character at the given index
  *
  * @param str1 the string
  * @param index the character index
  *
  * @return the character at {@code index}
  *
  * @throws IndexOutOfBoundsException if the index is out of bounds
  *
  */
 

Parameters:

comment - the documentation comment.

Returns:

structured documentation