Documentation
¶
Index ¶
- func GenerateHTML(program string, path []string, cmd schema.Command) (string, error)
- func GenerateMarkdown(program string, path []string, cmd schema.Command) (string, error)
- func GenerateText(program string, path []string, cmd schema.Command) (string, error)
- type ArgumentData
- type CommandData
- type OptionData
- type SubcommandData
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateHTML ¶
func GenerateMarkdown ¶
Types ¶
type ArgumentData ¶
type ArgumentData struct {
Position int
Name name.Name
Description string
Type schema.Type
Variadic bool
}
func (ArgumentData) DescriptionLines ¶
func (d ArgumentData) DescriptionLines() []string
type CommandData ¶
type CommandData struct {
Program string
Name name.Name
Description string
Options []OptionData
Arguments []ArgumentData
Subcommands []SubcommandData
}
func (CommandData) DescriptionLines ¶
func (d CommandData) DescriptionLines() []string
func (CommandData) Path ¶
func (d CommandData) Path() string
func (CommandData) Syntax ¶
func (d CommandData) Syntax() string
type OptionData ¶
type OptionData struct {
Option string
ShortOption string
Description string
Type schema.Type
Repeated bool
Default string
Negation bool
}
func (OptionData) DescriptionLines ¶
func (d OptionData) DescriptionLines() []string
func (OptionData) NegatedOption ¶
func (d OptionData) NegatedOption() (option string)
func (OptionData) Options ¶
func (d OptionData) Options() (options []string)
type SubcommandData ¶
func (SubcommandData) DescriptionLines ¶
func (d SubcommandData) DescriptionLines() []string
Click to show internal directories.
Click to hide internal directories.