diff options
| author | Ben Culkin <scorpress@gmail.com> | 2021-03-13 10:13:01 -0500 |
|---|---|---|
| committer | Ben Culkin <scorpress@gmail.com> | 2021-03-13 10:13:01 -0500 |
| commit | ee6a9305a1009e6f1e3e99d5de3cfba5305a5d1b (patch) | |
| tree | 814ed2184dbc7c10eff387103e5b5b63cfb2e74f /dice/src/example/java/bjc/dicelang/neodice/commands/LiteralCommand.java | |
| parent | 7efb7b9e997e0977c8343718cd8b5149805ea57b (diff) | |
Update documentation
Also, did the same thing for Die I did for DiePool, where I moved the
specific classes to the same file as the interface.
Diffstat (limited to 'dice/src/example/java/bjc/dicelang/neodice/commands/LiteralCommand.java')
| -rw-r--r-- | dice/src/example/java/bjc/dicelang/neodice/commands/LiteralCommand.java | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/dice/src/example/java/bjc/dicelang/neodice/commands/LiteralCommand.java b/dice/src/example/java/bjc/dicelang/neodice/commands/LiteralCommand.java index 9b42b42..b781ae9 100644 --- a/dice/src/example/java/bjc/dicelang/neodice/commands/LiteralCommand.java +++ b/dice/src/example/java/bjc/dicelang/neodice/commands/LiteralCommand.java @@ -5,12 +5,28 @@ import java.util.*; import bjc.dicelang.neodice.*; import bjc.dicelang.neodice.statements.*; +/** + * A command that produces a literal statement value. + * + * This command will always produce the same statement value, so passing any sort + * of mutable statement value to it is asking to be hurt. + * + * @author Ben Culkin + * + */ public class LiteralCommand implements Command { private final StatementValue value; private final String shortHelp; private final String longHelp; + /** + * Create a new command producing a literal statement value. + * + * @param value The value this command returns. + * @param shortHelp The short-help (summary) for this command. + * @param longHelp The long-help (description) for this command. + */ public LiteralCommand(StatementValue value, String shortHelp, String longHelp) { this.value = value; |
