ConfigModule
Related Doc:
package config
ConfigDocs holds the descriptions and details of a ConfigDescriptor
which can be used to produce documentation.
ConfigDocs holds the descriptions and details of a ConfigDescriptor
which can be used to produce documentation.
To specify if a singleton leaf should be considered as a valid sequence or not.
To specify if a singleton leaf should be considered as a valid sequence or not.
A Table is a recursive structure that is more easier to be interpreted as Json or Markdown than trying
to convert ConfigDocs to a readable format.
A Table is a recursive structure that is more easier to be interpreted as Json or Markdown than trying
to convert ConfigDocs to a readable format.
Generate documentation based on the ConfigDescriptor, where a
ConfigDescriptor is a structure representing the logic to fetch the application config
from various sources.
Generate documentation based on the ConfigDescriptor, where a
ConfigDescriptor is a structure representing the logic to fetch the application config
from various sources.
Once we generate the docs, this can be converted to a light weight Table structure which is much more easier to be converted
to markdown or json formats.
Example :
val configDescriptor: ConfigDescriptor[MyAppConfig] = ???
generatedDocs(configDescriptor).toTable.toGithubFlavouredMarkdown
Generate a report based on the ConfigDescriptor and an A, where a
ConfigDescriptor represents the logic to fetch the application config
from various sources, and A represents the actual config value that was retrieved.
Generate a report based on the ConfigDescriptor and an A, where a
ConfigDescriptor represents the logic to fetch the application config
from various sources, and A represents the actual config value that was retrieved.