Fix Javadoc issues

This commit is contained in:
JeremyStar™ 2024-12-01 16:39:52 +01:00
parent 2e69d37ec7
commit a2a19c03aa
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
5 changed files with 42 additions and 2 deletions

View file

@ -31,6 +31,14 @@ import java.util.Collections;
* @since v1-alpha9 * @since v1-alpha9
*/ */
public final class ArrayUtil { public final class ArrayUtil {
/**
* Creates and initializes an
* instance of this class.
*
* @since v1-alpha9
*/
private ArrayUtil() {}
/** /**
* Removes the first {@code n} elements * Removes the first {@code n} elements
* from the specified array. * from the specified array.
@ -40,6 +48,7 @@ public final class ArrayUtil {
* specified array, an empty array * specified array, an empty array
* will be returned. * will be returned.
* *
* @param <T> type
* @param array array to operate on * @param array array to operate on
* @param n amount to remove * @param n amount to remove
* @return array with the first elements removed * @return array with the first elements removed
@ -62,6 +71,7 @@ public final class ArrayUtil {
* specified array, an empty array * specified array, an empty array
* will be returned. * will be returned.
* *
* @param <T> type
* @param array array to operate on * @param array array to operate on
* @param n amount to remove * @param n amount to remove
* @return array with the last elements removed * @return array with the last elements removed

View file

@ -28,6 +28,14 @@ import org.jetbrains.annotations.Nullable;
* @since v1-alpha9 * @since v1-alpha9
*/ */
public final class StringUtil { public final class StringUtil {
/**
* Creates and initializes an
* instance of this class.
*
* @since v1-alpha9
*/
private StringUtil() {}
/** /**
* Counts the number of occurrences of the specified substring inside the specified string. * Counts the number of occurrences of the specified substring inside the specified string.
* *

View file

@ -28,6 +28,14 @@ import org.jetbrains.annotations.Range;
* @since v1-alpha9 * @since v1-alpha9
*/ */
public final class TypeConversion { public final class TypeConversion {
/**
* Creates and initializes an
* instance of this class.
*
* @since v1-alpha9
*/
private TypeConversion() {}
/** /**
* Converts a boolean into an integer. * Converts a boolean into an integer.
* *

View file

@ -214,6 +214,14 @@ public final class Renderer {
// ----> Initialization // ----> Initialization
/**
* Creates and initializes an
* instance of this class.
*
* @since v1-alpha9
*/
private Renderer() {}
/** /**
* Initializes the renderer. * Initializes the renderer.
* *

View file

@ -389,6 +389,7 @@ public final class Window implements Closeable {
* *
* @since v1-alpha9 * @since v1-alpha9
*/ */
@Getter(value = AccessLevel.NONE)
private GLFWKeyCallback keyCallback; private GLFWKeyCallback keyCallback;
/** /**
@ -397,6 +398,7 @@ public final class Window implements Closeable {
* *
* @since v1-alpha9 * @since v1-alpha9
*/ */
@Getter(value = AccessLevel.NONE)
private GLFWMouseButtonCallback mouseButtonCallback; private GLFWMouseButtonCallback mouseButtonCallback;
@ -503,7 +505,7 @@ public final class Window implements Closeable {
glfwWindowHintString(GLFW_X11_INSTANCE_NAME, name); glfwWindowHintString(GLFW_X11_INSTANCE_NAME, name);
// Create window // Create window
internalWindowIdentifier = glfwCreateWindow(1, 1, "", NULL, NULL); internalWindowIdentifier = glfwCreateWindow(size.getX(), size.getY(), "", NULL, NULL);
if (internalWindowIdentifier == NULL) if (internalWindowIdentifier == NULL)
throw new WindowCreationFailureException(); throw new WindowCreationFailureException();
@ -655,6 +657,8 @@ public final class Window implements Closeable {
if (queuedPropertyUpdates.containsKey("size")) { if (queuedPropertyUpdates.containsKey("size")) {
width.put(((Vec2i) queuedPropertyUpdates.get("size")).getX()); width.put(((Vec2i) queuedPropertyUpdates.get("size")).getX());
height.put(((Vec2i) queuedPropertyUpdates.get("size")).getY()); height.put(((Vec2i) queuedPropertyUpdates.get("size")).getY());
// TODO
if (!fresh)
glfwSetWindowSize(internalWindowIdentifier, width.get(), height.get()); glfwSetWindowSize(internalWindowIdentifier, width.get(), height.get());
} else { } else {
glfwGetWindowSize(internalWindowIdentifier, width, height); glfwGetWindowSize(internalWindowIdentifier, width, height);
@ -924,6 +928,7 @@ public final class Window implements Closeable {
* @param size new size * @param size new size
* @since v1-alpha9 * @since v1-alpha9
*/ */
@ApiStatus.Experimental
public void setSize(@NotNull Vec2i size) { public void setSize(@NotNull Vec2i size) {
// Ensure the window is not terminated // Ensure the window is not terminated
if (terminated) if (terminated)
@ -977,6 +982,7 @@ public final class Window implements Closeable {
* @param position new position * @param position new position
* @since v1-alpha9 * @since v1-alpha9
*/ */
@ApiStatus.Experimental
public void setPosition(@NotNull Vec2i position) { public void setPosition(@NotNull Vec2i position) {
// Ensure the window is not terminated // Ensure the window is not terminated
if (isTerminated()) if (isTerminated())