Package dev.jorel.commandapi.annotations

Annotation Interface Help

@Target(TYPE) @Retention(SOURCE) public @interface Help
The annotation which includes information about the help for a command

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    The full description for this command's help

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    shortDescription
    The short description for this command's help

  • Element Details

    • value

      String value
      The full description for this command's help
      Returns:
      the full description for this command's help

    • shortDescription

      String shortDescription
      The short description for this command's help
      Returns:
      the short description for this command's help
      Default:
      ""