Package com.linecorp.armeria.server.docs

Class DescriptionInfo

java.lang.Object

com.linecorp.armeria.server.docs.DescriptionInfo

@UnstableApi
public final class DescriptionInfo
extends Object

Description of a type, a field, a method or a parameter.

Method Summary

Modifier and Type	Method	Description
String	docString()	Returns the documentation string.
static DescriptionInfo	empty()	Returns an empty DescriptionInfo.
boolean	equals(Object o)
static DescriptionInfo	from(Description description)	Creates a new DescriptionInfo from the specified Description.
int	hashCode()
Markup	markup()	Returns the supported markup.
static DescriptionInfo	of(String docString)	Creates a new DescriptionInfo with the docStrings.
static DescriptionInfo	of(String docString, Markup markup)	Creates a new DescriptionInfo with the docStrings and specific markup.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

of

public static DescriptionInfo of(String docString,
 Markup markup)

Creates a new DescriptionInfo with the docStrings and specific markup.

Parameters:

docString - the documentation string of the field

markup - the support markup of the field

of

public static DescriptionInfo of(String docString)

Creates a new DescriptionInfo with the docStrings.

Parameters:

docString - the documentation string of the field

from

public static DescriptionInfo from(Description description)

Creates a new DescriptionInfo from the specified Description.

empty

public static DescriptionInfo empty()

Returns an empty DescriptionInfo.

docString

public String docString()

Returns the documentation string.

markup

public Markup markup()

Returns the supported markup.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object