Annotation Interface Description

@Target(TYPE) @Retention(RUNTIME) public @interface Description
This annotation specifies the description of a command. The command description is collected into the CommandInfo. By default, the annotation should contain a translation key, that is resolved in the runtime. If this is not the case the translatable() option has to be false.
Since:
4.0
See Also:
  • CommandInfo

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    Gets the description for all commands of a class which is annotated with this annotation.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    translatable
    Gets if the provided description is a translation key, that needs to be resolved at runtime.

  • Element Details

    • value

      String value
      Gets the description for all commands of a class which is annotated with this annotation.
      Returns:
      the description.

    • translatable

      boolean translatable
      Gets if the provided description is a translation key, that needs to be resolved at runtime.
      Returns:
      if the provided description is a translation key, that needs to be resolved at runtime.
      Default:
      true