go_document

README

go-document

获取go代码注释

Documentation

Index

• func ParseAst(pkgPath string, f *ast.File) (err error)
• func ParseFile(fileName string) (*ast.File, error)
• type Doc
  • func (d *Doc) AddPkgPath(dir string) *Doc
  • func (d *Doc) AddPkgPaths(dirs []string) *Doc
  • func (d *Doc) Build() error
  • func (d *Doc) SetBaseDir(dir string) *Doc

Functions

func ParseAst

func ParseAst(pkgPath string, f *ast.File) (err error)

func ParseFile

func ParseFile(fileName string) (*ast.File, error)

Types

type Doc

type Doc struct {
	Packages map[string]*types.PkgData
	Structs  map[string]*types.StructData
	Funcs    map[string]*types.FuncData
	// contains filtered or unexported fields
}

func (*Doc) AddPkgPath

func (d *Doc) AddPkgPath(dir string) *Doc

func (*Doc) AddPkgPaths

func (d *Doc) AddPkgPaths(dirs []string) *Doc

func (*Doc) Build

func (d *Doc) Build() error

func (*Doc) SetBaseDir

func (d *Doc) SetBaseDir(dir string) *Doc