parser

Documentation

Index

• type Parser
  • func New(mainPackage string) (*Parser, error)
  • func (p *Parser) Process(packagePath, importScope string, externalPackage bool) error
  • func (p *Parser) YAML() error

Types

type Parser

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

Parser process the main package and generate the doc

func New

func New(mainPackage string) (*Parser, error)

New initializate and returns a new Parser

func (*Parser) Process

func (p *Parser) Process(packagePath, importScope string, externalPackage bool) error

Process analyse go code for comments. Only commnets where the first line has swagg-doc willl be processed.

func (*Parser) YAML

func (p *Parser) YAML() error

YAML return the YAML string of this parse