kconfig-core/club.skidware.kconfig.annotation/CommentPlacement

CommentPlacement

enum CommentPlacement : Enum<CommentPlacement>

Determines the position of a Comment relative to its associated configuration field in the serialized YAML output.

Usage:

@Comment("Port number", placement = CommentPlacement.INLINE)
val port: Int = 8080
Content copied to clipboard

Since

1.0

See also

Entries

Link copied to clipboard
ABOVE

Places the comment on the line(s) directly above the field. This is the default placement.

Link copied to clipboard
INLINE

Places the comment on the same line as the field, after the value.

Properties

Link copied to clipboard
val entries: EnumEntries<CommentPlacement>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

Link copied to clipboard
val name: String
Link copied to clipboard
val ordinal: Int

Functions

Link copied to clipboard
fun valueOf(value: String): CommentPlacement

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard
fun values(): Array<CommentPlacement>

Returns an array containing the constants of this enum type, in the order they're declared.