doc

Documentation

Overview

The doc package provides JSON metadata that documents gopls' public interfaces.

Index

• Variables
• type API
• type Analyzer
• type Command
• type EnumKey
• type EnumKeys
• type EnumValue
• type Hint
• type Lens
• type Option

Variables

var JSON string

API is a JSON value of type API. The 'gopls api-json' command prints it.

Types

type API

type API struct {
	Options   map[string][]*Option
	Commands  []*Command
	Lenses    []*Lens
	Analyzers []*Analyzer
	Hints     []*Hint
}

API is a JSON-encodable representation of gopls' public interfaces.

TODO(adonovan): document these data types.

type Analyzer

type Analyzer struct {
	Name    string
	Doc     string // from analysis.Analyzer.Doc ("title: summary\ndescription"; not Markdown)
	URL     string
	Default bool
}

type Command

type Command struct {
	Command   string // e.g. "gopls.run_tests"
	Title     string
	Doc       string
	ArgDoc    string
	ResultDoc string
}

type EnumKey

type EnumKey struct {
	Name    string
	Doc     string
	Default string
}

type EnumKeys

type EnumKeys struct {
	ValueType string
	Keys      []EnumKey
}

type EnumValue

type EnumValue struct {
	Value string
	Doc   string
}

type Hint

type Hint struct {
	Name    string
	Doc     string
	Default bool
}

type Lens

type Lens struct {
	FileType string // e.g. "Go", "go.mod"
	Lens     string
	Title    string
	Doc      string
	Default  bool
}

type Option

type Option struct {
	Name       string
	Type       string
	Doc        string
	EnumKeys   EnumKeys
	EnumValues []EnumValue
	Default    string
	Status     string
	Hierarchy  string
}