Package org.kingdoms.config

Annotation Interface Comment

@Documented @Target(FIELD) @Retention(RUNTIME) public @interface Comment
Used for generating comments inside YAMLs for enums.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String[]
    value
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    forParent
    Whether the defined comment is for the node's parent (MappingNode) or for the node itself.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    BLANK
     

  • Field Details

  • Element Details

    • forParent

      boolean forParent
      Whether the defined comment is for the node's parent (MappingNode) or for the node itself.
      Default:
      false