Package com.smeup.kokos.sdk.annotations

Annotation Interface DocsDopedCopy

@Retention(RUNTIME) @Target(TYPE) public @interface DocsDopedCopy
Annotation to indicate that a copy of documentation has been doped (modified or extended).
Author:
SMEUP

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static @interface 
    DocsDopedCopy.Param
    Annotation to describe a parameter for the doped copy.
    static @interface 
    DocsDopedCopy.ParamValue
    Annotation to describe an allowed value for a parameter.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    boolean
    changed
    Indicates if the copy has been changed relative to the original.
    String
    copy
    The name of the original copy.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    Description of the changes or the copy.
    DocsDopedCopy.Param[]
    params
    Parameters associated with the copy.

  • Element Details

    • copy

      String copy
      The name of the original copy.
      Returns:
      the copy name

    • changed

      boolean changed
      Indicates if the copy has been changed relative to the original.
      Returns:
      true if changed, false otherwise

    • description

      String description
      Description of the changes or the copy.
      Returns:
      the description
      Default:
      ""

    • params

      DocsDopedCopy.Param[] params
      Parameters associated with the copy.
      Returns:
      array of parameters
      Default:
      {}