Skip to content

Commit

Permalink
chore: Format javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
phinner committed Nov 14, 2024
1 parent 132d205 commit 8560806
Show file tree
Hide file tree
Showing 30 changed files with 119 additions and 115 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@ public class MindustryCommandManager<C> extends CommandManager<C>
/**
* Constructs a new {@link MindustryCommandManager}.
*
* @param plugin the owning plugin
* @param handler the command handler
* @param coordinator the execution coordinator
* @param plugin the owning plugin
* @param handler the command handler
* @param coordinator the execution coordinator
* @param senderMapper the sender mapper
* @see CommandManager#CommandManager(ExecutionCoordinator, CommandRegistrationHandler)
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ public static final class ContentParseException extends ParserException {
/**
* Creates a new {@link ContentParseException}.
*
* @param input the input string
* @param ctx the command context
* @param input the input string
* @param ctx the command context
* @param contentType the content type
*/
public ContentParseException(final CommandContext<?> ctx, final String input, final CTypeKey<?> contentType) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ private DistributorProvider() {}

/**
* Returns the global {@link Distributor} factory.
*
* @throws IllegalStateException if the API hasn't been initialized yet
*/
public static Distributor get() {
Expand All @@ -42,6 +43,7 @@ public static Distributor get() {

/**
* Sets the global {@link Distributor} factory.
*
* @throws IllegalStateException if the API has already been initialized
*/
public static void set(final Distributor distributor) {
Expand All @@ -53,6 +55,7 @@ public static void set(final Distributor distributor) {

/**
* Clears the global {@link Distributor} factory.
*
* @throws IllegalStateException if the API hasn't been initialized yet
*/
public static void clear() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,9 +84,9 @@ default void sendMessage(final Component component) {}
/**
* Sends a message to this audience.
*
* @param component the message
* @param component the message
* @param unformatted the unformatted message
* @param sender the sender
* @param sender the sender
*/
default void sendMessage(final Component component, final Component unformatted, final Audience sender) {}

Expand All @@ -113,7 +113,7 @@ default void hideHUDText() {}
* Sends a notification to this audience.
*
* @param component the notification
* @param icon the icon
* @param icon the icon
*/
default void sendNotification(final Component component, final char icon) {}

Expand All @@ -134,25 +134,25 @@ default void openURI(final URI uri) {}
/**
* Shows a label to this audience.
*
* @param label the label
* @param x the x position in world coordinates
* @param y the y position in world coordinates
* @param label the label
* @param x the x position in world coordinates
* @param y the y position in world coordinates
* @param duration the duration
*/
default void showLabel(final Component label, final float x, final float y, final Duration duration) {}

/**
* Kicks this audience from the server.
*
* @param reason the reason
* @param reason the reason
* @param duration the duration
*/
default void kick(final Component reason, final Duration duration) {}

/**
* Kicks this audience from the server.
*
* @param reason the reason
* @param reason the reason
* @param duration the duration
*/
default void kick(final Packets.KickReason reason, final Duration duration) {}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ non-sealed interface Argument extends CommandElement {
/**
* Creates a new command argument.
*
* @param name the name of the argument
* @param name the name of the argument
* @param description the description of the argument
* @param aliases the aliases of the argument
* @param kind the kind of the argument
* @param aliases the aliases of the argument
* @param kind the kind of the argument
* @return the created argument
*/
static Argument of(
Expand Down Expand Up @@ -94,11 +94,11 @@ non-sealed interface Flag extends CommandElement {
/**
* Creates a new command flag.
*
* @param name the name of the flag
* @param name the name of the flag
* @param description the description of the flag
* @param aliases the aliases of the flag
* @param kind the kind of the flag
* @param mode the mode of the flag
* @param aliases the aliases of the flag
* @param kind the kind of the flag
* @param mode the mode of the flag
* @return the created flag
*/
static Flag of(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ static CommandFacade from(final CommandHandler.Command command) {
* The result is affected by the permissions of the sender.
*
* @param sender the sender to get the help for
* @param query the query to get the help for
* @param query the query to get the help for
* @return the help information for this command
*/
CommandHelp getHelp(final CommandSender sender, final String query);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,11 @@ non-sealed interface Entry extends CommandHelp {
/**
* Creates a new command entry.
*
* @param syntax the syntax of the command
* @param description the description of the command
* @param syntax the syntax of the command
* @param description the description of the command
* @param verboseDescription the verbose description of the command
* @param arguments the arguments of the command
* @param flags the flags of the command
* @param arguments the arguments of the command
* @param flags the flags of the command
*/
static Entry of(
final String syntax,
Expand Down Expand Up @@ -90,7 +90,7 @@ non-sealed interface Suggestion extends CommandHelp {
* Creates a new command suggestion.
*
* @param longestSharedPath the longest shared path of the suggestions
* @param childSuggestions the child suggestions
* @param childSuggestions the child suggestions
*/
static Suggestion of(final String longestSharedPath, final List<String> childSuggestions) {
return SuggestionImpl.of(longestSharedPath, childSuggestions);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ static DescriptionFacade text(final String text) {
* Creates a new translated description.
* It uses distributor global translation system to translate the given key with either the input locale or the default locale.
*
* @param key the translation key
* @param key the translation key
* @param defaultLocale the default locale
* @return the created translated description
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public interface DescriptionMapper<T> {
* Maps a describable object to a text description by extracting the text from it.
*
* @param extractor the function to extract the text from the describable object
* @param <T> the type of the describable object
* @param <T> the type of the describable object
* @return the created description mapper
*/
static <T> DescriptionMapper<T> text(final Function<T, String> extractor) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ static ListComponent components(final Collection<Component> components) {
/**
* Creates a new list component with the specified text color and components.
*
* @param textColor the text color
* @param textColor the text color
* @param components the components
* @return the list component
*/
Expand All @@ -71,7 +71,7 @@ static ListComponent components(final ComponentColor textColor, final Component.
/**
* Creates a new list component with the specified text color and components.
*
* @param textColor the text color
* @param textColor the text color
* @param components the components
* @return the list component
*/
Expand All @@ -82,7 +82,7 @@ static ListComponent components(final ComponentColor textColor, final Collection
/**
* Creates a new list component with the specified text textStyle and components.
*
* @param textStyle the text textStyle
* @param textStyle the text textStyle
* @param components the components
* @return the list component
*/
Expand All @@ -93,7 +93,7 @@ static ListComponent components(final TextStyle textStyle, final Component... co
/**
* Creates a new list component with the specified text textStyle and components.
*
* @param textStyle the text textStyle
* @param textStyle the text textStyle
* @param components the components
* @return the list component
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ static NumberComponent number(final Number number) {
/**
* Creates a new number component with the specified number and text color.
*
* @param number the number
* @param number the number
* @param textColor the text color
* @return the number component
*/
Expand All @@ -58,7 +58,7 @@ static NumberComponent number(final Number number, final ComponentColor textColo
* Creates a new number component with the specified number and text textStyle.
*
* @param number the number
* @param style the text textStyle
* @param style the text textStyle
* @return the number component
*/
static NumberComponent number(final Number number, final TextStyle style) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ static TemporalComponent.Builder temporal() {
/**
* Creates a new temporal component with the specified temporal value and temporal textStyle.
*
* @param temporal the temporal value
* @param temporal the temporal value
* @param temporalStyle the temporal textStyle
* @return the temporal component
*/
Expand All @@ -52,9 +52,9 @@ static TemporalComponent temporal(final Temporal temporal, final TemporalStyle t
/**
* Creates a new temporal component with the specified temporal value, temporal textStyle, and text color.
*
* @param temporal the temporal value
* @param temporal the temporal value
* @param temporalStyle the temporal textStyle
* @param textColor the text color
* @param textColor the text color
* @return the temporal component
*/
static TemporalComponent temporal(
Expand All @@ -65,9 +65,9 @@ static TemporalComponent temporal(
/**
* Creates a new temporal component with the specified temporal value, temporal textStyle, and text textStyle.
*
* @param temporal the temporal value
* @param temporal the temporal value
* @param temporalStyle the temporal textStyle
* @param textStyle the text textStyle
* @param textStyle the text textStyle
* @return the temporal component
*/
static TemporalComponent temporal(
Expand All @@ -88,7 +88,7 @@ static TemporalComponent temporal(final Temporal temporal) {
/**
* Creates a new temporal component with the specified temporal value and text color.
*
* @param temporal the temporal value
* @param temporal the temporal value
* @param textColor the text color
* @return the temporal component
*/
Expand All @@ -99,7 +99,7 @@ static TemporalComponent temporal(final Temporal temporal, final ComponentColor
/**
* Creates a new temporal component with the specified temporal value and text textStyle.
*
* @param temporal the temporal value
* @param temporal the temporal value
* @param textStyle the text textStyle
* @return the temporal component
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ static TextComponent text(final String content) {
/**
* Creates a new text component with the specified content and text color.
*
* @param content the content
* @param content the content
* @param textColor the text color
* @return the text component
*/
Expand All @@ -57,7 +57,7 @@ static TextComponent text(final String content, final ComponentColor textColor)
/**
* Creates a new text component with the specified content and text textStyle.
*
* @param content the content
* @param content the content
* @param textStyle the text textStyle
* @return the text component
*/
Expand All @@ -78,7 +78,7 @@ static TextComponent text(final char ch) {
/**
* Creates a new text component with the specified character and text color.
*
* @param ch the character
* @param ch the character
* @param textColor the text color
* @return the text component
*/
Expand All @@ -89,7 +89,7 @@ static TextComponent text(final char ch, final ComponentColor textColor) {
/**
* Creates a new text component with the specified character and text textStyle.
*
* @param ch the character
* @param ch the character
* @param textStyle the text textStyle
* @return the text component
*/
Expand Down
Loading

0 comments on commit 8560806

Please sign in to comment.