com.google.javascript.jscomp.parsing

Enum Config.JsDocParsing

java.lang.Object

java.lang.Enum<Config.JsDocParsing>

com.google.javascript.jscomp.parsing.Config.JsDocParsing

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Config.JsDocParsing>

Enclosing class:

Config

public static enum Config.JsDocParsing
extends java.lang.Enum<Config.JsDocParsing>

Whether to parse the descriptions of JsDoc comments.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INCLUDE_ALL_COMMENTS
INCLUDE_DESCRIPTIONS_NO_WHITESPACE
INCLUDE_DESCRIPTIONS_WITH_WHITESPACE
TYPES_ONLY

Method Summary

Modifier and Type	Method and Description
static Config.JsDocParsing	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Config.JsDocParsing[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

TYPES_ONLY

public static final Config.JsDocParsing TYPES_ONLY

INCLUDE_DESCRIPTIONS_NO_WHITESPACE

public static final Config.JsDocParsing INCLUDE_DESCRIPTIONS_NO_WHITESPACE

INCLUDE_DESCRIPTIONS_WITH_WHITESPACE

public static final Config.JsDocParsing INCLUDE_DESCRIPTIONS_WITH_WHITESPACE

INCLUDE_ALL_COMMENTS

public static final Config.JsDocParsing INCLUDE_ALL_COMMENTS

Method Detail

values

public static Config.JsDocParsing[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Config.JsDocParsing c : Config.JsDocParsing.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Config.JsDocParsing valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null