docs

Documentation

Index

• func Generate(schema *schema.Schema, args GenerateArgs, out io.Writer) error
• type DocsFormat
• type GenerateArgs

Functions

func Generate

func Generate(schema *schema.Schema, args GenerateArgs, out io.Writer) error

Types

type DocsFormat

type DocsFormat string

const (
	DocsFormatUnspecified DocsFormat = ""
	DocsFormatText        DocsFormat = "text"
	DocsFormatMarkdown    DocsFormat = "markdown"
	DocsFormatHTML        DocsFormat = "html"
)

type GenerateArgs

type GenerateArgs struct {
	Format     DocsFormat
	All        bool
	Subcommand name.Path
}