[config] fix javadocs in BaseOption and ModifiableOption

OrnitheMC · Dec 12, 2024 · a1b7461 · a1b7461
1 parent 1ed5829
commit a1b7461
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 7 deletions.
diff --git a/libraries/config/src/main/java/net/ornithemc/osl/config/api/config/option/BaseOption.java b/libraries/config/src/main/java/net/ornithemc/osl/config/api/config/option/BaseOption.java
@@ -84,7 +84,7 @@ public T get() {
 	}
 
 	/**
-	 * @return whether this option's current value has changed
+	 * Sets this option to the given value.
 	 */
 	public void set(T newValue) {
 		requireLoaded();

diff --git a/...ies/config/src/main/java/net/ornithemc/osl/config/api/config/option/ModifiableOption.java b/...ies/config/src/main/java/net/ornithemc/osl/config/api/config/option/ModifiableOption.java
@@ -137,9 +137,7 @@ public void set(T value) {
 	protected abstract T unmodifiable(T value);
 
 	/**
-	 * modifies the current value of this option
-	 * 
-	 * @return whether this option's current value was modified.
+	 * Modifies the current value of this option.
 	 */
 	public void modify(Consumer<T> modifier) {
 		// save the state of the current value
@@ -159,9 +157,7 @@ public void modify(Consumer<T> modifier) {
 	}
 
 	/**
-	 * modifies the current value of this option or throws an IO exception
-	 * 
-	 * @return whether this option's current value was modified.
+	 * Modifies the current value of this option or throws an IO exception.
 	 */
 	public void modifyIO(IOConsumer<T> modifier) throws IOException {
 		// save the state of the current value