Function PackageDoc

tempfork/pkgdoc/pkgdoc.go:212–234

PackageDoc generates Markdown documentation for the package in the given directory. importPath is the full Go import path of that package (e.g. "tailscale.com/tsnet"); it's used to render [Symbol] doc links to the right pkg.go.dev URL. If importPath is empty, build.ImportDir's guess is used (typical

(dir, importPath string)

// right pkg.go.dev URL. If importPath is empty, build.ImportDir's guess
// is used (typically "." for module-based repos).
func PackageDoc(dir, importPath string) ([]byte, error) {
	var buf bytes.Buffer
	var writer io.Writer = &buf

	buildPackage, err := build.ImportDir(dir, build.ImportComment)
	if err != nil {
		var noGoError *build.NoGoError
		if errors.As(err, &noGoError) {
			return nil, nil
		}
		return nil, err
	}
	if importPath != "" {
		buildPackage.ImportPath = importPath
	}
	userPath := dir

	pkg := parsePackage(writer, buildPackage, userPath)
	pkg.packageDoc()
	pkg.flush()

	return buf.Bytes(), nil
}