parser

Documentation

Index

• type Parser
  • func New(fixMe, todo, optimize bool, custom, format string) *Parser
  • func (p *Parser) Aggregate() string
  • func (p *Parser) Parse(file string) error

Types

type Parser

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

Parser - parses files and collects information about annotations

func New

func New(fixMe, todo, optimize bool, custom, format string) *Parser

New - method to create a parser Returns parser object

func (*Parser) Aggregate

func (p *Parser) Aggregate() string

Aggregate - parsed files information Returns preformated string

func (*Parser) Parse

func (p *Parser) Parse(file string) error

Parse - file by file path