StarOpenSource/Engine
StarOpenSource/Engine
2
0
Fork 1
Code Issues 10 Pull requests Releases 9 Activity Actions

Fix Javadoc documentation

Browse source
This commit is contained in:
JeremyStar™ 2024-10-15 04:07:01 +02:00
parent 2cf769b599
commit d0a68b22d2
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
3 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
base/src/main/java/de/staropensource/engine/base/type/Color.java
View file

@ -34,7 +34,7 @@ import java.util.Locale;
/** /**
* A class dedicated to colors. * A class dedicated to colors.
* Uses the RGBA format, with conversion methods * Uses the RGBA format, with conversion methods
* supporting RGB and RGBA & RGB encoded in * supporting RGB and RGBA & RGB encoded in
* bytes or hex. * bytes or hex.
* *
* @since v1-alpha6 * @since v1-alpha6
@ -103,7 +103,7 @@ public final class Color {
* -- SETTER -- * -- SETTER --
* Sets the alpha channel value. * Sets the alpha channel value.
* *
* @param red new alpha channel value * @param alpha new alpha channel value
* @since v1-alpha6 * @since v1-alpha6
*/ */
private @Range(from = 0, to = 255) int alpha; private @Range(from = 0, to = 255) int alpha;

3
base/src/main/java/de/staropensource/engine/base/utility/Math.java
View file

@ -60,6 +60,7 @@ public final class Math {
* @param min minimum value * @param min minimum value
* @param max maximum value * @param max maximum value
* @param value value * @param value value
* @return number in threshold
* @throws IndexOutOfBoundsException when the minimum value is bigger than the maximum value * @throws IndexOutOfBoundsException when the minimum value is bigger than the maximum value
* @since v1-alpha6 * @since v1-alpha6
*/ */
@ -83,6 +84,7 @@ public final class Math {
* @param min minimum value * @param min minimum value
* @param max maximum value * @param max maximum value
* @param value value * @param value value
* @return number in threshold
* @throws IndexOutOfBoundsException when the minimum value is bigger than the maximum value * @throws IndexOutOfBoundsException when the minimum value is bigger than the maximum value
* @since v1-alpha6 * @since v1-alpha6
*/ */
@ -106,6 +108,7 @@ public final class Math {
* @param min minimum value * @param min minimum value
* @param max maximum value * @param max maximum value
* @param value value * @param value value
* @return number in threshold
* @throws IndexOutOfBoundsException when the minimum value is bigger than the maximum value * @throws IndexOutOfBoundsException when the minimum value is bigger than the maximum value
* @since v1-alpha6 * @since v1-alpha6
*/ */

4
notification/src/main/java/de/staropensource/engine/notification/type/Notification.java
View file

@ -134,7 +134,7 @@ public class Notification {
* -- SETTER -- * -- SETTER --
* Sets the content of this notification. * Sets the content of this notification.
* *
* @param message new content * @param content new content
* @since v1-alpha6 * @since v1-alpha6
*/ */
private @Nullable String content = null; private @Nullable String content = null;
@ -243,6 +243,8 @@ public class Notification {
/** /**
* Creates and initializes an instance of this class. * Creates and initializes an instance of this class.
* *
* @param origin class from where the notification was emitted
* @param title title of the notification
* @since v1-alpha6 * @since v1-alpha6
*/ */
public Notification(@NotNull Class<?> origin, @NotNull String title) { public Notification(@NotNull Class<?> origin, @NotNull String title) {