From 02001103d694cc6d43e5b705dfaa4c1d1911cb4c Mon Sep 17 00:00:00 2001 From: JeremyStarTM Date: Wed, 31 Jul 2024 04:04:24 +0200 Subject: [PATCH] Align @throws and @param properly --- .../placeholders/crashhandler/Stacktrace.java | 2 +- .../reflection/ReflectionAccessWidener.java | 8 ++++---- .../base/reflection/ReflectionMethod.java | 18 +++++++++--------- .../sosengine/graphics/classes/Window.java | 2 +- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/Stacktrace.java b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/Stacktrace.java index c98bde4..86900b2 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/Stacktrace.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/Stacktrace.java @@ -73,7 +73,7 @@ public final class Stacktrace implements Placeholder { /** * Returns the full stack trace. * - * @param throwable throwable to operate on + * @param throwable throwable to operate on * @param stacktrace stacktrace to append and return * @return full stack trace * @since v1-alpha2 diff --git a/base/src/main/java/de/staropensource/sosengine/base/internal/reflection/ReflectionAccessWidener.java b/base/src/main/java/de/staropensource/sosengine/base/internal/reflection/ReflectionAccessWidener.java index 70288a5..7caf5dd 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/internal/reflection/ReflectionAccessWidener.java +++ b/base/src/main/java/de/staropensource/sosengine/base/internal/reflection/ReflectionAccessWidener.java @@ -68,7 +68,7 @@ public final class ReflectionAccessWidener { * @param reflectionField {@link ReflectionField} to unlock * @return updated modifiers. pass those to {@link #lockModifications(ReflectionField, int)} to lock the field again * @throws UnexpectedThrowableException if the {@code modifiers} field is missing - * @throws NoAccessException if access to the field has been denied + * @throws NoAccessException if access to the field has been denied * @see #lockModifications(ReflectionField, int) * @since v1-alpha2 */ @@ -105,7 +105,7 @@ public final class ReflectionAccessWidener { * @param reflectionMethod {@link ReflectionMethod} to unlock * @return updated modifiers. pass those to {@link #lockModifications(ReflectionMethod, int)} to lock the method again * @throws UnexpectedThrowableException if the {@code modifiers} field is missing - * @throws NoAccessException if access to the method has been denied + * @throws NoAccessException if access to the method has been denied * @see #lockModifications(ReflectionMethod, int) * @since v1-alpha2 */ @@ -149,7 +149,7 @@ public final class ReflectionAccessWidener { * @param reflectionField {@link ReflectionField} to lock * @param updatedModifiers original modifiers * @throws UnexpectedThrowableException if the {@code modifiers} field is missing - * @throws NoAccessException if access to the field has been denied + * @throws NoAccessException if access to the field has been denied * @see #unlockModifications(ReflectionField) * @since v1-alpha2 */ @@ -180,7 +180,7 @@ public final class ReflectionAccessWidener { * @param reflectionMethod {@link ReflectionMethod} to lock * @param updatedModifiers original modifiers * @throws UnexpectedThrowableException if the {@code modifiers} field is missing - * @throws NoAccessException if access to the method has been denied + * @throws NoAccessException if access to the method has been denied * @see #unlockModifications(ReflectionMethod) * @since v1-alpha2 */ diff --git a/base/src/main/java/de/staropensource/sosengine/base/reflection/ReflectionMethod.java b/base/src/main/java/de/staropensource/sosengine/base/reflection/ReflectionMethod.java index 4a5a712..b38f1f8 100644 --- a/base/src/main/java/de/staropensource/sosengine/base/reflection/ReflectionMethod.java +++ b/base/src/main/java/de/staropensource/sosengine/base/reflection/ReflectionMethod.java @@ -163,7 +163,7 @@ public final class ReflectionMethod { * * @param newValue new presence of the {@code final} modifier * @throws UnexpectedThrowableException if the {@code modifiers} field is missing - * @throws NoAccessException if access to the {@code modifiers} field has been denied + * @throws NoAccessException if access to the {@code modifiers} field has been denied * @since v1-alpha2 */ public void setFinal(boolean newValue) throws UnexpectedThrowableException, NoAccessException { @@ -198,7 +198,7 @@ public final class ReflectionMethod { * * @param newValue new presence of the {@code static} modifier * @throws UnexpectedThrowableException if the {@code modifiers} field is missing - * @throws NoAccessException if access to the {@code modifiers} field has been denied + * @throws NoAccessException if access to the {@code modifiers} field has been denied * @since v1-alpha2 */ public void setStatic(boolean newValue) throws UnexpectedThrowableException, NoAccessException { @@ -233,7 +233,7 @@ public final class ReflectionMethod { * * @param newValue new presence of the {@code abstract} modifier * @throws UnexpectedThrowableException if the {@code modifiers} field is missing - * @throws NoAccessException if access to the {@code modifiers} field has been denied + * @throws NoAccessException if access to the {@code modifiers} field has been denied * @since v1-alpha2 */ public void setAbstract(boolean newValue) throws UnexpectedThrowableException, NoAccessException { @@ -268,7 +268,7 @@ public final class ReflectionMethod { * * @param newValue new presence of the {@code synchronized} modifier * @throws UnexpectedThrowableException if the {@code modifiers} field is missing - * @throws NoAccessException if access to the {@code modifiers} field has been denied + * @throws NoAccessException if access to the {@code modifiers} field has been denied * @since v1-alpha2 */ public void setSynchronized(boolean newValue) throws UnexpectedThrowableException, NoAccessException { @@ -347,12 +347,12 @@ public final class ReflectionMethod { * * @param args arguments to pass * @return method return value - * @throws UnexpectedThrowableException if the {@code modifiers} field could not be found - * @throws NoAccessException if access to the method has been denied - * @throws InvalidMethodSignature if the method signature is incorrect - * @throws InvocationTargetException covers exceptions thrown by the method + * @throws UnexpectedThrowableException if the {@code modifiers} field could not be found + * @throws NoAccessException if access to the method has been denied + * @throws InvalidMethodSignature if the method signature is incorrect + * @throws InvocationTargetException covers exceptions thrown by the method * @throws InstanceMethodFromStaticContextException when the target method is non-static and called from a static context - * @throws StaticInitializerException when an the static initializer fails + * @throws StaticInitializerException when an the static initializer fails * @since v1-alpha2 */ public @Nullable Object invoke(Object... args) throws UnexpectedThrowableException, NoAccessException, InvalidMethodSignature, InvocationTargetException, InstanceMethodFromStaticContextException, StaticInitializerException { diff --git a/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/Window.java b/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/Window.java index cf04f16..540a157 100644 --- a/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/Window.java +++ b/graphics/src/main/java/de/staropensource/sosengine/graphics/classes/Window.java @@ -757,7 +757,7 @@ public abstract class Window implements AutoCloseable { /** * Builds a new {@link Window} instance. * - * @throws IllegalStateException if the window title, size or position is unset + * @throws IllegalStateException if the window title, size or position is unset * @throws UnexpectedThrowableException thrown when creating a new {@link Window} instance fails * @return {@link Window} instance * @since v1-alpha2