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

Align @throws and @param properly

Browse source
This commit is contained in:
JeremyStar™ 2024-07-31 04:04:24 +02:00
parent 8792813e34
commit 02001103d6
Signed by: JeremyStarTM
GPG key ID: E366BAEF67E4704D
4 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
base/src/main/java/de/staropensource/sosengine/base/internal/placeholders/crashhandler/Stacktrace.java
View file

@ -73,7 +73,7 @@ public final class Stacktrace implements Placeholder {
/** /**
* Returns the full stack trace. * Returns the full stack trace.
* *
* @param throwable throwable to operate on * @param throwable throwable to operate on
* @param stacktrace stacktrace to append and return * @param stacktrace stacktrace to append and return
* @return full stack trace * @return full stack trace
* @since v1-alpha2 * @since v1-alpha2

8
base/src/main/java/de/staropensource/sosengine/base/internal/reflection/ReflectionAccessWidener.java
View file

@ -68,7 +68,7 @@ public final class ReflectionAccessWidener {
* @param reflectionField {@link ReflectionField} to unlock * @param reflectionField {@link ReflectionField} to unlock
* @return updated modifiers. pass those to {@link #lockModifications(ReflectionField, int)} to lock the field again * @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 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) * @see #lockModifications(ReflectionField, int)
* @since v1-alpha2 * @since v1-alpha2
*/ */
@ -105,7 +105,7 @@ public final class ReflectionAccessWidener {
* @param reflectionMethod {@link ReflectionMethod} to unlock * @param reflectionMethod {@link ReflectionMethod} to unlock
* @return updated modifiers. pass those to {@link #lockModifications(ReflectionMethod, int)} to lock the method again * @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 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) * @see #lockModifications(ReflectionMethod, int)
* @since v1-alpha2 * @since v1-alpha2
*/ */
@ -149,7 +149,7 @@ public final class ReflectionAccessWidener {
* @param reflectionField {@link ReflectionField} to lock * @param reflectionField {@link ReflectionField} to lock
* @param updatedModifiers original modifiers * @param updatedModifiers original modifiers
* @throws UnexpectedThrowableException if the {@code modifiers} field is missing * @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) * @see #unlockModifications(ReflectionField)
* @since v1-alpha2 * @since v1-alpha2
*/ */
@ -180,7 +180,7 @@ public final class ReflectionAccessWidener {
* @param reflectionMethod {@link ReflectionMethod} to lock * @param reflectionMethod {@link ReflectionMethod} to lock
* @param updatedModifiers original modifiers * @param updatedModifiers original modifiers
* @throws UnexpectedThrowableException if the {@code modifiers} field is missing * @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) * @see #unlockModifications(ReflectionMethod)
* @since v1-alpha2 * @since v1-alpha2
*/ */

18
base/src/main/java/de/staropensource/sosengine/base/reflection/ReflectionMethod.java
View file

@ -163,7 +163,7 @@ public final class ReflectionMethod {
* *
* @param newValue new presence of the {@code final} modifier * @param newValue new presence of the {@code final} modifier
* @throws UnexpectedThrowableException if the {@code modifiers} field is missing * @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 * @since v1-alpha2
*/ */
public void setFinal(boolean newValue) throws UnexpectedThrowableException, NoAccessException { 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 * @param newValue new presence of the {@code static} modifier
* @throws UnexpectedThrowableException if the {@code modifiers} field is missing * @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 * @since v1-alpha2
*/ */
public void setStatic(boolean newValue) throws UnexpectedThrowableException, NoAccessException { 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 * @param newValue new presence of the {@code abstract} modifier
* @throws UnexpectedThrowableException if the {@code modifiers} field is missing * @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 * @since v1-alpha2
*/ */
public void setAbstract(boolean newValue) throws UnexpectedThrowableException, NoAccessException { 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 * @param newValue new presence of the {@code synchronized} modifier
* @throws UnexpectedThrowableException if the {@code modifiers} field is missing * @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 * @since v1-alpha2
*/ */
public void setSynchronized(boolean newValue) throws UnexpectedThrowableException, NoAccessException { public void setSynchronized(boolean newValue) throws UnexpectedThrowableException, NoAccessException {
@ -347,12 +347,12 @@ public final class ReflectionMethod {
* *
* @param args arguments to pass * @param args arguments to pass
* @return method return value * @return method return value
* @throws UnexpectedThrowableException if the {@code modifiers} field could not be found * @throws UnexpectedThrowableException if the {@code modifiers} field could not be found
* @throws NoAccessException if access to the method has been denied * @throws NoAccessException if access to the method has been denied
* @throws InvalidMethodSignature if the method signature is incorrect * @throws InvalidMethodSignature if the method signature is incorrect
* @throws InvocationTargetException covers exceptions thrown by the method * @throws InvocationTargetException covers exceptions thrown by the method
* @throws InstanceMethodFromStaticContextException when the target method is non-static and called from a static context * @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 * @since v1-alpha2
*/ */
public @Nullable Object invoke(Object... args) throws UnexpectedThrowableException, NoAccessException, InvalidMethodSignature, InvocationTargetException, InstanceMethodFromStaticContextException, StaticInitializerException { public @Nullable Object invoke(Object... args) throws UnexpectedThrowableException, NoAccessException, InvalidMethodSignature, InvocationTargetException, InstanceMethodFromStaticContextException, StaticInitializerException {

2
graphics/src/main/java/de/staropensource/sosengine/graphics/classes/Window.java
View file

@ -757,7 +757,7 @@ public abstract class Window implements AutoCloseable {
/** /**
* Builds a new {@link Window} instance. * 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 * @throws UnexpectedThrowableException thrown when creating a new {@link Window} instance fails
* @return {@link Window} instance * @return {@link Window} instance
* @since v1-alpha2 * @since v1-alpha2