astview

type Filter ¶

type Filter func(string) bool

type FuncDoc ¶

type FuncDoc struct {
	Doc  string
	Recv ast.Expr // TODO(rsc): Would like string here
	Name string
	Decl *ast.FuncDecl
}

FuncDoc is the documentation for a func declaration, either a top-level function or a method function.

type PackageDoc ¶

type PackageDoc struct {
	PackageName string
	ImportPath  string
	Imports     []string
	Filenames   []string
	Doc         string
	Consts      []*ValueDoc
	Types       []*TypeDoc
	Vars        []*ValueDoc
	Funcs       []*FuncDoc
	Factorys    []*FuncDoc
	Bugs        []string
}

PackageDoc is the documentation for an entire package.

func NewFileDoc(file *ast.File, showAll bool) *PackageDoc

func NewPackageDoc(pkg *ast.Package, importpath string, showAll bool) *PackageDoc

func (p *PackageDoc) Filter(f Filter)

type PackageView ¶

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

func NewFilePackage(filename string) (*PackageView, error)

func NewFilePackageSource(filename string, f *os.File, expr bool) (*PackageView, error)

func NewPackageView(pkg *ast.Package, fset *token.FileSet, expr bool) (*PackageView, error)

func (p *PackageView) PrintFuncs(w io.Writer, level int, tag_folder string)

func (p *PackageView) PrintHeader(w io.Writer, level int)

func (p *PackageView) PrintImports(w io.Writer, level int, tag, tag_folder string)

func (p *PackageView) PrintPackage(w io.Writer, level int)

func (p *PackageView) PrintTree(w io.Writer)

func (p *PackageView) PrintTypeFields(w io.Writer, decl *ast.GenDecl, level int)

func (p *PackageView) PrintTypes(w io.Writer, types []*TypeDoc, level int)

func (p *PackageView) PrintVars(w io.Writer, vars []*ValueDoc, level int, tag string, tag_folder string)

type TypeDoc ¶

type TypeDoc struct {
	Doc     string
	Type    *ast.TypeSpec
	Consts  []*ValueDoc
	Vars    []*ValueDoc
	Funcs   []*FuncDoc
	Methods []*FuncDoc
	Decl    *ast.GenDecl
	// contains filtered or unexported fields
}

TypeDoc is the documentation for a declared type. Consts and Vars are sorted lists of constants and variables of (mostly) that type. Factories is a sorted list of factory functions that return that type. Methods is a sorted list of method functions on that type.

type ValueDoc ¶

type ValueDoc struct {
	Doc  string
	Decl *ast.GenDecl
	// contains filtered or unexported fields
}

ValueDoc is the documentation for a group of declared values, either vars or consts.