base api refactoring and javadocs

This commit is contained in:
Draylar
2021-03-12 16:12:19 -06:00
parent cb52c91b6a
commit f0ecc69d6b
4 changed files with 39 additions and 13 deletions
@@ -5,6 +5,13 @@ import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* Represents a description on a config entry.
*
* <p>
* When a configuration is serialized, any field elements with the {@link Comment} annotation
* will be prefixed with a // comment on the previous line, with the value specified by this annotation.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Comment {