Skip navigation links
C D E G R 

C

com.jagrosh.jdautilities.doc - package com.jagrosh.jdautilities.doc
Items in this package pertain to the DocGenerator.
com.jagrosh.jdautilities.doc.standard - package com.jagrosh.jdautilities.doc.standard
 
CommandInfo - Annotation Type in com.jagrosh.jdautilities.doc.standard
A CommandDoc Annotation that contains basic information on command usage, declaration, and requirements.
CommandInfo.Converter - Class in com.jagrosh.jdautilities.doc.standard
The DocConverter for the @CommandInfo annotation.
ConvertedBy - Annotation Type in com.jagrosh.jdautilities.doc
Specifies an Annotation can be converted using the specified DocConverter value.
Converter() - Constructor for class com.jagrosh.jdautilities.doc.standard.CommandInfo.Converter
 
Converter() - Constructor for class com.jagrosh.jdautilities.doc.standard.Error.Converter
 
Converter() - Constructor for class com.jagrosh.jdautilities.doc.standard.RequiredPermissions.Converter
 

D

DocConverter<T extends java.lang.annotation.Annotation> - Interface in com.jagrosh.jdautilities.doc
Converts an annotation of the specified type T into a String to be collected with other conversions into a single String documenting a class or method representing a command for a bot.
DocGenerator - Class in com.jagrosh.jdautilities.doc
An instance based documentation engine for bot commands written in JDA.
DocGenerator() - Constructor for class com.jagrosh.jdautilities.doc.DocGenerator
Gets a blank DocGenerator with no conversions loaded.
DocGenerator(int) - Constructor for class com.jagrosh.jdautilities.doc.DocGenerator
Gets a blank DocGenerator with no conversions loaded, and a cache with the specified max-size.
DocGenerator(String, int) - Constructor for class com.jagrosh.jdautilities.doc.DocGenerator
Gets a blank DocGenerator with no conversions loaded and with the specified separator, and a cache with the specified max-size.
DocMultiple - Annotation Type in com.jagrosh.jdautilities.doc
A helper Annotation, useful for formatting multiple occurrences of the same CommandDoc annotation.

E

Error - Annotation Type in com.jagrosh.jdautilities.doc.standard
A CommandDoc Annotation that describes a possible error or termination clause a Command might have during it's runtime.
Error.Converter - Class in com.jagrosh.jdautilities.doc.standard
The DocConverter for the @Error annotation.
Errors - Annotation Type in com.jagrosh.jdautilities.doc.standard
The @Repeatable value for @Error.

G

getDefaultGenerator() - Static method in class com.jagrosh.jdautilities.doc.DocGenerator
Gets a default DocGenerator with standard conversions loaded.
getDocFor(Class<?>) - Method in class com.jagrosh.jdautilities.doc.DocGenerator
Reads CommandDoc from the provided Class and returns the String formatted and from it.
getDocFor(Method) - Method in class com.jagrosh.jdautilities.doc.DocGenerator
Reads CommandDoc from the provided Method and returns the String formatted and from it.
getDocForMethods(Class<?>) - Method in class com.jagrosh.jdautilities.doc.DocGenerator
Reads all Methods from the provided Class and returns a List of CommandDoc of each.

R

read(T) - Method in interface com.jagrosh.jdautilities.doc.DocConverter
Returns a String processed from the contents of the provided Annotation.
read(CommandInfo) - Method in class com.jagrosh.jdautilities.doc.standard.CommandInfo.Converter
 
read(Error) - Method in class com.jagrosh.jdautilities.doc.standard.Error.Converter
 
read(RequiredPermissions) - Method in class com.jagrosh.jdautilities.doc.standard.RequiredPermissions.Converter
 
register(Class<T>, Object...) - Method in class com.jagrosh.jdautilities.doc.DocGenerator
Registers a CommandDoc Annotation to this DocGenerator.
register(Class<T>, DocConverter<T>) - Method in class com.jagrosh.jdautilities.doc.DocGenerator
Registers a CommandDoc Annotation to this DocGenerator with the provided DocConverter.
RequiredPermissions - Annotation Type in com.jagrosh.jdautilities.doc.standard
A CommandDoc Annotation that lists required Permissions a bot must have to use a command on a Guild.
RequiredPermissions.Converter - Class in com.jagrosh.jdautilities.doc.standard
The DocConverter for the @RequiredPermissions annotation.
C D E G R 
Skip navigation links