codocgen

Documentation

Index

• func FromPath(path string, opts ...Option) (*codoc.Package, error)
• func RegisterPath(path string, opts ...Option) error
• type Option
  • 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
  • func (PackageError) Error() string

Functions

func FromPath

func FromPath(path string, opts ...Option) (*codoc.Package, error)

FromPath generates documentation for a package at the given path.

func RegisterPath

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

RegisterPath registers a package at the given path.

Types

type Option

type Option func(*config)

func Exported

func Exported() Option

func FilterFuncs

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

func FilterStructs

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

func WithDoc

func WithDoc() Option

type PackageError

type PackageError []packages.Error

func (PackageError) Error

func (PackageError) Error() string