ConfigDocsModule
Attributes
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
Members list
Type members
Classlikes
ConfigDocs holds the descriptions and details of a Config which can be used to produce documentation.
ConfigDocs holds the descriptions and details of a Config which can be used to produce documentation.
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
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.
Value parameters
- rows:
-
A table consist of multiple
TableRows where eachTableRowholds the information about the config path.
Attributes
- Companion
- object
- Supertypes
- Self type
Value members
Concrete methods
Generate documentation based on the Config, where a Config is a structure representing the logic to fetch the application config from various sources.
Generate documentation based on the Config, where a Config 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: Config[MyAppConfig] = ???
generatedDocs(configDescriptor).toTable.toGithubFlavouredMarkdown