genapi

package

v0.3.0 Latest Latest Go to latest Published: Jan 3, 2020 License: BSD-3-Clause Imports: 14 Imported by: 0

Details

This section is empty.

This section is empty.

func WriteMarkdown(w io.Writer, pkg *Package) error

WriteMarkdown writes the API of pkg as markdown to w.

type Field struct {
	Name     string
	Doc      string
	Type     ast.Expr
	Required bool
}

A Field represents a struct field.

type Package struct {
	FileSet *token.FileSet
	AstPkg  *ast.Package
	DocPkg  *doc.Package

	Structs map[string]Struct
}

A Package represents a package.

func ParseDir(path string) (*Package, error)

ParseDir parses the package in the given path.

type Struct struct {
	Name   string
	Doc    string
	Fields []Field
}

A Struct represents a struct.