org.jetbrains.kotlin.kdoc.parser
Enum KDocKnownTag

java.lang.Object
  java.lang.Enum<KDocKnownTag>
      org.jetbrains.kotlin.kdoc.parser.KDocKnownTag

All Implemented Interfaces:

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

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

Enum Constant Summary

AUTHOR

CONSTRUCTOR

EXCEPTION

PARAM

PROPERTY

RETURN

SAMPLE

SEE

SINCE

SUPPRESS

THROWS

Method Summary

static KDocKnownTag	findByTagName(java.lang.CharSequence tagName)
boolean	isReferenceRequired()
boolean	isSectionStart()
static KDocKnownTag	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KDocKnownTag[]	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

AUTHOR

public static final KDocKnownTag AUTHOR

THROWS

public static final KDocKnownTag THROWS

EXCEPTION

public static final KDocKnownTag EXCEPTION

PARAM

public static final KDocKnownTag PARAM

RETURN

public static final KDocKnownTag RETURN

SEE

public static final KDocKnownTag SEE

SINCE

public static final KDocKnownTag SINCE

CONSTRUCTOR

public static final KDocKnownTag CONSTRUCTOR

PROPERTY

public static final KDocKnownTag PROPERTY

SAMPLE

public static final KDocKnownTag SAMPLE

SUPPRESS

public static final KDocKnownTag SUPPRESS

Method Detail

values

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

Returns:

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

valueOf

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

isReferenceRequired

public boolean isReferenceRequired()

isSectionStart

public boolean isSectionStart()

findByTagName

public static KDocKnownTag findByTagName(java.lang.CharSequence tagName)