parser

Documentation

Index

• type ApiGroupParser
  • func NewApiGroupParser(debug bool, filtersList []filters.Filter) ApiGroupParser
  • func (g *ApiGroupParser) Parse(srcFile string) (*types.ApiGroup, error)
• type ApiParser
  • func NewApiParser(debug bool, filter []filters.Filter) ApiParser
  • func (g *ApiParser) Parse(raw []byte) (*types.Api, error)
  • func (g *ApiParser) ParseMethods(raw []byte) ([]*types.Method, error)
  • func (g *ApiParser) ParseProperties(raw []byte) ([]*types.Property, error)
  • func (g *ApiParser) ParseSignals(raw []byte) ([]*types.Method, error)
• type MethodParser
  • func NewMethodParser(debug bool) MethodParser
  • func (g *MethodParser) Parse(raw []byte) (*types.Method, error)
• type PropertyParser
  • func NewPropertyParser(debug bool) PropertyParser
  • func (g *PropertyParser) Parse(raw []byte) (*types.Property, error)

Types

type ApiGroupParser

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

func NewApiGroupParser

func NewApiGroupParser(debug bool, filtersList []filters.Filter) ApiGroupParser

NewApiGroupParser parser for ApiGroup

func (*ApiGroupParser) Parse

func (g *ApiGroupParser) Parse(srcFile string) (*types.ApiGroup, error)

Parse load a documentation file and parse the content

type ApiParser

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

func NewApiParser

func NewApiParser(debug bool, filter []filters.Filter) ApiParser

NewApiParser parser for Api

func (*ApiParser) Parse

func (g *ApiParser) Parse(raw []byte) (*types.Api, error)

func (*ApiParser) ParseMethods

func (g *ApiParser) ParseMethods(raw []byte) ([]*types.Method, error)

func (*ApiParser) ParseProperties

func (g *ApiParser) ParseProperties(raw []byte) ([]*types.Property, error)

func (*ApiParser) ParseSignals

func (g *ApiParser) ParseSignals(raw []byte) ([]*types.Method, error)

type MethodParser

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

MethodParser wrap a parsable method

func NewMethodParser

func NewMethodParser(debug bool) MethodParser

NewMethodParser init a MethodParser

func (*MethodParser) Parse

func (g *MethodParser) Parse(raw []byte) (*types.Method, error)

Parse a method text

type PropertyParser

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

func NewPropertyParser

func NewPropertyParser(debug bool) PropertyParser

NewPropertyParser

func (*PropertyParser) Parse

func (g *PropertyParser) Parse(raw []byte) (*types.Property, error)