package symbol

Import Path
	golang.org/x/pkgsite/internal/symbol (on go.dev)

Dependency Relation
	imports 12 packages, and imported by one package

Involved Source Files

	      apigodoc.go
	      compare.go
	      intro.go
	      stdlib.go
Package-Level Type Names (total 4, none are exported)

	/* sort exporteds by: alphabet | popularity */
	/* 4 unexporteds ... *//* 4 unexporteds: */
	 type apiVersions (map)
		apiVersions is a map of packages to information about those packages'
		symbols and when they were added to Go.

		Only things added after Go1 are tracked. Version strings are of the
		form "1.1", "1.2", etc.

		As Outputs Of (at least one exported)
			func ParsePackageAPIInfo(files []string) (apiVersions, error)

	 type pkgAPIVersions (struct)
		pkgAPIVersions contains information about which version of Go added
		certain package symbols.

		Only things added after Go1 are tracked. Version strings are of the
		form "1.1", "1.2", etc.

		Fields (total 6, none are exported)
			/* 6 unexporteds ... *//* 6 unexporteds: */
			constSince map[string]string
			fieldSince map[string]map[string]string
				// "ClientTrace" -> "Got1xxResponse" -> "1.11"

			funcSince map[string]string
				// "NewServer" -> "1.7"

			methodSince map[string]map[string]string
				// "*Server" ->"Shutdown"->1.8

			typeSince map[string]string
				// "Server" -> "1.7"

			varSince map[string]string
		As Inputs Of (at least one exported)
			func CompareAPIVersions(path string, apiVersions pkgAPIVersions, inSH *internal.SymbolHistory) ([]string, error)

	 type versionedRow (struct)
		versionedRow represents an API feature, a parsed line of a
		$GOROOT/api/go.*txt file.

		Fields (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			kind string
				// "type", "func", "method", "field" TODO: "const", "var"

			name string
				// name of type, (struct) field, func, method

			pkg string
				// "net/http"

			recv string
				// for methods, the receiver type ("Server", "*Server")

			structName string
				// for struct fields, the outer struct name

		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func parseRow(s string) (vr versionedRow, ok bool)

	 type versionParser (struct)
		versionParser parses $GOROOT/api/go*.txt files and stores them in in its rows field.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			res apiVersions
				// initialized lazily

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			(*T) parseFile(name string) error
				parseFile parses the named <apidata>/VERSION.txt file.

				For each row, it updates the corresponding entry in
				vp.res to VERSION, overwriting any previous value.



Package-Level Functions (total 5, in which 4 are exported)

	 func CompareAPIVersions(path string, apiVersions pkgAPIVersions, inSH *internal.SymbolHistory) ([]string, error)
		CompareAPIVersions returns the differences between apiVersions and
		inVersionToNameToUnitSymbol.

	 func IntroducedHistory(sh *internal.SymbolHistory) (outSH *internal.SymbolHistory, err error)
		IntroducedHistory returns a map of the first version when a symbol name is
		added to the API, to the symbol name, to the UnitSymbol struct. The
		UnitSymbol.Children field will always be empty, as children names are also
		tracked.

	 func LoadAPIFiles(pkgPath, dir string) ([]string, error)
		LoadAPIFiles loads data about the API for the given package from dir.

	 func ParsePackageAPIInfo(files []string) (apiVersions, error)
		ParseAPIInfo parses apiVersions using contents of the specified directory.

	/* one unexported ... *//* one unexported: */
	 func parseRow(s string) (vr versionedRow, ok bool)
Package-Level Variables (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var pathToEmbeddedMethods map[string]map[string]string
		pathToEmbeddedMethods contains methods that appear on a struct, because it
		was added to an embedded struct. pkgsite does not currently support embedding,
		so these methods are skipped by when comparing the stdlib API for now.

	  var pathToExceptions map[string]map[string]bool

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.