codocgen

package

v0.0.0-...-7194fc8 Latest Latest Go to latest Published: May 19, 2024 License: MIT Imports: 10 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 FromPath(path string, opts ...Option) (*codoc.Package, error)

FromPath generates documentation for a package at the given path.

func RegisterPath(path string, opts ...Option) error

RegisterPath registers a package at the given path.

type Option func(*config)

func Exported() Option

func FilterFuncs(fn func(fn codoc.Function) bool) Option

func FilterStructs(fn func(st codoc.Struct) bool) Option

func WithDoc() Option

type PackageError []packages.Error

func (PackageError) Error() string