docs

package
v1.1.7 Latest Latest
Warning

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

 Go to latest Published: Aug 3, 2024 License: BSD-2-Clause Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.