PureConfig: Is it possible to add Documentation to the generated Configuration File

354 Views Asked by At

I am evaluating PureConfig to read and write Configuration files.

When writing the configuration file it look like:

# hardcoded value
"name" : "messageBundle",
# hardcoded value
"params" : { ...

Is it possible to have instead of # hardcoded value an actual documentation?

So for example my case class would look like:

@doc("Message Bundle for a Language...")
case class MessageBundle(
    @doc("The name of the ....")
    name: String,
    @doc("The properties ...")
    props: Map[String, String]
) 

Would then be this configuration file:

# Message Bundle for a Language...

# The name of the ....
"name" : "messageBundle",
# The properties ...
"params" : { ...
0

There are 0 best solutions below