appdoc

Documentation

Index

• Variables
• func RunDoc(cfg *config.Config, pkgpath string, names ...string)
• type PkgDoc
  • func BuildPkgDoc(prog *loader.Program) (p *PkgDoc)
  • func (p *PkgDoc) Show(names ...string)

Variables

var CmdDoc = &cli.Command{
	Hidden:    true,
	Name:      "doc",
	Usage:     "show documentation for package or symbol",
	ArgsUsage: "name...",
	Flags: []cli.Flag{
		appbase.MakeFlag_target(),
		appbase.MakeFlag_tags(),
	},
	Action: func(c *cli.Context) error {
		opt := appbase.BuildOptions(c)

		var pkgpath = "."
		var names []string
		if c.Args().Len() > 0 {
			pkgpath = c.Args().First()
		}
		if c.Args().Len() > 1 {
			names = c.Args().Slice()[1:]
		}

		RunDoc(opt.Config(), pkgpath, names...)
		return nil
	},
}

Functions

func RunDoc

func RunDoc(cfg *config.Config, pkgpath string, names ...string)

Types

type PkgDoc

type PkgDoc struct {
	Prog    *loader.Program
	Consts  []*types.Const
	Types   []*types.TypeName
	Globals []*types.Var
	Funcs   []*types.Func
}

func BuildPkgDoc

func BuildPkgDoc(prog *loader.Program) (p *PkgDoc)

func (*PkgDoc) Show

func (p *PkgDoc) Show(names ...string)