docdr

Documentation

Index

• func ScanPackage(targetDirectory string, targetPackage string)
• type Stat
• type StatPair
• type StatPairList
  • func (p StatPairList) Len() int
  • func (p StatPairList) Less(i, j int) bool
  • func (p StatPairList) Swap(i, j int)

Functions

func ScanPackage

func ScanPackage(targetDirectory string, targetPackage string)

Scans the given directory and parses ast.Package objects If a targetPackage is specified we process functions within it otherwise we print stats on godoc comment coverage for all packages

Types

type Stat

type Stat struct {
	Count    int
	Total    int
	Coverage float64
}

type StatPair

type StatPair struct {
	Key   string
	Value Stat
}

type StatPairList

type StatPairList []StatPair

func (StatPairList) Len

func (p StatPairList) Len() int

Len is the number of elements in the collection. Required for sort.Sort

func (StatPairList) Less

func (p StatPairList) Less(i, j int) bool

Returns true if i should come before j in sorted order

func (StatPairList) Swap

func (p StatPairList) Swap(i, j int)

Swaps elements i and j, used by sort.Sort