OpenJDK 27 · com.sun.tools.javac.parser.DocCommentParser

Modifier and Type	Class and Description
pack-priv static enum	DocCommentParser.LineKind The kinds of line, used when reading a Markdown documentation comment.
pack-priv class	DocCommentParser.Markdown A class to encapsulate the work to parse Markdown enough to detect the boundaries of character sequences of literal text, and to skip over such sequences, without analyzing the content.
pack-priv static class	DocCommentParser.ParseException
private static enum	DocCommentParser.Phase An indication of the part of documentation comment or file being read.
private abstract static class	DocCommentParser.TagParser
private static enum	DocCommentParser.WhitespaceRetentionPolicy

Field Summary

Modifier and Type	Field and Description
private int	bp
private char[]	buf The input buffer, index of most recent character read, index of one past last character in buffer.
private int	buflen
private char	ch The current character.
private final Tokens.Comment	comment
private final JCDiagnostic.Factory	diags
private final DiagnosticSource	diagSource
private final ParserFactory	fac
private boolean	inPre Used for whitespace normalization in pre/code/literal tags.
private final boolean	isHtmlFile
private int	lastNonWhite
private final DocTreeMaker	m
private final DocCommentParser.Markdown	markdown
private final Names	names
private boolean	newline
private final Map<Name, DocCommentParser.TagParser>	tagParsers
private final DocTree.Kind	textKind
private int	textStart

Access	Constructor and Description
public	DocCommentParser(ParserFactory a parser factory, for a doc-tree maker and for reference parsers fac, DiagnosticSource the source in which the comment was found diagSource, Tokens.Comment the comment comment) Creates a parser for a documentation comment.
public	DocCommentParser(ParserFactory a parser factory, for a doc-tree maker and for reference parsers fac, DiagnosticSource the source in which the comment was found diagSource, Tokens.Comment the comment comment, boolean whether the comment is the entire content of an HTML file isHtmlFile) Creates a parser for a documentation comment.

Method Summary

Modifier and Type	Method and Description
protected void	addPendingText(ListBuffer<DCTree> list, int textEnd)
protected void	addPendingText(ListBuffer<DCTree> list, int textEnd, DocTree.Kind kind)
protected void	attrValueChar(ListBuffer<DCTree> list)
protected List<DCTree>	blockContent()
protected DCTree	blockTag() Read a single block tag, including its content.
protected List<DCTree>	blockTags() Read a series of block tags, including their content.
protected List<DCTree>	content(DocCommentParser.Phase phase) Reads "rich text" content, consisting of text, html and inline tags, according to the given `phase`.
private Map<Name, DocCommentParser.TagParser>	createTagParsers()
pack-priv void	defaultContentCharacter()
protected void	entity(ListBuffer<DCTree> list)
protected DCTree	entity() Reads an HTML entity.
protected DCTree.DCErroneous	Returns: the `ErroneousTree` node erroneous(String the resource key for the error message code, int the starting position pos) Creates an `ErroneousTree` node, for a range of text starting at a given position, ending at the last non-whitespace character before the current position, and with the preferred position set to the last character within that range.
protected DCTree.DCErroneous	Returns: the `ErroneousTree` node erroneous(String the resource key for the error message code, int the starting position pos, int the preferred position for the node, or `NOPOS` to use the default value as the last character of the range pref) Creates an `ErroneousTree` node, for a range of text starting at a given position, ending at the last non-whitespace character before the current position, and with a given preferred position.
private static DocTree.Kind	getTextKind(Tokens.Comment c)
private DCTree	html() Reads an HTML construct, beginning with `<`.
protected List<DCTree>	htmlAttrs() Read a series of HTML attributes, terminated by > .
protected DCTree.DCIdentifier	identifier() Reads a Java identifier.
pack-priv void	initMarkdownLine()
private List<DCTree>	inlineContent() Reads general text content of an inline tag, including HTML entities and elements.
protected boolean	Returns: `true` if an inline tag was read, and `false` otherwise inlineTag(ListBuffer<DCTree> the list of trees being accumulated list) Reads a possible inline tag, after finding an opening brace `{` character.
protected DCTree	inlineTag() Read a single inline tag, including its content.
private DCTree.DCText	inlineText(DocCommentParser.WhitespaceRetentionPolicy whitespacePolicy) Read plain text content of an inline tag.
protected DCTree.DCText	inlineWord() Reads a term (that is, one word).
protected boolean	isDecimalDigit(char ch)
pack-priv boolean	Returns: whether this is the end of the main body of the content isEndBody() Returns whether this is the end of the main body of the content in a standalone HTML file.
pack-priv boolean	Returns: whether this is the end of the preamble isEndPreamble() Returns whether this is the end of the preamble of an HTML file.
protected boolean	isHexDigit(char ch)
protected boolean	isHorizontalWhitespace(char ch)
protected boolean	isIdentifierStart(char ch)
protected boolean	isJavaIdentifierStart(char ch)
protected boolean	isUnquotedAttrValueTerminator(char ch)
protected boolean	isWhitespace(char ch)
pack-priv String	newString(int position of first character of string start, int position of character beyond last character to be included end)
pack-priv void	nextChar()
pack-priv ListBuffer<DCTree>	normalizePreContent(ListBuffer<DCTree> trees)
public DCTree.DCDocComment	Returns: the result of parsing the content given to the constructor parse() Returns the result of parsing the content given to the constructor.
pack-priv boolean	peek(String s)
pack-priv char	peekChar()
protected DCTree.DCText	quotedString() Reads a quoted string.
protected Name	readAttributeName()
protected Name	readIdentifier()
protected Name	readJavaIdentifier()
protected Name	readSystemPropertyName()
protected Name	readTagName()
protected DCTree.DCReference	reference(ReferenceParser.Mode mode) Read Java class name, possibly followed by member Matching pairs of < > are skipped.
private String	showPos(int p)
protected void	skipWhitespace()
private IllegalStateException	unknownTextKind(DocTree.Kind textKind)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

public Class DocCommentParser

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary