Render the output of --version
Moduleopt-env-conf-0.15.0.3Haskell2010
OptEnvConf.Doc
Contents
Synopsis
- value renderVersionPage
- value parserDocs
- value commandParserDocs
- value renderHelpPage
- value renderCommandHelpPage
- value renderManPage
- value renderReferenceDocumentation
- value parserOptDocs
- value docsToOptDocs
- value renderLongOptDocs
- value renderShortOptDocs
- value parserEnvDocs
- value docsToEnvDocs
- value renderEnvDocs
- value parserConfDocs
- value docsToConfDocs
- value renderConfDocs
- data AnyDocs
- data SetDoc
- data OptDoc
- data EnvDoc
- data ConfDoc
- data CommandDoc
- value settingSetDoc
- value renderSetDoc
- value settingOptDoc
- value renderOptDocLong
- value settingEnvDoc
- value renderEnvDoc
- value settingConfDoc
- value renderConfDoc
- value helpLines
- Packageopt-env-conf-0.15.0.3
- Exports32
- LanguageHaskell2010
- LicenceLGPL-3.0-only
- SourceDoc.hs
Derive parser documentation
API Note: We return a Maybe inside the AnyDocs so that we can keep track of hidden settings and use this information to know whether settings are optional or not.
Render the output of top-level --help
Render the output of a --help with at least one command
Render the output of `--render-man-page` for reading with man
Render reference documentation
Render long-form documentation of options
Render short-form documentation of options
Render documentation of envionment variables
Render documentation of configuration values
Internal
Constructors
AnyDocsCommands !(Maybe String) [CommandDoc a]AnyDocsAnd ![AnyDocs a]AnyDocsOr ![AnyDocs a]AnyDocsSingle !a
Constructors
SetDocsetDocTryArgument :: !BoolsetDocTrySwitch :: !BoolsetDocTryOption :: !BoolsetDocDasheds :: ![Dashed]setDocEnvVars :: !Maybe (NonEmpty String)setDocConfKeys :: !Maybe (NonEmpty (NonEmpty String, JSONSchema))setDocDefault :: !Maybe StringsetDocExamples :: ![String]setDocMetavar :: !Maybe MetavarsetDocHelp :: !Maybe String
Constructors
OptDocoptDocTryArgument :: !BooloptDocTrySwitch :: !BooloptDocTryOption :: !BooloptDocDasheds :: ![Dashed]optDocDefault :: !Maybe StringoptDocExamples :: ![String]optDocMetavar :: !Maybe MetavaroptDocHelp :: !Maybe String
Constructors
EnvDocenvDocVars :: !NonEmpty StringenvDocDefault :: !Maybe StringenvDocExamples :: ![String]envDocMetavar :: !Maybe MetavarenvDocHelp :: !Maybe String
Constructors
ConfDocconfDocKeys :: !NonEmpty (NonEmpty String, JSONSchema)confDocDefault :: !Maybe StringconfDocExamples :: ![String]confDocHelp :: !Maybe String
Constructors
Instances2Functor, Show
Functor CommandDocDefined in opt-env-conf-0.15.0.3 · OptEnvConf.DocShow a => Show (CommandDoc a)Defined in opt-env-conf-0.15.0.3 · OptEnvConf.Doc