tuweni / org.apache.tuweni.config / SchemaBuilder / documentProperty

documentProperty

fun documentProperty(key: String!, description: String!): SchemaBuilder! (source)

Provide documentation for a property.

Invoking this method with the same key as a previous invocation will replace the description for that key.

Parameters

key - String!: The configuration property key.

description - String!: The description to associate with the property.

Exceptions

IllegalArgumentException - If the key cannot be parsed.

Return
SchemaBuilder!: This builder.