Skip to content

Commit

Permalink
Javadoc pass and utility cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
2008Choco committed Feb 11, 2024
1 parent b6583d6 commit 90bbfe5
Show file tree
Hide file tree
Showing 29 changed files with 627 additions and 362 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,22 @@
import org.jetbrains.annotations.NotNull;

/**
* Represents the different methods of activating vein miner.
* Represents a different method of activating vein miner.
*/
public enum ActivationStrategy implements Predicate<VeinMinerPlayer> {

/**
* Never activated. Disabled.
* Never activated.
*/
NONE("None", Predicates.alwaysFalse()),

/**
* Activated by the client with a client-sided mod.
* Activated by the client with the client-sided mod.
*/
CLIENT("Client", VeinMinerPlayer::isClientKeyPressed),

/**
* Activated when a player is holding sneak.
* Activated when a player is sneaking.
*/
SNEAK("Sneak", player -> player.getPlayer().isSneaking()),

Expand All @@ -45,8 +45,8 @@ private ActivationStrategy(@NotNull String friendlyName, @NotNull Predicate<Vein
}

/**
* Get the friendly name for this activation strategy. In most cases, this is just the name
* of the enum with more appropriate capitalization.
* Get the friendly name for this activation strategy. This is just the name of the enum
* with more appropriate capitalization.
*
* @return the friendly name
*/
Expand All @@ -58,7 +58,7 @@ public String getFriendlyName() {
/**
* Check whether or not the given player has activated this strategy.
*
* @param player the player to check
* @param player the player
*
* @return true if active, false otherwise
*/
Expand All @@ -73,7 +73,7 @@ public boolean test(VeinMinerPlayer player) {
* This method exists purely for the sake of clarity and simply delegates to
* {@link #test(VeinMinerPlayer)}.
*
* @param player the player to check
* @param player the player
*
* @return true if active, false otherwise
*/
Expand Down
Loading

0 comments on commit 90bbfe5

Please sign in to comment.