From 82889b8c061ae6debb21d46506feba1d1ef09482 Mon Sep 17 00:00:00 2001
From: Martin Prokoph <motschen@midnightdust.eu>
Date: Mon, 21 Apr 2025 10:43:40 +0200
Subject: [PATCH] docs: improve JavaDocs

---
 .../eu/midnightdust/lib/config/MidnightConfig.java    | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

diff --git a/common/src/main/java/eu/midnightdust/lib/config/MidnightConfig.java b/common/src/main/java/eu/midnightdust/lib/config/MidnightConfig.java
index 588b1dd..355e2b8 100755
--- a/common/src/main/java/eu/midnightdust/lib/config/MidnightConfig.java
+++ b/common/src/main/java/eu/midnightdust/lib/config/MidnightConfig.java
@@ -530,7 +530,7 @@ public abstract class MidnightConfig {
      * - <b>width</b>: The maximum character length of the {@link String}, {@link Identifier} or String/Identifier {@link List<>} field<br>
      * - <b>min</b>: The minimum value of the <code>int</code>, <code>float</code> or <code>double</code> field<br>
      * - <b>max</b>: The maximum value of the <code>int</code>, <code>float</code> or <code>double</code> field<br>
-     * - <b>name</b>: The name of the field in the config screen<br>
+     * - <b>name</b>: Will be used instead of the default translation key, if not empty<br>
      * - <b>selectionMode</b>: The selection mode of the file picker button for {@link String} fields,
      *   -1 for none, {@link JFileChooser#FILES_ONLY} for files, {@link JFileChooser#DIRECTORIES_ONLY} for directories,
      *   {@link JFileChooser#FILES_AND_DIRECTORIES} for both (default: -1). Remember to set the translation key
@@ -580,11 +580,10 @@ public abstract class MidnightConfig {
 
     /**
      * Comment Annotation<br>
-     * - <b>{@link Comment#centered()}</b>: If the comment should be centered (default: false)<br>
-     * - <b>{@link Comment#category()}</b>: The category of the comment in the config screen (default
-     * "default")<br>
-     * - <b>{@link Comment#name()}</b>: The name of the comment in the config screen (default: "")<br>
-     * - <b>{@link Comment#url()}</b>: The url of the comment in the config screen, empty or blank means no url (default: "")<br>
+     * - <b>{@link Comment#centered()}</b>: If the comment should be centered<br>
+     * - <b>{@link Comment#category()}</b>: The category of the comment in the config screen<br>
+     * - <b>{@link Comment#name()}</b>: Will be used instead of the default translation key, if not empty<br>
+     * - <b>{@link Comment#url()}</b>: The url of the comment should link to in the config screen (none if left empty)<br>
      * */
     @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface Comment {
         boolean centered() default false;