extract

fun extract(klass: KClass<*>, prefix: String = ""): Map<String, CommentData>

Recursively extracts Comment annotations from the primary constructor parameters of klass and all nested data classes.

The returned map uses dot-separated paths as keys (e.g., "server.port") and CommentData as values containing the comment lines and placement.

Return

A map of dot-separated property paths to their CommentData. Returns an empty map if klass has no primary constructor or no annotated parameters.

Since

1.0

Parameters

klass

The KClass to extract comments from. Must be a data class with a primary constructor for meaningful results.

prefix

The dot-separated path prefix for nested extraction. Defaults to "" (root level). Callers typically do not set this; it is used internally during recursion.

See also