From 14a5f416494439eed1275f03fe51dc0643e573b5 Mon Sep 17 00:00:00 2001
From: carm <carm@carm.cc>
Date: Sun, 16 Feb 2025 02:14:15 +0800
Subject: [PATCH] docs: Add missing javadocs

---
 .../carm/lib/configuration/source/loader/PathGenerator.java   | 4 ++--
 .../configuration/source/meta/ConfigurationMetaHolder.java    | 1 +
 .../carm/lib/configuration/source/option/StandardOptions.java | 2 +-
 .../carm/lib/configuration/value/impl/CachedConfigValue.java  | 4 ++++
 4 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/core/src/main/java/cc/carm/lib/configuration/source/loader/PathGenerator.java b/core/src/main/java/cc/carm/lib/configuration/source/loader/PathGenerator.java
index 827fc69..df9701e 100644
--- a/core/src/main/java/cc/carm/lib/configuration/source/loader/PathGenerator.java
+++ b/core/src/main/java/cc/carm/lib/configuration/source/loader/PathGenerator.java
@@ -87,7 +87,7 @@ public class PathGenerator {
      * Get the configuration name of the specified element.
      * Use the naming convention of all lowercase and "-" links.
      * <p>
-     * e.g. "SOME_NAME" -> "some-name"
+     * e.g. "SOME_NAME" will be "some-name"
      *
      * @param name source name
      * @return the final path
@@ -104,7 +104,7 @@ public class PathGenerator {
                 // The content that is not named in all caps is then converted
                 .replaceAll("([a-z])=([A-Z])", "$1_$2")
                 // Remove any extra horizontal lines
-                .replaceAll("=", "")
+                .replace("=", "")
                 // Replace the underscore with a dash
                 .replace("_", "-")
                 // Finally, convert it to all lowercase
diff --git a/core/src/main/java/cc/carm/lib/configuration/source/meta/ConfigurationMetaHolder.java b/core/src/main/java/cc/carm/lib/configuration/source/meta/ConfigurationMetaHolder.java
index fce23be..48da5c1 100644
--- a/core/src/main/java/cc/carm/lib/configuration/source/meta/ConfigurationMetaHolder.java
+++ b/core/src/main/java/cc/carm/lib/configuration/source/meta/ConfigurationMetaHolder.java
@@ -108,6 +108,7 @@ public class ConfigurationMetaHolder {
      * @param type  {@link ConfigurationMetadata}
      * @param value Value of meta
      * @param <V>   Value type
+     * @return Previous value of meta
      */
     @SuppressWarnings("unchecked")
     public <V> @Nullable V setIfPresent(@NotNull ConfigurationMetadata<V> type, @Nullable V value) {
diff --git a/core/src/main/java/cc/carm/lib/configuration/source/option/StandardOptions.java b/core/src/main/java/cc/carm/lib/configuration/source/option/StandardOptions.java
index 1da01ad..79143cc 100644
--- a/core/src/main/java/cc/carm/lib/configuration/source/option/StandardOptions.java
+++ b/core/src/main/java/cc/carm/lib/configuration/source/option/StandardOptions.java
@@ -13,7 +13,7 @@ public interface StandardOptions {
     ConfigurationOption<Character> PATH_SEPARATOR = of('.');
 
     /**
-     * Whether to set & save default values if offered and not exists in configuration.
+     * Whether to set and save default values if offered and not exists in configuration.
      */
     ConfigurationOption<Boolean> SET_DEFAULTS = of(true);
 
diff --git a/core/src/main/java/cc/carm/lib/configuration/value/impl/CachedConfigValue.java b/core/src/main/java/cc/carm/lib/configuration/value/impl/CachedConfigValue.java
index 802a00a..6d18db5 100644
--- a/core/src/main/java/cc/carm/lib/configuration/value/impl/CachedConfigValue.java
+++ b/core/src/main/java/cc/carm/lib/configuration/value/impl/CachedConfigValue.java
@@ -59,6 +59,8 @@ public abstract class CachedConfigValue<T> extends ConfigValue<T> {
     }
 
     /**
+     * @param adapter Value adapter
+     * @param <O>     Base object type
      * @return Value's parser, parse base object to value.
      */
     protected <O> @Nullable ValueParser<O> parserFor(@NotNull ValueAdapter<O> adapter) {
@@ -69,6 +71,8 @@ public abstract class CachedConfigValue<T> extends ConfigValue<T> {
     }
 
     /**
+     * @param adapter Value adapter
+     * @param <O>     Base object type
      * @return Value's serializer, parse value to base object.
      */
     protected <O> @Nullable ValueSerializer<O> serializerFor(@NotNull ValueAdapter<O> adapter) {