setComment

fun setComment(groupName: String? = null, key: String? = null, comment: String): <Error class: unknown class><Boolean>

Places a comment above @key from @group_name.

If @key is null then @comment will be written above @group_name. If both @key and @group_name are null, then @comment will be written above the first group in the file.

Note that this function prepends a '#' comment marker to each line of @comment.

Return

true if the comment was written, false otherwise

Since

2.6

Parameters

groupName

a group name, or null

key

a key

comment

a comment