com.tngtech.jgiven.annotation
Annotation Type Description

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

This annotation can be used to define an alternate description for a step method or test method. This description is then used in the generated report instead of using the method name.

Note that the '$' character keeps its special meaning and will be replaced with step arguments

 @Description("some (complicated) step")
 public SELF some_complicated_step() {
    ...
 }
 

 @Description("Some 'special' scenario description")
 @Test
 public void some_special_scenario_description() {
    ...
 }
 

Required Element Summary

String

value The description of the step.

Element Detail

value

public abstract String value

The description of the step.