Skip to content

Commit f6d36a0

Browse files
committed
docs(main): Fixed all the Javadoc.
1 parent d854d6b commit f6d36a0

17 files changed

+63
-32
lines changed

src/main/java/fr/hashtek/spigot/hashgui/PaginatedHashGui.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public class PaginatedHashGui extends HashGui
2727
*
2828
* @param title GUI's title
2929
* @param size GUI's amount of lines (must be between 1 and 6).
30-
* @param guiManager Gui manager
30+
* @param guiManager GUI manager
3131
*/
3232
public PaginatedHashGui(String title, int size, HashGuiManager guiManager)
3333
{

src/main/java/fr/hashtek/spigot/hashgui/handler/click/HashGuiClick.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public class HashGuiClick
1515

1616

1717
/**
18-
* Creates a new instance of HashGUIClick.
18+
* Creates a new instance of HashGuiClick.
1919
*/
2020
public HashGuiClick()
2121
{

src/main/java/fr/hashtek/spigot/hashgui/handler/destroy/DestroyHandler.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ public class DestroyHandler
77

88

99
/**
10-
* Creates an empty instance of InteractHandler.
10+
* Creates an empty instance of DestroyHandler.
1111
*/
1212
public DestroyHandler() {}
1313

1414

1515
/**
1616
* Sets handler's destroy action. (on block destroy, then do...)
1717
*
18-
* @param destroyAction Interact action
18+
* @param destroyAction Destroy action
1919
* @return Returns itself.
2020
*/
2121
public DestroyHandler setDestroyAction(DestroyAction destroyAction)

src/main/java/fr/hashtek/spigot/hashgui/handler/destroy/HashGuiDestroy.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public class HashGuiDestroy
1414

1515

1616
/**
17-
* Creates a new instance of HashGUIDestroy.
17+
* Creates a new instance of HashGuiDestroy.
1818
*/
1919
public HashGuiDestroy()
2020
{
@@ -42,7 +42,7 @@ private HashGuiDestroy addDestroyHandler(String title, DestroyHandler handler)
4242
}
4343

4444
/**
45-
* Adds a hit handler for an item.
45+
* Adds a destroy handler for an item.
4646
*
4747
* @param item Item
4848
* @return Returns itself.

src/main/java/fr/hashtek/spigot/hashgui/handler/hit/HashGuiHit.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public class HashGuiHit
1414

1515

1616
/**
17-
* Creates a new instance of HashGUIInteraction.
17+
* Creates a new instance of HashGuiHit.
1818
*/
1919
public HashGuiHit()
2020
{
@@ -65,7 +65,7 @@ public HashGuiHit addHitHandler(HashItem item)
6565

6666

6767
/**
68-
* @return Registered interact handlers
68+
* @return Registered hit handlers
6969
*/
7070
public HashMap<String, ArrayList<HitHandler>> getHitHandlers()
7171
{

src/main/java/fr/hashtek/spigot/hashgui/handler/hit/HitAction.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ public interface HitAction
1010
* Function called when item is used in a hit.
1111
*
1212
* @param attacker Player who hit
13-
* @param victim Player who got hit
14-
* @param item Used item
13+
* @param victim Player who got hit
14+
* @param item Used item
1515
*/
1616
void execute(
1717
Player attacker,

src/main/java/fr/hashtek/spigot/hashgui/handler/hit/HitHandler.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ public class HitHandler
88

99

1010
/**
11-
* Creates an empty instance of InteractHandler.
11+
* Creates an empty instance of HitHandler.
1212
*/
1313
public HitHandler()
1414
{

src/main/java/fr/hashtek/spigot/hashgui/handler/hold/HoldHandler.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ public class HoldHandler
88

99

1010
/**
11-
* Creates an empty instance of ClickHandler.
11+
* Creates an empty instance of HoldHandler.
1212
*/
1313
public HoldHandler() {}
1414

@@ -38,7 +38,7 @@ public HoldHandler setNotHoldAction(HoldAction notHoldAction)
3838
}
3939

4040
/**
41-
* @param handler Handler to compare
41+
* @param handler Handler to compare
4242
* @return Returns true if both handlers contains the same instructions
4343
*/
4444
public boolean equals(HoldHandler handler)

src/main/java/fr/hashtek/spigot/hashgui/handler/interact/HashGuiInteraction.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ public class HashGuiInteraction
1515

1616

1717
/**
18-
* Creates a new instance of HashGUIInteraction.
18+
* Creates a new instance of HashGuiInteraction.
1919
*/
2020
public HashGuiInteraction()
2121
{

src/main/java/fr/hashtek/spigot/hashgui/listener/HashGuiClickListener.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ private boolean processClick(Player player, ClickType clickType, HashGui gui, It
6363
}
6464

6565
/**
66-
* Click handling
66+
* Click handling.
6767
*/
6868
@EventHandler
6969
public void onInventoryClick(InventoryClickEvent event)

0 commit comments

Comments
 (0)