Skip to content

KDocKnownTag

Entries

AUTHOR

THROWS

EXCEPTION

PARAM

RECEIVER

RETURN

SEE

SEE

SINCE

CONSTRUCTOR

PROPERTY

SAMPLE

SUPPRESS

Types

Companion

object Companion

Companion properties

entries

Returns an immutable kotlin.enums.EnumEntries list containing the constants of this enum type, in the order they're declared.

Companion functions

valueOf

fun valueOf(value: String): KDocKnownTag

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.)

Throws

kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

values

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

The function returns a new instance of the array on every call. The array could be mutated, so working with it may also require defensive copying. Consider using entries property as a more efficient alternative returning an immutable list of enum entries.

Properties

isReferenceRequired

isSectionStart

name

val name: String

ordinal

val ordinal: Int