Package io.qameta.allure

Annotation Interface Description

@Retention(RUNTIME) @Target(METHOD) public @interface Description
Annotation that allows to attach a description for a test.

  • Optional Element Summary

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

  • Element Details

    • value

      String value
      Simple description text as String.
      Returns:
      Description text.
      Default:
      ""

    • useJavaDoc

      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