autodocs

package

v1.2.0 Latest Latest Go to latest Published: Jun 1, 2019 License: MIT Imports: 4 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 Type struct {
	Name       string
	Comment    string
	LineNumber int
}

Type represents a type in a Go source file.

func GetTypeDocumentation(typeName string, filePath string) (*Type, error)

GetTypeDocumentation tries to gather documentation about the given type.

func (typ *Type) Endpoint() string

Endpoint returns the REST endpoint for that type.

func (typ *Type) GitHubLink() string

GitHubLink returns link to display the type in GitHub.