org.coursera.courier.lang

Enum DocCommentStyle

java.lang.Object

java.lang.Enum<DocCommentStyle>

org.coursera.courier.lang.DocCommentStyle

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DocCommentStyle>

public enum DocCommentStyle
extends java.lang.Enum<DocCommentStyle>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASTRISK_MARGIN For Scaladoc/Javadoc style doc comments.
NO_MARGIN For swift style doc comments.

Method Summary

Modifier and Type	Method and Description
static DocCommentStyle	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DocCommentStyle[]	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

ASTRISK_MARGIN

public static final DocCommentStyle ASTRISK_MARGIN

For Scaladoc/Javadoc style doc comments.

NO_MARGIN

public static final DocCommentStyle NO_MARGIN

For swift style doc comments.

Method Detail

values

public static DocCommentStyle[] 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 (DocCommentStyle c : DocCommentStyle.values())
    System.out.println(c);

Returns:

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

valueOf

public static DocCommentStyle 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