Package com.google.javascript.jscomp.parsing

Class JsDocInfoParser

java.lang.Object

com.google.javascript.jscomp.parsing.JsDocInfoParser

public final class JsDocInfoParser
extends Object

A parser for JSDoc comments.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JsDocInfoParser.JsDocSourceKind	How to handle unexpected JSDoc format

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BAD_TYPE_WIKI_LINK

Constructor Summary

Constructors

Constructor	Description
JsDocInfoParser(JsDocTokenStream stream, String comment, int commentPosition, @Nullable Node templateNode, Config config, JsDocInfoParser.JsDocSourceKind jsDocSourceKind, ErrorReporter errorReporter)

Method Summary

Modifier and Type	Method	Description
StaticSourceFile	getSourceFile()
boolean	parse()	Parses a JSDocInfo object.
static JSDocInfo	parseFileOverviewJsdoc(String toParse)
@Nullable JSDocInfo	parseInlineTypeDoc()	Parse a description as a @type.
static JSDocInfo	parseJsdoc(String toParse)	Parses a string containing a JsDoc declaration, returning the entire JSDocInfo if the parsing succeeded or null if it failed.
static Node	parseTypeString(String typeString)	Parses a string containing a JsDoc type declaration, returning the type if the parsing succeeded or null if it failed.
JSDocInfo	retrieveAndResetParsedJSDocInfo()

Methods inherited from class java.lang.Object

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

Field Details

BAD_TYPE_WIKI_LINK

public static final String BAD_TYPE_WIKI_LINK

See Also:

• Constant Field Values

Constructor Details

JsDocInfoParser

public JsDocInfoParser(JsDocTokenStream stream,
 String comment,
 int commentPosition,
 @Nullable Node templateNode,
 Config config,
 JsDocInfoParser.JsDocSourceKind jsDocSourceKind,
 ErrorReporter errorReporter)

Method Details

getSourceFile

public StaticSourceFile getSourceFile()

parseInlineTypeDoc

public @Nullable JSDocInfo parseInlineTypeDoc()

Parse a description as a @type.

parseTypeString

public static Node parseTypeString(String typeString)

Parses a string containing a JsDoc type declaration, returning the type if the parsing succeeded or null if it failed.

parseJsdoc

public static JSDocInfo parseJsdoc(String toParse)

Parses a string containing a JsDoc declaration, returning the entire JSDocInfo if the parsing succeeded or null if it failed.

parseFileOverviewJsdoc

public static JSDocInfo parseFileOverviewJsdoc(String toParse)

parse

public boolean parse()

Parses a JSDocInfo object. This parsing method reads all tokens returned by the JsDocTokenStream.getJsDocToken() method until the JsDocToken.EOC is returned.

Returns:

true if JSDoc information was correctly parsed, false otherwise

retrieveAndResetParsedJSDocInfo

public JSDocInfo retrieveAndResetParsedJSDocInfo()