org.apache.cxf.annotations

Annotation Type WSDLDocumentation

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

Adds documentation nodes to the generated WSDL

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value The documentation to add

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>	faultClass If Placement is FAULT_MESSAGE, PORT_FAULT, or BINDING_FAULT, return the fault class associated with this documentation
WSDLDocumentation.Placement	placement The place to put the documentation.

Element Detail

value

public abstract String value

The documentation to add

Returns:

documentation string

placement

public abstract WSDLDocumentation.Placement placement

The place to put the documentation. The Default depends on the location of the annotation. On the method in the SEI, it would be the portType/operation, on the SEI, it would be the portType, on the service impl, the service element.

Returns:

location

Default:

org.apache.cxf.annotations.WSDLDocumentation.Placement.DEFAULT

faultClass

public abstract Class<?> faultClass

If Placement is FAULT_MESSAGE, PORT_FAULT, or BINDING_FAULT, return the fault class associated with this documentation

Returns:

the fault class

Default:

org.apache.cxf.annotations.WSDLDocumentation.DEFAULT.class