net.ozwolf.raml.annotations

Annotation Type RamlDocumentation

@Retention(value=RUNTIME)
public @interface RamlDocumentation

RAML Documentation Annotation

An annotation used to describe a documentation resource.

See Also:

RamlApp

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	content The content of the documentation.
String	title The title of the documentation page.

Element Detail

title

public abstract String title

The title of the documentation page.

Returns:

the title

content

public abstract String content

The content of the documentation. Can reference a classpath resource or can be a direct text entry.

Supports markdown.

Returns:

the content