org.apache.cxf.jaxrs.model.wadl

Annotation Type Description

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

Can be used to document resource classes and methods See WADL Documentation.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	docuri This uri, if set, will be used to retrieve the content which will be set as WADL doc content
String	lang Maps to WADL doc/@xml:lang attribute
String	target Target of this description, see DocTarget
String	title Maps to WADL doc/@title attribute
String	value This value, if set, will be set as WADL doc content

Element Detail

value

public abstract String value

This value, if set, will be set as WADL doc content

Default:

""

lang

public abstract String lang

Maps to WADL doc/@xml:lang attribute

Default:

""

title

public abstract String title

Maps to WADL doc/@title attribute

Default:

""

docuri

public abstract String docuri

This uri, if set, will be used to retrieve the content which will be set as WADL doc content

Default:

""

target

public abstract String target

Target of this description, see DocTarget

Default:

""