Giter Club home page Giter Club logo

core-api's People

Contributors

dev-json avatar lapotor avatar snabeldier avatar strafbefehl avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

core-api's Issues

[Docs] Missing `@return` Tag for `Registrant.getBankAccount()` Method

/**
* Gets the bank account that is associated with this registrant.
* Departments may not have their own bank account. If this registrant is a department without its own bank account,
* this method will return the bank account of the departments company/organisation.
*/
BankAccount getBankAccount();

The absence of the @return tag for the getBankAccount() method of the Registrant class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getBankAccount() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `RecipeItemBuilder.replaceItemAfterCrafting()` Method

/**
* Replace the item after the craft-process
*
* @param item the replaced item
*/
RecipeItemBuilder replaceItemAfterCrafting(ItemStack item);

The absence of the @return tag for the replaceItemAfterCrafting() method of the RecipeItemBuilder class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the replaceItemAfterCrafting() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Packet.getContents()` Method

/**
* Gets the contents of this packet.
*/
ItemStack[] getContents();

The absence of the @return tag for the getContents() method of the Packet class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getContents() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Residence.getOwner()` Method

/**
* The owner has full permission over his residence. The ownership only changes if the residence is sold or transmitted.
* <br>
* <b>Note:</b> The owner of an apartment is its renter! To get the landlord, use the apartment-object and check for its landlord.
* The result of getOwner() might be null! This is only the case, if the residence is for sale / for rent.
* Plots for sale keep their owner until they are bought. To check, whether a plot is for sale, check the getSale()-method.
*/
Registrant getOwner();

The absence of the @return tag for the getOwner() method of the Residence class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getOwner() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Registrant.getName()` Method

/**
* Gets the name to display on signs etc.
* <p>
* <b>Department:</b> "name of department - name of company/association"
* <p>
* <b>Note:</b> department names may be longer than 16 characters and can therefore not been put onto signs!
*/
String getName();

The absence of the @return tag for the getName() method of the Registrant class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getName() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@param` Tag for `Core.registerListeners()` Method

