OptEnvConf.Doc

Documentation

renderVersionPage :: String -> Version -> [Chunk]

Render the output of --version

parserDocs :: Parser a -> AnyDocs SetDoc

Derive parser documentation

commandParserDocs :: Command a -> CommandDoc SetDoc

renderHelpPage :: String -> String -> AnyDocs SetDoc -> [Chunk]

Render the output of --help

renderCommandHelpPage :: String -> [String] -> CommandDoc SetDoc -> [Chunk]

renderManPage :: String -> Version -> String -> AnyDocs SetDoc -> [Chunk]

Render the output of `--render-man-page` for reading with man

renderReferenceDocumentation :: String -> AnyDocs SetDoc -> [Chunk]

Render reference documentation

parserOptDocs :: Parser a -> AnyDocs OptDoc

renderLongOptDocs :: AnyDocs OptDoc -> [Chunk]

Render long-form documentation of options

renderShortOptDocs :: String -> AnyDocs OptDoc -> [Chunk]

Render short-form documentation of options

parserEnvDocs :: Parser a -> AnyDocs EnvDoc

renderEnvDocs :: AnyDocs EnvDoc -> [Chunk]

Render documentation of envionment variables

parserConfDocs :: Parser a -> AnyDocs ConfDoc

renderConfDocs :: AnyDocs ConfDoc -> [Chunk]

Render documentation of configuration values

Internal

data AnyDocs a

Constructors

AnyDocsCommands [CommandDoc a]

AnyDocsAnd ![AnyDocs a]

AnyDocsOr ![AnyDocs a]

AnyDocsSingle !a

Instances

Show a => Show (AnyDocs a)

Defined in OptEnvConf.Doc

Methods

showsPrec :: Int -> AnyDocs a -> ShowS

show :: AnyDocs a -> String

showList :: [AnyDocs a] -> ShowS

data SetDoc

Constructors

SetDoc

Fields

• setDocTryArgument :: !Bool
• setDocTrySwitch :: !Bool
• setDocTryOption :: !Bool
• setDocDasheds :: ![Dashed]
• setDocEnvVars :: !(Maybe (NonEmpty String))
• setDocConfKeys :: !(Maybe (NonEmpty (NonEmpty String, JSONSchema)))
• setDocDefault :: !(Maybe String)
• setDocExamples :: ![String]
• setDocMetavar :: !(Maybe Metavar)
• setDocHelp :: !(Maybe String)

Instances

Show SetDoc

Defined in OptEnvConf.Doc

Methods

showsPrec :: Int -> SetDoc -> ShowS

show :: SetDoc -> String

showList :: [SetDoc] -> ShowS

data OptDoc

Constructors

OptDoc

Fields

• optDocTryArgument :: !Bool
• optDocTrySwitch :: !Bool
• optDocTryOption :: !Bool
• optDocDasheds :: ![Dashed]
• optDocDefault :: !(Maybe String)
• optDocExamples :: ![String]
• optDocMetavar :: !(Maybe Metavar)
• optDocHelp :: !(Maybe String)

Instances

Show OptDoc

Defined in OptEnvConf.Doc

Methods

showsPrec :: Int -> OptDoc -> ShowS

show :: OptDoc -> String

showList :: [OptDoc] -> ShowS

data EnvDoc

Constructors

EnvDoc

Fields

• envDocVars :: !(NonEmpty String)
• envDocDefault :: !(Maybe String)
• envDocExamples :: ![String]
• envDocMetavar :: !(Maybe Metavar)
• envDocHelp :: !(Maybe String)

Instances

Show EnvDoc

Defined in OptEnvConf.Doc

Methods

showsPrec :: Int -> EnvDoc -> ShowS

show :: EnvDoc -> String

showList :: [EnvDoc] -> ShowS

data ConfDoc

Constructors

ConfDoc

Fields

• confDocKeys :: !(NonEmpty (NonEmpty String, JSONSchema))
• confDocDefault :: !(Maybe String)
• confDocExamples :: ![String]
• confDocHelp :: !(Maybe String)

Instances

Show ConfDoc

Defined in OptEnvConf.Doc

Methods

showsPrec :: Int -> ConfDoc -> ShowS

show :: ConfDoc -> String

showList :: [ConfDoc] -> ShowS

data CommandDoc a

Constructors

CommandDoc

Fields

• commandDocArgument :: String
• commandDocHelp :: Help
• commandDocs :: AnyDocs a

Instances

Show a => Show (CommandDoc a)

Defined in OptEnvConf.Doc

Methods

showsPrec :: Int -> CommandDoc a -> ShowS

show :: CommandDoc a -> String

showList :: [CommandDoc a] -> ShowS

settingSetDoc :: Setting a -> Maybe SetDoc

renderSetDoc :: SetDoc -> [[Chunk]]

settingOptDoc :: Setting a -> Maybe OptDoc

renderOptDocLong :: OptDoc -> [[Chunk]]

settingEnvDoc :: Setting a -> Maybe EnvDoc

renderEnvDoc :: EnvDoc -> [[Chunk]]

settingConfDoc :: Setting a -> Maybe ConfDoc

renderConfDoc :: ConfDoc -> [[Chunk]]

helpLines :: Help -> [[Chunk]]