docs

Documentation

Index

• type Default
• type Details
• type DocOption
• type Documentation
  • func New(opts ...Option) (*Documentation, error)
  • func (d *Documentation) AddMapper(input, output, description string)
  • func (d *Documentation) Description(x string)
  • func (d *Documentation) Details() *Details
  • func (d *Documentation) Example(x string)
  • func (d *Documentation) Fields() []*FieldDocs
  • func (d *Documentation) Input(x string)
  • func (d *Documentation) Output(x string)
  • func (d *Documentation) OverrideField(f *FieldDocs) error
  • func (d *Documentation) SetField(name, synposis string, opts ...DocOption) error
• type EnvVar
• type FieldDocs
• type Mapper
• type Option
  • func FromConfig(v interface{}) Option
• type SummaryString
  • func Summary(in ...string) SummaryString

Types

type Default

type Default string

type Details

type Details struct {
	Description string
	Example     string

	Input  string
	Output string

	Mappers []Mapper
}

type DocOption

type DocOption interface {
	// contains filtered or unexported methods
}

type Documentation

type Documentation struct {
	// contains filtered or unexported fields
}

func New

func New(opts ...Option) (*Documentation, error)

func (*Documentation) AddMapper

func (d *Documentation) AddMapper(input, output, description string)

func (*Documentation) Description

func (d *Documentation) Description(x string)

func (*Documentation) Details

func (d *Documentation) Details() *Details

func (*Documentation) Example

func (d *Documentation) Example(x string)

func (*Documentation) Fields

func (d *Documentation) Fields() []*FieldDocs

func (*Documentation) Input

func (d *Documentation) Input(x string)

func (*Documentation) Output

func (d *Documentation) Output(x string)

func (*Documentation) OverrideField

func (d *Documentation) OverrideField(f *FieldDocs) error

func (*Documentation) SetField

func (d *Documentation) SetField(name, synposis string, opts ...DocOption) error

type EnvVar

type EnvVar string

type FieldDocs

type FieldDocs struct {
	Field    string
	Type     string
	Synopsis string
	Summary  string

	Optional bool
	Default  string
	EnvVar   string
}

type Mapper

type Mapper struct {
	Input       string
	Output      string
	Description string
}

type Option

type Option func(*Documentation) error

func FromConfig

func FromConfig(v interface{}) Option

type SummaryString

type SummaryString string

func Summary

func Summary(in ...string) SummaryString