mirror/Slimefun4
mirror/Slimefun4
1
Fork 0
mirror of https://github.com/StarWishsama/Slimefun4.git synced 2024-09-20 03:35:51 +00:00
Code Releases Activity

Improved documentation in Category and Alloy

Browse Source
This commit is contained in:
Florian CUNY 2018-01-06 15:26:01 +01:00
parent 7851f33b57
commit f2a74bb46c
2 changed files with 32 additions and 73 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

93
src/me/mrCookieSlime/Slimefun/Objects/Category.java
View File

@ -15,14 +15,11 @@ import me.mrCookieSlime.Slimefun.api.Slimefun;
import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.ItemStack;
/** /**
* Statically handles categories. Represents a category, which structure * Statically handles categories.
* multiple {@link SlimefunItem} in the Slimefun Guide. * Represents a category, which structure multiple {@link SlimefunItem} in the guide.
* <p>
* See {@link #Category(ItemStack)} to create a category.
* <p> * <p>
* See {@link Categories} for the built-in categories. * See {@link Categories} for the built-in categories.
* *
* @author TheBusyBiscuit
* @since 4.0 * @since 4.0
* *
* @see LockedCategory * @see LockedCategory
@ -30,7 +27,7 @@ import org.bukkit.inventory.ItemStack;
*/ */
public class Category { public class Category {
/** /**
* Contains all the registered Categories. * List of the registered Categories.
* @since 4.0 * @since 4.0
* @see Categories * @see Categories
*/ */
@ -42,24 +39,12 @@ public class Category {
private int tier; private int tier;
/** /**
* The basic constructor for a Category. * Constructs a Category with the given display item.
* <p> * The tier is set to a default value of {@code 3}.
* Create a new category by calling {@link #Category(ItemStack)}.
* <br>
* The display item can be created using {@link ItemStack}, however using CSCoreLib's
* {@link CustomItem} or even {@link MenuItem} is highly recommended.
* <br>
* Instead of {@link #Category(ItemStack, int)}, where the tier is customizable,
* it will here automatically be set to 3.
* <p>
* Major part of category declaration is handled by Slimefun itself.
* <br>
* See {@link #add(SlimefunItem)} and {@link #register()} for more information.
* *
* @param item The display item for this category * @param item the display item for this category
* *
* @since 4.0 * @since 4.0
* @see #Category(ItemStack, int)
*/ */
public Category(ItemStack item) { public Category(ItemStack item) {
this.item = item; this.item = item;
@ -69,25 +54,14 @@ public class Category {
} }
/** /**
* The constructor for a Category. * Constructs a Category with the given display item and the provided tier.
* <p> * </br>
* Create a new category by calling {@link #Category(ItemStack, int)}. * A lower tier results in this category being displayed first.
* <br>
* The display item can be created using {@link ItemStack}, however using CSCoreLib's
* {@link CustomItem} or even {@link MenuItem} is highly recommended.
* <br>
* The tier defines where the category will be displayed in the Slimefun Guide.
* A lower tier will display the category first.
* <p>
* Major part of category declaration is handled by Slimefun itself.
* <br>
* See {@link #add(SlimefunItem)} and {@link #register()} for more information.
* *
* @param item The display item for this category * @param item the display item for this category
* @param tier The tier of this category * @param tier the tier for this category
* *
* @since 4.0 * @since 4.0
* @see #Category(ItemStack)
*/ */
public Category(ItemStack item, int tier) { public Category(ItemStack item, int tier) {
this.item = item; this.item = item;
@ -97,12 +71,9 @@ public class Category {
} }
/** /**
* Registers the category. * Registers this category.
* <p> * <p>
* By default, the category gets automatically registered when a {@link SlimefunItem} * By default, a category is automatically registered when a {@link SlimefunItem} is bound to it.
* is bound to it.
* <br>
* See {@link SlimefunItem#register(boolean)} for more details.
* *
* @since 4.0 * @since 4.0
*/ */
@ -118,9 +89,9 @@ public class Category {
} }
/** /**
* Gets the list of all registered categories. * Gets the list of the registered categories.
* *
* @return the list of registered categories * @return the list of the registered categories
* *
* @since 4.0 * @since 4.0
* @see Categories * @see Categories
@ -130,26 +101,20 @@ public class Category {
} }
/** /**
* Bounds a {@link SlimefunItem} to the category. * Bounds the provided {@link SlimefunItem} to this category.
* <p>
* By default, a SlimefunItem gets automatically bound to a Category when it gets
* registered.
* <br>
* See {@link SlimefunItem#register(boolean)} for more information.
* *
* @param item SlimefunItem to bound to this category * @param item the SlimefunItem to bound to this category
* *
* @since 4.0 * @since 4.0
* @see #getItems()
*/ */
public void add(SlimefunItem item) { public void add(SlimefunItem item) {
items.add(item); items.add(item);
} }
/** /**
* Gets the display item of the category. * Returns the display item of this category.
* *
* @return the category's display item * @return the display item of this category
* *
* @since 4.0 * @since 4.0
*/ */
@ -158,9 +123,9 @@ public class Category {
} }
/** /**
* Gets the list of all items bound to the category. * Returns the list of SlimefunItems bound to this category.
* *
* @return the list of all items bound to this category * @return the list of SlimefunItems bound to this category
* *
* @since 4.0 * @since 4.0
*/ */
@ -171,7 +136,7 @@ public class Category {
/** /**
* Attempts to get the category with the given display item. * Attempts to get the category with the given display item.
* *
* @param item Display item of the category to get * @param item the display item of the category to get
* @return Category if found, or null * @return Category if found, or null
* *
* @since 4.0 * @since 4.0
@ -184,21 +149,20 @@ public class Category {
} }
/** /**
* Gets the URID of the category. * Returns the {@link URID} of this category.
* *
* @return the category's URID * @return the URID of this category
* *
* @since 4.0 * @since 4.0
* @see URID
*/ */
public URID getURID() { public URID getURID() {
return urid; return urid;
} }
/** /**
* Gets the tier of the category. * Returns the tier of this category.
* *
* @return the category's tier * @return the tier of this category
* *
* @since 4.0 * @since 4.0
*/ */
@ -207,16 +171,11 @@ public class Category {
} }
/** /**
* /!\ Documentation needed here.
*
* @author TheBusyBiscuit
* @since 4.0 * @since 4.0
*/ */
class CategorySorter implements Comparator<Category> { class CategorySorter implements Comparator<Category> {
/** /**
* /!\ Documentation needed here.
*
* @since 4.0 * @since 4.0
*/ */
@Override @Override

4
src/me/mrCookieSlime/Slimefun/Objects/SlimefunItem/Alloy.java
View File

@ -7,7 +7,7 @@ import me.mrCookieSlime.Slimefun.Objects.Category;
import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.ItemStack;
/** /**
* Represents an alloy, obtainable using the {@code SMELTERY}. * Represents an alloy, a {@link SlimefunItem} obtainable using the {@code SMELTERY}.
* <p> * <p>
* An alloy is generally made up of several minerals. * An alloy is generally made up of several minerals.
* As an example, {@code BRASS_INGOT} is made up of {@code COPPER_DUST}, {@code ZINC_DUST} and {@code COPPER_INGOT}. * As an example, {@code BRASS_INGOT} is made up of {@code COPPER_DUST}, {@code ZINC_DUST} and {@code COPPER_INGOT}.
@ -17,7 +17,7 @@ import org.bukkit.inventory.ItemStack;
public class Alloy extends SlimefunItem { public class Alloy extends SlimefunItem {
/** /**
* Constructs an Alloy automatically bound to {@code Categories.RESOURCES}. * Constructs an Alloy bound to {@code Categories.RESOURCES}.
* *
* @param item the item corresponding to this Alloy * @param item the item corresponding to this Alloy
* @param id the id of this Alloy * @param id the id of this Alloy