io.qameta.allure.kotlin.Description.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of allure-kotlin-commons Show documentation

Module allure-kotlin-commons of Allure Framework.

There is a newer version: 2.4.0

Show newest version

package io.qameta.allure.kotlin

/**
 * Annotation that allows to attach a description for a test or for a step.
 */
@Retention(AnnotationRetention.RUNTIME)
@Target(
    AnnotationTarget.FUNCTION,
    AnnotationTarget.PROPERTY_GETTER,
    AnnotationTarget.PROPERTY_SETTER
)
annotation class Description(
    /**
     * Simple description text as String.
     *
     * @return Description text.
     */
    val value: String = "",
    /**
     * Use annotated method's javadoc to extract description that
     * supports html markdown.
     *
     * @return boolean flag to enable description extraction from javadoc.
     */
    val useJavaDoc: Boolean = false
)