From 47782529a74273448c0d70cd82a9d539f90b6f52 Mon Sep 17 00:00:00 2001 From: mathias Date: Sat, 2 Oct 2021 01:38:15 +0200 Subject: [PATCH] Added comments in the ResponderCommand --- .../commands/ResponderCommand.java | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/src/main/java/de/gnmyt/autoresponder/commands/ResponderCommand.java b/src/main/java/de/gnmyt/autoresponder/commands/ResponderCommand.java index e3730aa..3bb5f7b 100644 --- a/src/main/java/de/gnmyt/autoresponder/commands/ResponderCommand.java +++ b/src/main/java/de/gnmyt/autoresponder/commands/ResponderCommand.java @@ -14,14 +14,32 @@ public abstract class ResponderCommand { // The usage of the command } + /** + * Creates a new {@link SimpleUsageBuilder}, which adds a new usage element + * + * @param type The type of the usage element + * @param name The name of the usage element + * @return the created {@link SimpleUsageBuilder} + */ public SimpleUsageBuilder addUsage(UsageType type, String name) { return new SimpleUsageBuilder(this).type(type).name(name); } + /** + * Creates a new {@link SimpleUsageBuilder}, which adds a new usage element + * + * @param name The name of the usage element + * @return the created {@link SimpleUsageBuilder} + */ public SimpleUsageBuilder addUsage(String name) { return new SimpleUsageBuilder(this).name(name); } + /** + * Adds a new usage element to the list + * + * @param usageElement The usage element you want to add + */ public void addUsageElement(UsageElement usageElement) { usageElements.add(usageElement); }