extra documentation on PreviousNames

Polyfrost · Jul 24, 2024 · c4a30f2 · c4a30f2
1 parent 9514375
commit c4a30f2
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/...g-impl/src/main/java/org/polyfrost/oneconfig/api/config/v1/annotations/PreviousNames.java b/...g-impl/src/main/java/org/polyfrost/oneconfig/api/config/v1/annotations/PreviousNames.java
@@ -30,10 +30,16 @@
 
 /**
  * Annotation used to specify previous names that this option was called before, so that when the user updates their mod, their config will be kept intact.
+ * Format: {"oldCategory.oldSubcategory.oldName1", "oldCategory.oldName2", ...}
+ * Just putting the old name will **NOT** work, you must specify the old category and subcategory (if applicable) as well.
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target(ElementType.FIELD)
 @Documented
 public @interface PreviousNames {
+    /**
+     * Format: {"oldCategory.oldSubcategory.oldName1", "oldCategory.oldName2", ...}
+     * Just putting the old name will **NOT** work, you must specify the old category and subcategory (if applicable) as well.
+     */
     String[] value();
 }