kconfig-core/club.skidware.kconfig.writer/CommentData

CommentData

data class CommentData(val lines: List<String>, val placement: CommentPlacement)

Holds the extracted comment metadata for a single configuration property.

Each instance contains the comment text lines and the desired placement strategy (inline or above the property).

Example:

val comment = CommentData(
    lines = listOf("The server port to bind to"),
    placement = CommentPlacement.INLINE
)
// Produces YAML: port: 8080  # The server port to bind to

Since

1.0

Constructors

CommentData

constructor(lines: List<String>, placement: CommentPlacement)

Properties

lines

val lines: List<String>

The individual lines of the comment text.

placement

val placement: CommentPlacement

Where the comment should be rendered relative to the property.

CommentData

Since

See also

Constructors

Properties