ch.jalu.configme

Annotation Type SectionComments

@Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Documented
public @interface SectionComments

Annotation for methods in SettingsHolder classes that return section comments to include when saving to a file. The return type of the method must be Map<String, String[]>, where the key is the path and the String[] value contains the comments to include.

Methods annotated with this method must be accessible (i.e. public) and have return type Map<String, String[]>. Null may be returned. There may be multiple methods with this annotation.

Comments for properties can be declared on property fields with Comment but can also be provided in a section comments method. The value of a map entry may be null. Multiple SectionComments methods may return a comment for the same path; however, no guarantee is given as to which comment will be used.