Versions in this module Expand all Collapse all v0 v0.1.0 Jul 16, 2026 Changes in this version + type Category bool + type Default string + type Details struct + Description string + Example string + Input string + Mappers []Mapper + Output string + type DocField interface + SetField func(name, synposis string, opts ...docOption) error + type Documentation struct + 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) OverrideRequestField(f *FieldDocs) error + func (d *Documentation) OverrideTemplateField(f *FieldDocs) error + func (d *Documentation) RequestFields() []*FieldDocs + func (d *Documentation) SetField(name, synposis string, opts ...docOption) error + func (d *Documentation) SetRequestField(name, synposis string, opts ...docOption) error + func (d *Documentation) SetTemplateField(name, synposis string, opts ...docOption) error + func (d *Documentation) SubFields(parent string, f func(d *SubFieldDoc)) *SubFieldDoc + func (d *Documentation) TemplateFields() []*FieldDocs + type EnvVar string + type Example string + type FieldDocs struct + Category bool + Default string + EnvVar string + Example string + Field string + Optional bool + SubFields []*FieldDocs + Summary string + Synopsis string + Type string + type Mapper struct + Description string + Input string + Output string + type Option func(*Documentation) error + func FromConfig(v interface{}) Option + func FromFunc(v interface{}) Option + func RequestFromStruct(v interface{}) Option + type SubFieldDoc struct + func SubFields(f func(d *SubFieldDoc)) *SubFieldDoc + func (d *SubFieldDoc) Fields() []*FieldDocs + func (s *SubFieldDoc) SetField(name, synposis string, opts ...docOption) error + func (s *SubFieldDoc) SubFields(parent string, f func(d *SubFieldDoc)) *SubFieldDoc + type SummaryString string + func Summary(in ...string) SummaryString
Go to main page