From 6f35fb56584e051b93c869a79c59da19a7fe6d3a Mon Sep 17 00:00:00 2001 From: Martin Prokoph Date: Tue, 14 Jan 2025 10:35:14 +0100 Subject: [PATCH] docs: improve javadocs --- .../java/eu/midnightdust/lib/config/MidnightConfig.java | 8 +++++--- 1 file changed, 5 insertions(+), 3 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 c1b2a78..1ec6c50 100755 --- a/common/src/main/java/eu/midnightdust/lib/config/MidnightConfig.java +++ b/common/src/main/java/eu/midnightdust/lib/config/MidnightConfig.java @@ -496,7 +496,7 @@ public abstract class MidnightConfig { /** * Entry Annotation
- * - width: The maximum character length of the {@link String}, {@link Identifier} or String/Identifier {@link List} field
+ * - width: The maximum character length of the {@link String}, {@link Identifier} or String/Identifier {@link List<>} field
* - min: The minimum value of the int, float or double field
* - max: The maximum value of the int, float or double field
* - name: The name of the field in the config screen
@@ -536,16 +536,18 @@ public abstract class MidnightConfig { @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface Client {} /** - * Hides the entry on singleplayer/client-side. - * Accessible through{@code /midnightconfig MOD_ID ENTRY} and through directly editing the config file. + * Hides the entry in config screens, but still makes it + * accessible through the command {@code /midnightconfig MOD_ID ENTRY} and directly editing the config file. */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface Server {} /** * Hides the entry entirely. * Accessible only through directly editing the config file. + * Perfect for saving persistent internal data. */ @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface Hidden {} + @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface Comment { boolean centered() default false; String category() default "default";