View definition

(Corpus).SummarizePackage

Defined in github.com/golang/tools/godoc/corpus.go

Description

SummarizePackage optionally specifies a function to summarize a package. It exists as an optimization to avoid reading files to parse package comments.

If SummarizePackage returns false for ok, the caller ignores all return values and parses the files in the package as if SummarizePackage were nil.

If showList is false, the package is hidden from the package listing.

SummarizePackage is referenced in 1 repository

github.com/golang/tools