Motschen/MidnightLib
1
0
Fork 0
mirror of https://github.com/TeamMidnightDust/MidnightLib.git synced 2025-12-16 09:15:10 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve javadocs

Browse Source
This commit is contained in:
Martin Prokoph
2025-01-14 10:35:14 +01:00
parent a32593ede0
commit 6f35fb5658
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
common/src/main/java/eu/midnightdust/lib/config/MidnightConfig.java
View File

@@ -496,7 +496,7 @@ public abstract class MidnightConfig {
/** /**
* Entry Annotation<br> * Entry Annotation<br>
* - <b>width</b>: The maximum character length of the {@link String}, {@link Identifier} or String/Identifier {@link List<String>} field<br> * - <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>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>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>: The name of the field in the config screen<br>
@@ -536,16 +536,18 @@ public abstract class MidnightConfig {
@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface Client {} @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface Client {}
/** /**
* Hides the entry on singleplayer/client-side. * Hides the entry in config screens, but still makes it
* Accessible through{@code /midnightconfig MOD_ID ENTRY} and through directly editing the config file. * accessible through the command {@code /midnightconfig MOD_ID ENTRY} and directly editing the config file.
*/ */
@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface Server {} @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface Server {}
/** /**
* Hides the entry entirely. * Hides the entry entirely.
* Accessible only through directly editing the config file. * 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 Hidden {}
@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface Comment { @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.FIELD) public @interface Comment {
boolean centered() default false; boolean centered() default false;
String category() default "default"; String category() default "default";