doc

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

type JSONDocumentation struct {
	PackagePath string   `json:"package_path"`
	PackageLine string   `json:"package_line"` // package io // import "io"
	PackageDoc  string   `json:"package_doc"`  // markdown of top-level package documentation
	Bugs        []string `json:"bugs"`         // From comments with "BUG(who): Details"

	// These match each of the sections in a pkg.go.dev package documentation
	Values []*JSONValueDecl `json:"values"` // constants and variables declared
	Funcs  []*JSONFunc      `json:"funcs"`  // Funcs and methods
	Types  []*JSONType      `json:"types"`
}

type JSONField struct {
	Name string `json:"name"`
	Type string `json:"type"`
	Doc  string `json:"doc"` // markdown
}

type JSONFunc struct {
	Type      string       `json:"type"` // if this is a method
	Name      string       `json:"name"`
	Crossing  bool         `json:"crossing"` // true if the first param is "cur realm"
	Signature string       `json:"signature"`
	Doc       string       `json:"doc"` // markdown
	Params    []*JSONField `json:"params"`
	Results   []*JSONField `json:"results"`
}

type JSONInterfaceElement struct {
	Method *JSONFunc `json:"method,omitempty"` // Normal interface method
	Type   string    `json:"type,omitempty"`   // Embedded type
}

type JSONType struct {
	Name  string `json:"name"`  // "MyType"
	Type  string `json:"type"`  // "struct { ... }"
	Doc   string `json:"doc"`   // godoc documentation...
	Alias bool   `json:"alias"` // if an alias like `type A = B`
	Kind  string `json:"kind"`  // struct | interface | array | slice | map | channel | func | pointer | ident
	// TODO: Use omitzero when upgraded to Go 1.24
	InterElems []*JSONInterfaceElement `json:"inter_elems,omitempty"` // interface methods or embedded types (Kind == "interface") (struct methods are in JSONDocumentation.Funcs)
	Fields     []*JSONField            `json:"fields,omitempty"`      // struct fields (Kind == "struct")
}

type JSONValue struct {
	Name string `json:"name"`
	Doc  string `json:"doc"`
	Type string `json:"type"` // often empty
}

type JSONValueDecl struct {
	Signature string       `json:"signature"`
	Const     bool         `json:"const"`
	Values    []*JSONValue `json:"values"`
	Doc       string       `json:"doc"` // markdown
}

type WriteDocumentationOptions struct {
	// ShowAll shows all symbols when displaying documentation about a package.
	ShowAll bool
	// Source shows the source code when documenting a symbol.
	Source bool
	// Unexported shows unexported symbols as well as exported.
	Unexported bool
	// Short shows a one-line representation for each symbol.
	Short bool
	// contains filtered or unexported fields
}