com.google.javascript.jscomp.parsing

Class JsDocInfoParser

java.lang.Object

com.google.javascript.jscomp.parsing.JsDocInfoParser

public final class JsDocInfoParser
extends java.lang.Object

A parser for JSDoc comments.

Author:

[email protected] (Nick Santos)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BAD_TYPE_WIKI_LINK

Method Summary

Modifier and Type	Method and Description
StaticSourceFile	getSourceFile()
static JSDocInfo	parseFileOverviewJsdoc(java.lang.String toParse)
JSDocInfo	parseInlineTypeDoc() Parse a description as a @type.
static JSDocInfo	parseJsdoc(java.lang.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(java.lang.String typeString) Parses a string containing a JsDoc type declaration, returning the type if the parsing succeeded or null if it failed.

Methods inherited from class java.lang.Object

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

Field Detail

BAD_TYPE_WIKI_LINK

public static final java.lang.String BAD_TYPE_WIKI_LINK

See Also:

Constant Field Values

Method Detail

getSourceFile

public StaticSourceFile getSourceFile()

parseInlineTypeDoc

public JSDocInfo parseInlineTypeDoc()

Parse a description as a @type.

parseTypeString

public static Node parseTypeString(java.lang.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(java.lang.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(java.lang.String toParse)