fixed javadoc

leaderos-net · Jan 22, 2024 · 1a0aec5 · 1a0aec5
1 parent a37c9be
commit 1a0aec5
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 2 deletions.
diff --git a/bukkit/src/main/java/net/leaderos/plugin/api/modules/credit/CreditManager.java b/bukkit/src/main/java/net/leaderos/plugin/api/modules/credit/CreditManager.java
@@ -36,6 +36,7 @@ public Double get(String player) {
      * Sets player's credit
      * @param target to set credit
      * @param amount to set
+     * @return true if success
      */
     public boolean set(String target, Double amount) {
         Response setCreditResponse = CreditHelper.setCreditRequest(target, amount);
@@ -47,6 +48,7 @@ public boolean set(String target, Double amount) {
      * Adds player's credit
      * @param target to add credit
      * @param amount to add
+     * @return true if success
      */
     public boolean add(String target, Double amount) {
         Response addCreditResponse = CreditHelper.addCreditRequest(target, amount);
@@ -58,6 +60,7 @@ public boolean add(String target, Double amount) {
      * Removes player's credit
      * @param target to remove credit
      * @param amount to remove
+     * @return true if success
      */
     public boolean remove(String  target, Double amount) {
         Response removeCreditResponse = CreditHelper.removeCreditRequest(target, amount);
@@ -70,6 +73,7 @@ public boolean remove(String  target, Double amount) {
      * @param sender sender of credit
      * @param target receiver of credit
      * @param amount to send
+     * @return null if success, error if not
      */
     public Error send(String sender, String target, Double amount) {
         Response sendCreditResponse = CreditHelper.sendCreditRequest(sender, target, amount);

diff --git a/bukkit/src/main/java/net/leaderos/plugin/helpers/ChatUtil.java b/bukkit/src/main/java/net/leaderos/plugin/helpers/ChatUtil.java
@@ -80,6 +80,7 @@ public static List<String> color(List<String> list) {
     /**
      * Get colored message with prefix
      * @param message to send
+     * @return colored message
      */
     public static String getMessage(String message) {
         return ChatUtil.color(replacePlaceholders(message, new Placeholder("{prefix}",

diff --git a/bukkit/src/main/java/net/leaderos/plugin/helpers/GuiHelper.java b/bukkit/src/main/java/net/leaderos/plugin/helpers/GuiHelper.java
@@ -88,6 +88,7 @@ public static ItemStack addItemIcon() {
 
     /**
      * WebStore GUI add credit icon
+     * @param credits to show
      *
      * @return add item icon
      */

diff --git a/bukkit/src/main/java/net/leaderos/plugin/modules/webstore/gui/ConfirmPurchaseGui.java b/bukkit/src/main/java/net/leaderos/plugin/modules/webstore/gui/ConfirmPurchaseGui.java
@@ -56,6 +56,7 @@ public static void showGui(Player player, Product product) {
 
     /**
      * ConfirmPurchase GUI add product icon
+     * @param product to buy
      *
      * @return product icon
      */
@@ -70,6 +71,9 @@ public static StaticGuiElement productIcon(Product product) {
 
     /**
      * ConfirmPurchase GUI add confirm button
+     * @param player to buy product
+     * @param product to buy
+     * @param gui to manage gui
      *
      * @return confirm icon
      */
@@ -90,6 +94,7 @@ public static StaticGuiElement confirmIcon(Player player, Product product, Inven
 
     /**
      * ConfirmPurchase GUI add cancel button
+     * @param gui to manage gui
      *
      * @return cancel icon
      */

diff --git a/bungee/src/main/java/net/leaderos/bungee/helpers/ChatUtil.java b/bungee/src/main/java/net/leaderos/bungee/helpers/ChatUtil.java
@@ -66,6 +66,7 @@ public static List<String> color(List<String> list) {
     /**
      * Get colored message with prefix
      * @param message to send
+     * @return colored message
      */
     public static String getMessage(String message) {
         return ChatUtil.color(replacePlaceholders(message, new Placeholder("{prefix}",

diff --git a/shared/src/main/java/net/leaderos/shared/helpers/DebugAPI.java b/shared/src/main/java/net/leaderos/shared/helpers/DebugAPI.java
@@ -10,6 +10,7 @@ public interface DebugAPI {
     /**
      * Sends debug to console
      * @param message to debug
+     * @param strict if true, it will send debug message even if debug mode is disabled
      */
     void send(String message, boolean strict);
 

diff --git a/...d/src/main/java/net/leaderos/shared/model/request/impl/donations/GetDonationsRequest.java b/...d/src/main/java/net/leaderos/shared/model/request/impl/donations/GetDonationsRequest.java
@@ -8,7 +8,7 @@ public class GetDonationsRequest extends GetRequest {
     /**
      * Request constructor
      *
-     * @param api of request
+     * @param type of request
      * @throws IOException for HttpUrlConnection
      */
     public GetDonationsRequest(String type) throws IOException {

diff --git a/shared/src/main/java/net/leaderos/shared/model/request/impl/store/ListingRequest.java b/shared/src/main/java/net/leaderos/shared/model/request/impl/store/ListingRequest.java
@@ -8,7 +8,6 @@ public class ListingRequest extends GetRequest {
     /**
      * Request constructor
      *
-     * @param api of request
      * @throws IOException for HttpUrlConnection
      */
     public ListingRequest() throws IOException {

diff --git a/velocity/src/main/java/net/leaderos/velocity/Velocity.java b/velocity/src/main/java/net/leaderos/velocity/Velocity.java
@@ -111,6 +111,7 @@ public class Velocity {
      * @param server proxyserver
      * @param logger logger class
      * @param dataDirectory data path
+     * @param metricsFactory bStats metrics
      */
     @Inject
     public Velocity(ProxyServer server, Logger logger, @DataDirectory Path dataDirectory, Metrics.Factory metricsFactory) {
-Original file line number
+Diff line change
@@ Expand Up / @@ -88,6 +88,7 @@ public static ItemStack addItemIcon() { @@
         /**
          * WebStore GUI add credit icon
+         * @param credits to show
          *
          * @return add item icon
          */
@@ Expand Down @@