org.projectodd.jrapidoc.annotation

Annotation Type DocIsRequired

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

Annotatation can be used for indication whether parameter is required or optional

Can be placed on field, method parameter, constructor parameter ana setter method

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	value true if required false if optional

Element Detail

value

public abstract boolean value

true if required
false if optional

Returns:

Default:

true