Class JavadocParser

java.lang.Object

com.github.javaparser.JavadocParser

class JavadocParser
extends Object

The class responsible for parsing the content of JavadocComments and producing JavadocDocuments. The Javadoc specification.

Field Summary

Fields

Modifier and Type	Field	Description
private static Pattern	BLOCK_PATTERN
private static String	BLOCK_TAG_PREFIX

Constructor Summary

Constructors

Constructor	Description
JavadocParser()

Method Summary

Modifier and Type	Method	Description
private static List<String>	cleanLines(String content, boolean isMarkdownComment)
private static boolean	isABlockLine(String line)
static Javadoc	parse(JavadocComment comment)
static Javadoc	parse(String commentContent)
static Javadoc	parse(String commentContent, boolean isMarkdownComment)
private static JavadocBlockTag	parseBlockTag(String line)
(package private) static int	startsWithAsteriskOrMdSlash(String line)	Given a line in a block or markdown comment, this method finds the index of the * or / at the start of the line.
private static String	trimRight(String string)

Methods inherited from class Object

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

Field Details

BLOCK_TAG_PREFIX

private static String BLOCK_TAG_PREFIX

BLOCK_PATTERN

private static Pattern BLOCK_PATTERN

Constructor Details

JavadocParser

JavadocParser()

Method Details

parse

public static Javadoc parse(JavadocComment comment)

parse

public static Javadoc parse(String commentContent)

parse

public static Javadoc parse(String commentContent,
 boolean isMarkdownComment)

parseBlockTag

private static JavadocBlockTag parseBlockTag(String line)

isABlockLine

private static boolean isABlockLine(String line)

trimRight

private static String trimRight(String string)

cleanLines

private static List<String> cleanLines(String content,
 boolean isMarkdownComment)

startsWithAsteriskOrMdSlash

static int startsWithAsteriskOrMdSlash(String line)

Given a line in a block or markdown comment, this method finds the index of the * or / at the start of the line. For markdown comments where lines start with ///, this would be the index of the third /. This is used to strip the relevant prefix string when cleaning lines as part of the Javadoc parsing process. It is made visible for testing