docparser

package

v0.5.1 Latest Latest Go to latest Published: Mar 4, 2024 License: MIT Imports: 13 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.

func FindStruct(pkgs []*packages.Package, tname string) (map[string]interface{}, error)

find a struct type by a name (used for looking up {models.ErrorResponse} in comments)

func ParseLine(pkgs []*packages.Package, key, value string, data map[string]interface{}) error

type Comments struct {
	Raw      []string
	Tags     map[string]*structtag.Tags
	Comments []string
}

type DocData struct {
	Doc      string
	Raw      []string
	Comments []string
	Data     map[string]interface{}
}

func GetDocComments(pkgs []*packages.Package, pos token.Position) (*DocData, error)

func ParseDoc(pkgs []*packages.Package, doc string) (*DocData, error)

func (d *DocData) Parameter(varName string) (map[string]interface{}, bool)