fluent-syntax/dev.kbroom.fluent.syntax/DocComment

DocComment

@Serializable

data class DocComment(val description: String = "", val variables: List<VariableDoc> = emptyList())(source)

A documentation comment associated with a message or term.

DocComments contain a description and optionally documented variables for the message/term.

Constructors

constructor(description: String = "", variables: List<VariableDoc> = emptyList())

Properties

val description: String

The main description text

val variables: List<VariableDoc>

List of variable documentations