Package io.micronaut.openapi.javadoc

Enum Class DocsFormat

java.lang.Object

java.lang.Enum<DocsFormat>

io.micronaut.openapi.javadoc.DocsFormat

All Implemented Interfaces:

Serializable, Comparable<DocsFormat>, Constable

public enum DocsFormat
extends Enum<DocsFormat>

Javadoc / KDoc format mode.

Since:

6.18.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HTML_TO_MD
MD_TO_HTML
PLAIN

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	NAMES

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PLAIN

public static final DocsFormat PLAIN

HTML_TO_MD

public static final DocsFormat HTML_TO_MD

MD_TO_HTML

public static final DocsFormat MD_TO_HTML

Field Details

NAMES

public static final String[] NAMES

Method Details

values

public static DocsFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static DocsFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null