Package com.jagrosh.jdautilities.doc.standard

Annotation Interface CommandInfo

@ConvertedBy(Converter.class) @Documented @Retention(RUNTIME) @Target({TYPE,METHOD}) public @interface CommandInfo
A CommandDoc Annotation that contains basic information on command usage, declaration, and requirements.

This annotation should be used for "primary" documented information, and when applicable, developers who are using the DocGenerator returned by DocGenerator.getDefaultGenerator(), and who are not implementing their own CommandDoc systems, should use this in place of creating a new annotation and converter if possible.

Since:
2.0
Author:
Kaidan Gustave

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    CommandInfo.Converter
    The DocConverter for the @CommandInfo annotation.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    A description of this command, what it does, and (if needed) elaboration on the usage().
    String[]
    name
    The name and aliases of a command.
    String[]
    requirements
    A series of prerequisites or requirements a user must have to use this command.
    String
    usage
    A short format or explanation of a command's usage.

  • Element Details

    • name

      String[] name
      The name and aliases of a command. The first one should be the official name, and following elements should be aliases (if any are allowed).
      Returns:
      The name and aliases
      Default:
      {}

    • usage

      String usage
      A short format or explanation of a command's usage.
      Returns:
      The usage
      Default:
      ""

    • description

      String description
      A description of this command, what it does, and (if needed) elaboration on the usage().
      Returns:
      The description of this command
      Default:
      ""

    • requirements

      String[] requirements
      A series of prerequisites or requirements a user must have to use this command.
      Returns:
      The requirements to use the command
      Default:
      {}