com.jagrosh.jdautilities.doc.standard

Annotation Type CommandInfo

@ConvertedBy(value=CommandInfo.Converter.class)
 @Documented
 @Retention(value=RUNTIME)
 @Target(value={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

Optional Element Summary

Optional Elements

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

Element Detail

name

public abstract java.lang.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

public abstract java.lang.String usage

A short format or explanation of a command's usage.

Returns:

The usage

Default:

""

description

public abstract java.lang.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

public abstract java.lang.String[] requirements

A series of prerequisites or requirements a user must have to use this command.

Returns:

The requirements to use the command

Default:

{}