com.jagrosh.jdautilities.doc

Annotation Type DocMultiple

@Documented
 @Retention(value=RUNTIME)
 @Target(value=ANNOTATION_TYPE)
public @interface DocMultiple

A helper Annotation, useful for formatting multiple occurrences of the same CommandDoc annotation.

This is best coupled with usage of an @Repeatable annotation and a similarly named holder annotation for multiple occurrences.
@Error and @Errors are an example of such practice.

Since:

2.0

Author:

Kaidan Gustave

See Also:

Error, Errors

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	preface Text that occurs before all occurrences of the annotation this is applied to.
java.lang.String	prefixEach A prefix annotation appended to the front of each occurrence.
java.lang.String	separateBy A separator String applied in-between occurrences.

Element Detail

preface

public abstract java.lang.String preface

Text that occurs before all occurrences of the annotation this is applied to.
Default this is an empty String.

Returns:

The preface text

Default:

""

prefixEach

public abstract java.lang.String prefixEach

A prefix annotation appended to the front of each occurrence.
Default this is an empty string.

Returns:

The prefix String.

Default:

""

separateBy

public abstract java.lang.String separateBy

A separator String applied in-between occurrences.
Default this is an empty string.

Returns:

The separator String.

Default:

""