Package com.github.joschi.jadconfig.documentation

Annotation Interface Documentation

@Documented @Retention(RUNTIME) @Target(FIELD) public @interface Documentation
This annotation is used to document configuration files. It allows autogeneration of config documentation.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    value
    Description of this configuration property.
    boolean
    visible
    We don't want to expose some configuration fields to users.

  • Element Details

    • visible

      boolean visible
      We don't want to expose some configuration fields to users. They are internal, required for system packages functionality or deprecated. Set to false if you want to hide this field from documentation.
      Default:
      true

    • value

      String value
      Description of this configuration property.
      Default:
      ""