io.muserver.rest

Annotation Type Description

@Target(value={TYPE,METHOD,PARAMETER})
 @Retention(value=RUNTIME)
 @Documented
public @interface Description

Provides a description of a class, method, or parameter for use in documentation.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value A short plaintext summary.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	details An optional, detailed description that may include CommonMark Markdown.
String	documentationUrl An optional URL pointing to more documentation for this.
String	example An example value

Element Detail

value

public abstract String value

A short plaintext summary.

Returns:

The summary

details

public abstract String details

An optional, detailed description that may include CommonMark Markdown.

Returns:

The description

Default:

""

documentationUrl

public abstract String documentationUrl

An optional URL pointing to more documentation for this.

Returns:

The URL

Default:

""

example

public abstract String example

An example value

Returns:

An example value

Default:

""