/**
* @deprecated use {@link #registerListener(Listener)} instead!
*/
@Deprecated
public static void registerListeners(Listener listener) {

The absence of the @param tag for the listener parameter for the registerListeners() method of the Core class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the registerListeners() method by including the necessary @param tag for the listener parameter. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@param` and `@return` Tag for `RecipeBuilder.setPowerConsumption()` Method

/**
* Set the recipe power craft costs
*
*/
RecipeBuilder setPowerConsumption(int powerConsumption);

The absence of @param tag for the powerConsumption parameter and @return tag for the setPowerConsumption() method of the RecipeBuilder class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the setPowerConsumption() method by including the necessary @param tag for the powerConsumption parameter and the @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Fix Unexpected End Tag in JavaDoc for `FixedPlayerInteractEvent` Class

/**
* This event equals the PlayerInteractEvent. It is called when a player interacts with an object or air.
* <p>
* Things we changed:
* <p>- Event is only called when a player also has the permission to interact (knocked out; frozen by team)</p>
* - Event is only called once, even though the player uses two hands as in the PlayerInteractEvent</p>
* <p>
* <i>Credits: This class consists largely of Spigot's PlayerInteractEvent class.</i>
*/
@Getter
public class FixedPlayerInteractEvent extends PlayerEvent implements Cancellable {

The JavaDoc for the FixedPlayerInteractEvent class in the Core API contains an unexpected issue. There is a redundant </p> end tag that needs to be removed.

To resolve this, simply remove the extra </p> end tag and ensure that the JavaDoc for the FixedPlayerInteractEvent class is properly formatted. This correction will enhance the readability and correctness of the documentation.

Suggestion to use dependabot or renovatebot

Description

This is a suggestion to use dependabot or renovatebot on the Core-API repository. These tools can help automate the process of updating dependencies and keep the project up-to-date with the latest security patches and bug fixes.

Benefits

  • Saves time and effort by automating dependency updates.
  • Keeps the project up-to-date with the latest security patches and bug fixes.
  • Helps maintain a healthy and secure codebase.

Proposed Solution

It is proposed that dependabot or renovatebot be used to manage dependencies on this repository. Both tools are widely used and have proven to be effective in keeping projects up-to-date with the latest dependencies.

Additional Information

Update README to be more informative

  • remove current api version (why does it need to include that?)
  • remove the latest change (maybe a changelog instead?)
  • add some information how to install the api (jitpack or maven profile)

[Docs] Missing `@return` Tag for `Residence.getSign()` Method

/**
* The ResidenceSign displays important information about the residence. It is also used to take actions on it.
* It is placed outside the residence. Players use it to take actions, sell or buy the resident.
* Every Resident has a sign, but merged plots unplace their sign and use the residence sign of the main plot.
* When unmerging a plot, the original residence sign is replaced.
*/
ResidenceSign getSign();

The absence of the @return tag for the getSign() method of the Residence class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getSign() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Parcel.getTarget()` Method

/**
* Gets this parcels intended addressee.
*/
Registrant getTarget();

The absence of the @return tag for the getTarget() method of the Parcel class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getTarget() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@param` Tags for `Registrant.deliverParcel()` Method

/**
* Delivers the given parcel securely. If this registrant doesn't have an address, it is sent to...
* <br>
* if registrant is a department: to the associated group.
* <br>
* if registrant is a group: to the group's owner.
* <br>
* if registrant is a user: to a parcel shop.
*/
void deliverParcel(Parcel parcel);

The absence of the @param tag for the parcel parameter for the deliverParcel() method of the Registrant class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the deliverParcel() method by including the necessary @param tag for the parcel parameter. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Task.participate()` Method

/**
* Lets a user enter this task.
*
* @param user user to enter this task
*/
boolean participate(User user);

The absence of the @return tag for the participate() method of the Task class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the participate() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Parcel.asItem()` Method

/**
* Returns an item that represents this parcel and can be opened by team members and the addressee.
*/
ItemStack asItem();

The absence of the @return tag for the asItem() method of the Parcel class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the asItem() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Malformed HTML in JavaDoc for `DatabaseEntry.getLocation()` Method

/**
* Gets the location at the given column (with pitch & yaw).
*
* @param column name of the column
* @return location at given column from the selected database entry
*/
Location getLocation(String column);

The JavaDoc for the getLocation() method contains malformed HTML. Specifically, the use of the & character is not in the correct HTML entity format.

To address this issue, it is recommended to replace the raw & with the appropriate HTML entity, such as &amp;. This correction ensures proper rendering and compliance with HTML standards in the JavaDoc documentation.

[Docs] Render issues in JavaDoc for `RecipeBuilder.setIngredients()` Method

/**
* Set the ingredients which are needed for the recipe
* If the recipe is marked as "setShapeless(true)" this list is used for <Slot, Item> detection
*
* @param ingredients List of ingredients
*/
RecipeBuilder setIngredients(Map<Integer, RecipeItem> ingredients);

HTML Malformed

Error Message
[ERROR] D:\CodeHub\Core-API\src\main\java\minevalley\core\api\crafting\recipe\builder\RecipeBuilder.java:25: error: malformed HTML
[ERROR]      * If the recipe is marked as "setShapeless(true)" this list is used for <Slot, Item> detection
[ERROR]                                                                              ^
[ERROR] D:\CodeHub\Core-API\src\main\java\minevalley\core\api\crafting\recipe\builder\RecipeBuilder.java:25: error: bad use of '>'
[ERROR]      * If the recipe is marked as "setShapeless(true)" this list is used for <Slot, Item> detection
[ERROR]                                                                                         ^

The JavaDoc for the setIngredients() method contains malformed HTML. Specifically, the use of the < and > character is not in the correct HTML entity format.

To address this issue, it is recommended to replace the raw < and > with the appropriate HTML entity. This correction ensures proper rendering and compliance with HTML standards in the JavaDoc documentation.

Missing Tag

The absence of the @return tag for the setIngredients() method of the RecipeBuilder class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the setIngredients() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `RecipeItemBuilder.setItem()` Method

/**
* Sets the Item
*
* @param item the craft component
*/
RecipeItemBuilder setItem(ItemStack item);

The absence of the @return tag for the setItem() method of the RecipeItemBuilder class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the setItem() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

performCommand(), chat() methods

should be added within one of the next updates:

performCommand(String command)

chat(String message)

chat(MessageType type, String message)

MessageType (enum):
NORMAL,
WHISPHER,
SHOUT,
FRACTION,
ACTION

[Docs] Missing `@param` Tag for `Group.changeName()` Method

/**
* Sets the name of this group.
*
* @return Result of rename
*/
RenameFeedback changeName(String name);

The absence of the @param tag for the name parameter for the changeName() method of the Group class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the changeName() method by including the necessary @param tag for the name parameters This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Parcel.getSender()` Method

/**
* Gets the sender of this parcel.
*/
Registrant getSender();

The absence of the @return tag for the getSender() method of the Parcel class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getSender() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@param` and `@return` Tag for `Core.getAreaOfBlock()` Method

/**
* Gets an area object with only one block.
*/
public static Area getAreaOfBlock(Block block) {

The absence of @param tag for the block parameter and @return tag for the getAreaOfBlock() method of the Core class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getAreaOfBlock() method by including the necessary @param tag for the block parameter and the @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Fix Unexpected End Tag in JavaDoc for `Core.createItem()` Method

/**
* Creates new item-builder out of a custom head, based on its link.
* <p>
* Example - head from <a href="https://minecraft-heads.com/custom-heads">head-database</a>:
* The url to the head is:
* 68c2f1f7e8cd6b00d30f0edaeefce38e889173c30c701fac0da860e0a2125ec8
* <p>
* You can use this url to get the head. It doesn't matter whether you're using the whole link (starting with "textures.minecraft.net") or just using the number, as shown above.
* <p>
* Note: Always cache heads you already created! Getting/creating new heads can be a waste of server-performance. A simple way to cash all heads used in inventories, is to load the with the onEnable()-method.
*
* @param url link to <span style="text-decoration:underline;">or</span></span> the id of the specific head
* @return item-builder based on the chosen head
*/
public static ItemBuilder createItem(String url) {

The JavaDoc for the createItem() method in the Core API contains an unexpected issue. There is a redundant </span> end tag that needs to be removed.

To resolve this, simply remove the extra </span> end tag and ensure that the JavaDoc for the createItem() method is properly formatted. This correction will enhance the readability and correctness of the documentation.

[Docs] Malformed HTML in JavaDoc for `Recipe.getRecipeIngredients()` Method

/**
* Get the needed recipe ingredients
* If the recipe is marked as "setShapeless(true)" this list is used for <Slot, Item> detection
*
* @return Map with ingredients and slots
*/
Map<Integer, RecipeItem> getRecipeIngredients();

The JavaDoc for the getRecipeIngredients() method contains malformed HTML. Specifically, the use of the < and > character is not in the correct HTML entity format.

To address this issue, it is recommended to replace the raw < and > with the appropriate HTML entity. This correction ensures proper rendering and compliance with HTML standards in the JavaDoc documentation.

[Docs] Missing `@return` Tag for `BankAccount.getAmountInCents()` Method

/**
* Gets the amount of money in this bank account.
*/
int getAmountInCents();

The absence of the @return tag for the getAmountInCents() method of the BankAccount class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getAmountInCents() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@param` Tags for `Core.unregisterEvent()` Method

/**
* @deprecated use {@link #unregisterListener(Class, EventListener)} instead!
*/
@Deprecated
public static void unregisterEvent(Class<? extends Event> cls, EventListener listener) {

The absence of @param tags for the cls and listener parameters for the unregisterEvent() method of the Core class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the unregisterEvent() method by including the necessary @param tags for the cls and listener parameters. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Parcel.getRemainingMinutes()` Method

/**
* Gets the minutes that remain, until this parcel is delivered to the mailbox of the target.
* This is only an approximation. Parcels may be delivered up to five minutes earlier or later.
*/
int getRemainingMinutes();

The absence of the @return tag for the getRemainingMinutes() method of the Parcel class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getRemainingMinutes() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Residence.getPermissioned()` Method

/**
* Permissioned users are allowed to build and have access to locked chests (and other locked blocks) if they are set up this way.
* The list of permissioned users can be edited by the owner or the admins of this residence.
* <br>
* <b>Note:</b> This method only gives a copy of the original list. use the grantPermission and revokePermission method to adjust the contents.
* Future changes won't be added to this list.
*/
List<Registrant> getPermissioned();

The absence of the @return tag for the getPermissioned() method of the Residence class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getPermissioned() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@param` Tags for `Core.registerEvent()` Method

/**
* @deprecated use {@link #registerListener(Class, EventListener)} instead!
*/
@Deprecated
public static void registerEvent(Class<? extends Event> cls, EventListener listener) {

The absence of @param tags for the cls and listener parameters for the registerEvent() method of the Core class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the registerEvent() method by including the necessary @param tags for the cls and listener parameters. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Residence.getStreet()` Method

/**
* Every Residence has a Street. If this residence is a player-created apartment,
* the street is the same as the one from the plot, this apartment lies on.
* If the apartment lies on a merged plot, the street will be taken from the plotmerges main plot.
*/
Street getStreet();

The absence of the @return tag for the getStreet() method of the Residence class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getStreet() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@param` and `@return` Tag for `RecipeBuilder.setRecipeName()` Method

/**
* Set the recipe name
*
*/
RecipeBuilder setRecipeName(String name);

The absence of @param tag for the name parameter and @return tag for the setRecipeName() method of the RecipeBuilder class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the setRecipeName() method by including the necessary @param tag for the name parameter and the @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Letter.getPages()` Method

/**
* Gets the content of this letter.
*/
String[] getPages();

The absence of the @return tag for the getPages() method of the Letter class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getPages() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Registrant.getCroppedName()` Method

/**
* Takes the registrant's name, but truncates it if it's longer than 16 characters.
*/
default String getCroppedName() {

The absence of the @return tag for the getCroppedName() method of the Registrant class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getCroppedName() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Residence.getRegion()` Method

/**
* Every Residence is associated with a region. This region defines the habitat in which the user is allowed to build.
* <br>
* <b>Note:</b> Since Residences can be plots that are merged to other ones, keep in mind that there might be other
* residences that are merged with this one. Therefore, it might be necessary to get the merged regions and the
* merging regions (regions between merged plots), too.
*/
Region getRegion();

The absence of the @return tag for the getRegion() method of the Residence class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getRegion() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Registrant.getAddress()` Method

/**
* Gets the address of this registrant.
* <br>
* This might be null!
* <br>
* If this registrant is a department without its own address, this will return the groups address.
* If this registrant is a group without its own address, this will return the address of the owner.
*/
Residence getAddress();

The absence of the @return tag for the getAddress() method of the Registrant class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getAddress() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Residence.getAdmins()` Method

/**
* Admin users have full permission for everything, the owner can access to, but:
* <br>
* - Admins aren't allowed to add / remove other admins
* <br>
* - Admins can't sell / reset / unrent the residence.
* <br>
* - Admins can't merge plots
* <br>
* They are allowed to add / remove users as permissioned users.
* The list of admins users can only be edited by the owner of this residence.
* <br>
* <b>Note:</b> This method only gives a copy of the original list. use the grantAdminPermission and
* revokeAdminPermission method to adjust the contents.
* Future changes won't be added to this list.
*/
List<Registrant> getAdmins();

The absence of the @return tag for the getAdmins() method of the Residence class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getAdmins() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@param` and `@return` Tag for `RecipeBuilder.setOutputItem()` Method

/**
* Set the item that's gonna crafted
*
*/
RecipeBuilder setOutputItem(ItemStack output);

The absence of @param tag for the output parameter and @return tag for the setOutputItem() method of the RecipeBuilder class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the setOutputItem() method by including the necessary @param tag for the output parameter and the @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Residence.getLocation()` Method

/**
* Every residence has a specific location. When creating new plots or apartments, the teamer has to define this location.
* It is used for teamlers to teleport to a specific residence and is used as navigation target,
* whenever a user tries to navigate to this residence.
* In case this residence is an apartment created by a player, this location is set to the location of the ResidenceSign.
*/
Location getLocation();

The absence of the @return tag for the getLocation() method of the Residence class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getLocation() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Residence.getId()` Method

/**
* Each residence can be clearly identified by its ID. The Residences IDs are unique, regardless if it's a plot
* or an apartment. There'll be neither a plot nor an apartment with the same ID as this one. The ID won't change.
*/
int getId();

The absence of the @return tag for the getId() method of the Residence class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getId() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `RecipeItemBuilder.setIgnoreMetadata()` Method

/**
* Set if the craft component needs to match with the metadata from the inserted item (displayname, amount, meta)
* Notice: If there is a specific amount of items needed: Please get the amount from the item above!
*
* @param ignoreMetadata boolean if meta is important
*/
RecipeItemBuilder setIgnoreMetadata(boolean ignoreMetadata);

The absence of the @return tag for the setIgnoreMetadata() method of the RecipeItemBuilder class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the setIgnoreMetadata() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@param` Tag for `Task.setRecipeName()` Method

/**
* Sets the wage paid to the user who completes this task.
*/
void setWage(int wageInCents);

The absence of the @param tag for the name parameter for the setRecipeName() method of the Task class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the setRecipeName() method by including the necessary @param tag for the name parameter. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@param` and `@return` Tag for `Residence.isPermissioned()` Method

/**
* Checks whether a user is part of the permissioned users list.
* <br>
* <b>Note:</b> The user doesn't have to be mentioned in the list! He just might be member of a
* company/organisation/department that is listed as a permissioned user!
*/
boolean isPermissioned(User user);

The absence of @param tag for the user parameter and @return tag for the isPermissioned() method of the Residence class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the isPermissioned() method by including the necessary @param tag for the user parameter and the @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `RecipeItemBuilder.addRequirement()` Method

/**
* Add a new Requirement to the current item
*
* @param requirement requirement which data the item needs to match
*/
RecipeItemBuilder addRequirement(Requirement requirement);

The absence of the @return tag for the addRequirement() method of the RecipeItemBuilder class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the addRequirement() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@param` Tag for `Core.createFakeArmorStand()` Method

/**
* Creates an armorstand with a consumer
*
* @return ArmorStand instance
*/
public static FakeArmorStand createFakeArmorStand(Location location) {

The absence of @param tag for the listener parameter for the createFakeArmorStand() method of the Core class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the createFakeArmorStand() method by including the necessary @param tags for the listener parameter. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Malformed HTML in JavaDoc for `Core.convertColorCodes()` Method

/**
* Converts chat-color-codes to normal color-codes (& -> §)
*
* @param text string which could contain chat-color-codes
* @return string with converted color-codes
*/
public static String convertColorCodes(String text) {

The JavaDoc for the convertColorCodes() method contains malformed HTML. Specifically, the use of the & and > character is not in the correct HTML entity format.

To address this issue, it is recommended to replace the raw & and > with the appropriate HTML entity, such as &amp;. This correction ensures proper rendering and compliance with HTML standards in the JavaDoc documentation.

[Docs] Missing `@return` Tag for `Apartment.getApartmentBlock()` Method

/**
* Is null, when this apartment is not part of an apartment block!
*/
ApartmentBlock getApartmentBlock();

The absence of the @return tag for the getApartmentBlock() method of the Apartment class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getApartmentBlock() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `RecipeBuilder.setShapeless()` Method

/**
* Defines if the recipe is a shapeless or shaped recipe
*
* @param shapeless If the recipe is shapeless or not
*/
RecipeBuilder setShapeless(boolean shapeless);

The absence of the @return tag for the setShapeless() method of the RecipeBuilder class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the setShapeless() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Residence.getMailbox()` Method

/**
* Residences have to have a mailbox specified, to be rented by a player. Whenever a user tries to add a new apartment
* he is asked to add a mailbox. If he doesn't add one, he should not be able to open the apartment for anyone to rent.
* He might still use the apartment for personal purpose but is not able to define a rent nor search for renters.
* <br>
* If a plot gets merged with another one, its mailbox will get unplaced by the system. In this case, all contents are
* directly delivered to the mailbox of the main plot (without time delay). Every plot merge does have a mailbox on
* its main plot. If there is mail added to an unplaced mailbox, the system redirects the mail automatically to its new destination (main plot).
*/
Mailbox getMailbox();

The absence of the @return tag for the getMailbox() method of the Residence class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the getMailbox() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Missing `@return` Tag for `Group.addMember()` Method

/**
* Adds a member to this group.
* <p>
* <b>Note:</b> The user will be added to the default department!
*
* @param user member to add
*/
Member addMember(User user);

The absence of the @return tag for the addMember() method of the Group class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the addMember() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

[Docs] Render issues in JavaDoc for `RecipeBuilder.addIngredients()` Method

/**
* Add a new ingredient which is needed for the recipe
* If the recipe is marked as "setShapeless(true)" this list is used for <Slot, Item> detection
* When you are using a shapeless recipe just count the slot+1 everytime you add a new ingredient
*
* @param slot Slot of the item
* @param item RecipeItem Object
*/
RecipeBuilder addIngredient(int slot, RecipeItem item);

HTML Malformed

Error Message
[ERROR] D:\CodeHub\Core-API\src\main\java\minevalley\core\api\crafting\recipe\builder\RecipeBuilder.java:33: error: malformed HTML
[ERROR]      * If the recipe is marked as "setShapeless(true)" this list is used for <Slot, Item> detection
[ERROR]                                                                              ^
[ERROR] D:\CodeHub\Core-API\src\main\java\minevalley\core\api\crafting\recipe\builder\RecipeBuilder.java:33: error: bad use of '>'
[ERROR]      * If the recipe is marked as "setShapeless(true)" this list is used for <Slot, Item> detection
[ERROR]                                                                                         ^

The JavaDoc for the addIngredients() method contains malformed HTML. Specifically, the use of the < and > character is not in the correct HTML entity format.

To address this issue, it is recommended to replace the raw < and > with the appropriate HTML entity. This correction ensures proper rendering and compliance with HTML standards in the JavaDoc documentation.

Missing Tag

The absence of the @return tag for the addIngredients() method of the RecipeBuilder class is causing a significant issue. This omission is breaking the JavaDoc generation process during the build.

To resolve this issue, update the JavaDoc for the addIngredients() method by including the necessary @return tag. This will not only fix the JavaDoc generation problem but also ensure that developers have essential information about the method's parameters.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.