component-installation-plugin / com.intershop.gradle.component.installation.filter / FormattedProperties / addComment

addComment

fun addComment(key: String, comment: Array<String>): Unit

Add a commented property without a value.

Parameters

key - The key of a property.

comment - Comment of a property.

fun addComment(key: String, value: String?, comment: Array<String>, changeValue: Boolean): Unit

Add a commented property with a value.

Parameters

key - The key of a property.

value - The value of the property. (It is also possible to set a null value.)

comment - This string array is used for the comment.

changeValue - The value of an existing property will be changed.