docs

package
v2.0.0-beta.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 21, 2025 License: BSD-2-Clause Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenerateHTML

func GenerateHTML(program string, path []string, cmd schema.Command) (string, error)

func GenerateMarkdown

func GenerateMarkdown(program string, path []string, cmd schema.Command) (string, error)

func GenerateText

func GenerateText(program string, path []string, cmd schema.Command) (string, error)

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 Construct

func Construct(program string, path []string, cmd schema.Command) CommandData

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

type SubcommandData struct {
	Name        string
	Description string
}

func (SubcommandData) DescriptionLines

func (d SubcommandData) DescriptionLines() []string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL