docgen

package

v1.34.2 Latest Latest Go to latest Published: Dec 1, 2025 License: Apache-2.0, MIT Imports: 45 Imported by: 3

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/filecoin-project/lotus

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func ExampleValue(method string, t, parent reflect.Type) interface{}
func Generate(out io.Writer, iface, pkg string, ainfo ApiASTInfo) error
func GetAPIType(name, pkg string) (i interface{}, t reflect.Type, permStruct []reflect.Type)
func MethodGroupFromName(mn string) string
type ApiASTInfo
- func ParseApiASTInfo(apiFile, iface, pkg, dir string) (ApiASTInfo, error)
type Method
type MethodGroup
type Visitor
- func (v *Visitor) Visit(node ast.Node) ast.Visitor

Constants ¶

View Source

const NoComment = "There are not yet any comments for this method."

Variables ¶

View Source

var ExampleValues = map[reflect.Type]interface{}{
	reflect.TypeFor[api.MinerSubsystem](): api.MinerSubsystem(1),
	reflect.TypeFor[auth.Permission]():    auth.Permission("write"),
	reflect.TypeFor[string]():             "string value",
	reflect.TypeFor[uint64]():             uint64(42),
	reflect.TypeFor[byte]():               byte(7),
	reflect.TypeFor[[]byte]():             []byte("byte array"),
}

Functions ¶

func ExampleValue ¶ added in v1.9.0

func ExampleValue(method string, t, parent reflect.Type) interface{}

func Generate ¶ added in v1.30.0

func Generate(out io.Writer, iface, pkg string, ainfo ApiASTInfo) error

func GetAPIType ¶ added in v1.9.0

func GetAPIType(name, pkg string) (i interface{}, t reflect.Type, permStruct []reflect.Type)

func MethodGroupFromName ¶ added in v1.9.0

func MethodGroupFromName(mn string) string

Types ¶

type ApiASTInfo ¶ added in v1.30.0

type ApiASTInfo struct {
	Comments      map[string]string
	GroupComments map[string]string
}

func ParseApiASTInfo ¶ added in v1.9.0

func ParseApiASTInfo(apiFile, iface, pkg, dir string) (ApiASTInfo, error)

type Method ¶

type Method struct {
	Comment         string
	Name            string
	InputExample    string
	ResponseExample string
}

type MethodGroup ¶

type MethodGroup struct {
	GroupName string
	Header    string
	Methods   []*Method
}

type Visitor ¶

type Visitor struct {
	Root    string
	Methods map[string]ast.Node
}

func (*Visitor) Visit ¶

func (v *Visitor) Visit(node ast.Node) ast.Visitor

Source Files ¶

View all Source files

docgen.go

Directories ¶

Path	Synopsis
cmd

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL