Skip to content

Commit 1b2527e

Browse files
author
Daniel Naylor
committed
Clarify the RegisterCommandEvent docs a little bit.
1 parent e19cdcb commit 1b2527e

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

src/main/java/org/spongepowered/api/event/lifecycle/RegisterCommandEvent.java

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,16 +34,26 @@
3434
/**
3535
* Lifecycle event to indicate when commands should be registered.
3636
*
37-
* <p>There are two types command that Sponge will always call an event for:</p>
37+
* <p>This event is generic and the type parameter is <strong>required</strong>.
38+
* This type parameter ({@code C}) will correspond to the base class or
39+
* interface that your command inherits from.</p>
40+
*
41+
* <p>There are two types of command that Sponge will always call an event for:
42+
* </p>
3843
*
3944
* <ul>
40-
* <li>Where {@link C} is {@link Command.Raw}; and</li>
41-
* <li>Where {@link C} is {@link Command.Parameterized}.</li>
45+
* <li>Where {@code C} is {@link Command.Raw}; and</li>
46+
* <li>Where {@code C} is {@link Command.Parameterized}.</li>
4247
* </ul>
4348
*
44-
* <p>Other plugins may provide a {@link CommandRegistrar} that allows for other
45-
* types to be registered as commands. These types will be provided by these
46-
* other plugins.</p>
49+
* <p>Commands that have been generated using {@link Command#builder()} should
50+
* be registered during the {@code RegisterCommandEvent<Command.Parameterized>}
51+
* event.</p>
52+
*
53+
* <p>Other plugins and platforms may provide a {@link CommandRegistrar} that
54+
* allows for other types to be registered as commands. These types will be
55+
* provided by these other plugins, consult their documentation for more
56+
* details.</p>
4757
*
4858
* <p>This event will be called whenever the game re-initializes commands, and
4959
* does not guarantee that any specific engine is running.</p>

0 commit comments

Comments
 (0)