io.qameta.allure

Annotation Type Description

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface Description

Annotation that allows to attach a description for a test or for a step.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	useJavaDoc Use annotated method's javadoc to extract description that supports html markdown.
java.lang.String	value Simple description text as String.

Element Detail

value

public abstract java.lang.String value

Simple description text as String.

Returns:

Description text.

Default:

""

useJavaDoc

public abstract boolean useJavaDoc

Use annotated method's javadoc to extract description that supports html markdown.

Returns:

boolean flag to enable description extraction from javadoc.

Default:

false