Update API documentation

base/src/main/java/de/staropensource/sosengine/base/logging/LoggerInstance.java

@@ -238,8 +238,8 @@ public final class LoggerInstance {
         /**
          * Builds a new {@link LoggerInstance} instance.
          *
-         * @return new {@link LoggerInstance}
-         * @throws IllegalStateException if the class or origin is unset
+         * @return new {@link LoggerInstance} instance
+         * @throws IllegalStateException if {@link #clazz} is unset
          * @since v1-alpha2
          */
         public LoggerInstance build() throws IllegalStateException {
@@ -294,6 +294,7 @@ public final class LoggerInstance {
          *
          * @param clazz new class of the issuer
          * @return builder instance
+         * @see LoggerInstance#clazz
          * @since v1-alpha2
          */
         public @NotNull Builder setClazz(@Nullable Class<?> clazz) {
@@ -306,6 +307,7 @@ public final class LoggerInstance {
          *
          * @param origin new origin of the issuer
          * @return builder instance
+         * @see LoggerInstance#origin
          * @since v1-alpha2
          */
         public @NotNull Builder setOrigin(@Nullable String origin) {
@@ -318,6 +320,7 @@ public final class LoggerInstance {
          *
          * @param metadata new metadata about the issuer
          * @return builder instance
+         * @see LoggerInstance#metadata
          * @since v1-alpha2
          */
         public @NotNull Builder setMetadata(@Nullable String metadata) {

base/src/main/java/de/staropensource/sosengine/base/type/DependencyVector.java

@@ -173,8 +173,8 @@ public class DependencyVector {
         /**
          * Builds a new {@link DependencyVector} instance.
          *
-         * @return new {@link DependencyVector}
-         * @throws IllegalStateException when the identifier, versioning system or version is unset or the version string is invalid
+         * @return new {@link DependencyVector} instance
+         * @throws IllegalStateException if {@link #identifier}, {@link #versioningSystem} or {@link #version} is unset or the version string is invalid
          * @since v1-alpha4
          */
         public @NotNull DependencyVector build() throws IllegalStateException {

windowing/src/main/java/de/staropensource/sosengine/windowing/implementable/Window.java

@@ -736,7 +736,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 {@link #title}, {@link #size} or {@link #position} is unset
          * @throws Exception             thrown when creating a new {@link Window} instance fails
          * @return {@link Window} instance
          * @since v1-alpha2
@@ -949,6 +949,7 @@ public abstract class Window implements AutoCloseable {
          *
          * @param name new window name
          * @return builder instance
+         * @see Window#name
          * @since v1-alpha2
          */
         public @NotNull Builder setName(@Nullable String name) {
@@ -961,6 +962,7 @@ public abstract class Window implements AutoCloseable {
          *
          * @param title new window title
          * @return builder instance
+         * @see Window#title
          * @since v1-alpha2
          */
         public @NotNull Builder setTitle(@Nullable String title) {
@@ -973,6 +975,7 @@ public abstract class Window implements AutoCloseable {
          *
          * @param size new window size
          * @return builder instance
+         * @see Window#size
          * @since v1-alpha2
          */
         public @NotNull Builder setSize(@Nullable Vec2i size) {
@@ -985,6 +988,7 @@ public abstract class Window implements AutoCloseable {
          *
          * @param minimumSize new minimum window size
          * @return builder instance
+         * @see Window#minimumSize
          * @since v1-alpha2
          */
         public @NotNull Builder setMinimumSize(@Nullable Vec2i minimumSize) {
@@ -997,6 +1001,7 @@ public abstract class Window implements AutoCloseable {
          *
          * @param maximumSize new maximum window size
          * @return builder instance
+         * @see Window#maximumSize
          * @since v1-alpha2
          */
         public @NotNull Builder setMaximumSize(@Nullable Vec2i maximumSize) {
@@ -1009,6 +1014,7 @@ public abstract class Window implements AutoCloseable {
          *
          * @param position new window position
          * @return builder instance
+         * @see Window#position
          * @since v1-alpha2
          */
         public @NotNull Builder setPosition(@Nullable Vec2i position) {
@@ -1021,6 +1027,7 @@ public abstract class Window implements AutoCloseable {
          *
          * @param windowMode new window mode
          * @return builder instance
+         * @see Window#windowMode
          * @since v1-alpha2
          */
         public @NotNull Builder setWindowMode(@Nullable WindowMode windowMode) {
@@ -1033,6 +1040,7 @@ public abstract class Window implements AutoCloseable {
          *
          * @param monitor new target monitor
          * @return builder instance
+         * @see Window#monitor
          * @since v1-alpha2
          */
         private synchronized @NotNull Builder setMonitor(@Nullable Monitor monitor) {
@@ -1045,6 +1053,7 @@ public abstract class Window implements AutoCloseable {
          *
          * @param resizable new resizable flag state
          * @return builder instance
+         * @see Window#resizable
          * @since v1-alpha2
          */
         public @NotNull Builder setResizable(@NotNull Tristate resizable) {
@@ -1057,6 +1066,7 @@ public abstract class Window implements AutoCloseable {
          *
          * @param borderless new borderless flag state
          * @return builder instance
+         * @see Window#borderless
          * @since v1-alpha2
          */
         public @NotNull Builder setBorderless(@NotNull Tristate borderless) {
@@ -1069,6 +1079,7 @@ public abstract class Window implements AutoCloseable {
          *
          * @param focusable new focusable flag state
          * @return builder instance
+         * @see Window#focusable
          * @since v1-alpha2
          */
         public @NotNull Builder setFocusable(@NotNull Tristate focusable) {
@@ -1081,6 +1092,7 @@ public abstract class Window implements AutoCloseable {
          *
          * @param onTop new on top flag state
          * @return builder instance
+         * @see Window#onTop
          * @since v1-alpha2
          */
         public @NotNull Builder setOnTop(@NotNull Tristate onTop) {
@@ -1093,6 +1105,7 @@ public abstract class Window implements AutoCloseable {
          *
          * @param transparent new transparency flag state
          * @return builder instance
+         * @see Window#transparent
          * @since v1-alpha2
          */
         public @NotNull Builder setTransparent(@NotNull Tristate transparent) {
@@ -1105,6 +1118,7 @@ public abstract class Window implements AutoCloseable {
          *
          * @param rendering new rendering flag state
          * @return builder instance
+         * @see Window#rendering
          * @since v1-alpha2
          */
         public @NotNull Builder setRendering(@NotNull Tristate rendering) {