godocmd

README

godocmd

Markdown generator for golang documentations.

Run go generate ./... first.

Usage of ./godocmd:
  -output-dir string
    	output directory (default "./docs")
  -package-base string
    	package import basepath, output from "go list -m" (default "github.com/nickchen/godocmd")

Documentation

Index

• type DocMD
  • func New() (*DocMD, error)
  • func (d *DocMD) ProcessPackageDirs(outDir, packageBasePath string, dirs ...string) error
• type Package
  • func NewPackage(mainPkg, testPkg *doc.Package) *Package

Types

type DocMD

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

func New

func New() (*DocMD, error)

func (*DocMD) ProcessPackageDirs

func (d *DocMD) ProcessPackageDirs(outDir, packageBasePath string, dirs ...string) error

type Package

type Package struct {
	*doc.Package
	// FuncsFiltered filtered out examples and benchmarks
	FuncsFiltered []*doc.Func
	FuncsName     map[string]*doc.Func
}

func NewPackage

func NewPackage(mainPkg, testPkg *doc.Package) *Package