Skip to content

Commit

Permalink
fix newlines on javadocs
Browse files Browse the repository at this point in the history
  • Loading branch information
ENDERZOMBI102 committed Apr 11, 2022
1 parent a9e98c4 commit b0bb0ed
Show file tree
Hide file tree
Showing 8 changed files with 34 additions and 26 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import java.util.function.Consumer;

/**
* Internal class, should not be used.
* Internal class used by LoaderComplex implementations, should not be used by addons.
*/
public abstract class LoaderComplex {
private final AddonLoader addonLoader = new AddonLoader();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
import java.util.jar.Attributes;
import java.util.jar.Manifest;

/**
* Some common utilities used in many parts of LoaderComplex
*/
public final class Utils {
private Utils() { }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@
import java.util.HashMap;
import java.util.Map;

/**
* Represents an addon for LoaderComplex.<br/>
*<br/>
* All addons must have an implementation of this class.
*/
public interface Addon {

/**
Expand All @@ -15,12 +20,12 @@ public interface Addon {

/**
* Getter for the authors of this addon
* @return a ,-separated list of names
* @return a comma-separated list of names
*/
String getAuthors();

/**
* Getter for this addon's name.
* Getter for this addon's name.<br/>
* If this returns null, the name will be obtained from the file name.
* @return addon's name
*/
Expand All @@ -38,13 +43,13 @@ public interface Addon {

/**
* Getter for the Addon's links
* The map may contain the following keys:
* - source
* - discord
* - website
* - issues
* The map may contain the following keys:<br/>
* - source<br/>
* - discord<br/>
* - website<br/>
* - issues<br/>
*
* @apiNote some LoaderComplex implementations may not show all links
* <b>NOTE:</b> some LoaderComplex implementations may not show all links
*/
default Map<String, String> getLinks() { return new HashMap<>(); }
}
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
import org.jetbrains.annotations.ApiStatus;

/**
* The main LoaderComplex interface, many methods require this as parameter.
*
* The main LoaderComplex interface, many methods require this as parameter.<br/>
* <br/>
* This is the main way you'll be able to interact with the underlying modloader
*/
public interface Loader {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@
import javax.naming.OperationNotSupportedException;

/**
* The Registry is the main way of registering stuff in the game.
* It also provides a way to get the underlying game registry and check if a resource is registered.
*
* This may be used to register:
* - Items
* - Blocks
* - ItemGroups
* The Registry is the main way of registering stuff in the game.<br/>
* It also provides a way to get the underlying game registry and check if a resource is registered.<br/>
* <br/>
* This may be used to register:<br/>
* - Items<br/>
* - Blocks<br/>
* - ItemGroups<br/>
*/
public interface Registry {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
import java.util.Random;

/**
* Represents an extensible block.
*
* Represents an extensible block.<br/>
* <br/>
* Any block implemented by addons should extend this class.
*/
public abstract class Block {
Expand All @@ -31,7 +31,7 @@ public abstract class Block {
public float slipperiness = 0.6F;

/**
* Internal field, do not use.
* Internal field, do not use.<br/>
* Holds the Loader-Specific wrapper instance for this block
*/
@ApiStatus.Internal
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
import org.jetbrains.annotations.ApiStatus;

/**
* Represents an extensible item.
*
* Represents an extensible item.<br/>
* <br/>
* Any item implemented by addons should extend this class.
*/
public abstract class Item {
Expand All @@ -29,7 +29,7 @@ public abstract class Item {
public String translationKey;

/**
* Internal field, do not use.
* Internal field, do not use.<br/>
* Holds the Loader-Specific wrapper instance for this item
*/
public Object implementationItem;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
import java.util.jar.JarFile;

/**
* Container for an addon implementation.
*
* Container for an addon implementation.<br/>
* <br/>
* Contains various info about an addon such as id and description.
*/
public class AddonContainer {
Expand Down

0 comments on commit b0bb0ed

Please sign in to comment.