org.opencastproject.util.doc.rest

Annotation Type RestService

@Retention(value=RUNTIME)
 @Target(value=TYPE)
public @interface RestService

This annotation type is used for annotating RESTful service(each java class). This annotation type needs to be kept until runtime.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	abstractText
String	name
String[]	notes
String	title

Element Detail

name

public abstract String name

Returns:

the name of the service.

title

public abstract String title

Returns:

a title of the service documentation.

notes

public abstract String[] notes

Returns:

an array of notes to add into the end of the documentation.

abstractText

public abstract String abstractText

Returns:

an abstract section which is displayed at the top of the documentation.