parser

package

v0.0.0-...-7f43d4a Latest Latest Go to latest Published: Jul 12, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

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

NewApiGroupParser parser for ApiGroup

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

Parse load a documentation file and parse the content

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

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

NewApiParser parser for Api

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 struct {
	// contains filtered or unexported fields
}

MethodParser wrap a parsable method

func NewMethodParser(debug bool) MethodParser

NewMethodParser init a MethodParser

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

Parse a method text

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

func NewPropertyParser(debug bool) PropertyParser

NewPropertyParser

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