all: make function and struct comments match the names

Change-Id: Ia7d5c0bb0299d9d898e62740c3e05fc1e5cbf9cd
Reviewed-on: https://go-review.googlesource.com/c/tools/+/639477
LUCI-TryBot-Result: Go LUCI <[email protected]>
Reviewed-by: Michael Matloob <[email protected]>
Reviewed-by: Ian Lance Taylor <[email protected]>
Auto-Submit: Ian Lance Taylor <[email protected]>

Author: cuishuang

cmd/bisect/main.go

@@ -262,7 +262,7 @@ type Bisect struct {
 	// each pattern starts with a !.
 	Disable bool
 
-	// SkipDigits is the number of hex digits to use in skip messages.
+	// SkipHexDigits is the number of hex digits to use in skip messages.
 	// If the set of available changes is the same in each run, as it should be,
 	// then this doesn't matter: we'll only exclude suffixes that uniquely identify
 	// a given change. But for some programs, especially bisecting runtime

go/packages/packages_test.go

@@ -3222,7 +3222,7 @@ func TestIssue70394(t *testing.T) {
 	}
 }
 
-// TestNeedTypesInfoOnly tests when NeedTypesInfo was set and NeedSyntax & NeedTypes were not,
+// TestLoadTypesInfoWithoutSyntaxOrTypes tests when NeedTypesInfo was set and NeedSyntax & NeedTypes were not,
 // Load should include the TypesInfo of packages properly
 func TestLoadTypesInfoWithoutSyntaxOrTypes(t *testing.T) {
 	testAllOrModulesParallel(t, testLoadTypesInfoWithoutSyntaxOrTypes)

gopls/internal/cache/typerefs/pkggraph_test.go

@@ -40,7 +40,7 @@ type Package struct {
 	// transitively reachable through references, starting with the given decl.
 	transitiveRefs map[string]*typerefs.PackageSet
 
-	// ReachesViaDeps records the set of packages in the containing graph whose
+	// ReachesByDeps records the set of packages in the containing graph whose
 	// syntax may affect the current package's types. See the package
 	// documentation for more details of what this means.
 	ReachesByDeps *typerefs.PackageSet

gopls/internal/golang/codeaction.go

@@ -172,7 +172,7 @@ func (req *codeActionsRequest) addCommandAction(cmd *protocol.Command, allowReso
 	req.addAction(act)
 }
 
-// addCommandAction adds an edit-based CodeAction to the result.
+// addEditAction adds an edit-based CodeAction to the result.
 func (req *codeActionsRequest) addEditAction(title string, fixedDiagnostics []protocol.Diagnostic, changes ...protocol.DocumentChange) {
 	req.addAction(protocol.CodeAction{
 		Title:       title,
@@ -648,7 +648,7 @@ func refactorRewriteChangeQuote(ctx context.Context, req *codeActionsRequest) er
 	return nil
 }
 
-// refactorRewriteChangeQuote produces "Invert 'if' condition" code actions.
+// refactorRewriteInvertIf produces "Invert 'if' condition" code actions.
 // See [invertIfCondition] for command implementation.
 func refactorRewriteInvertIf(ctx context.Context, req *codeActionsRequest) error {
 	if _, ok, _ := canInvertIfCondition(req.pgf.File, req.start, req.end); ok {

gopls/internal/golang/completion/postfix_snippets.go

@@ -69,7 +69,7 @@ type postfixTmplArgs struct {
 	// Type is the type of "foo.bar" in "foo.bar.print!".
 	Type types.Type
 
-	// FuncResult are results of the enclosed function
+	// FuncResults are results of the enclosed function
 	FuncResults []*types.Var
 
 	sel            *ast.SelectorExpr

gopls/internal/golang/extract.go

@@ -1654,7 +1654,7 @@ var conventionalVarNames = map[objKey]string{
 	{"http", "ResponseWriter"}: "rw", // Note: same as [AbbreviateVarName].
 }
 
-// varNameForTypeName chooses a "good" name for a variable with the given type,
+// varNameForType chooses a "good" name for a variable with the given type,
 // if possible. Otherwise, it returns "", false.
 //
 // For special types, it uses known conventional names.

gopls/internal/protocol/command/interface.go

@@ -525,7 +525,7 @@ type RunVulncheckResult struct {
 	Token protocol.ProgressToken
 }
 
-// GovulncheckResult holds the result of synchronously running the vulncheck
+// VulncheckResult holds the result of synchronously running the vulncheck
 // command.
 type VulncheckResult struct {
 	// Result holds the result of running vulncheck.
@@ -695,7 +695,7 @@ type PackagesResult struct {
 	// Packages is an unordered list of package metadata.
 	Packages []Package
 
-	// Modules maps module path to module metadata for
+	// Module maps module path to module metadata for
 	// all the modules of the returned Packages.
 	Module map[string]Module
 }

gopls/internal/protocol/generate/types.go

@@ -112,7 +112,7 @@ type Type struct {
 	Line    int     `json:"line"`    // JSON source line
 }
 
-// ParsedLiteral is Type.Value when Type.Kind is "literal"
+// ParseLiteral is Type.Value when Type.Kind is "literal"
 type ParseLiteral struct {
 	Properties `json:"properties"`
 }

gopls/internal/server/general.go

@@ -610,7 +610,7 @@ func (s *server) fileOf(ctx context.Context, uri protocol.DocumentURI) (file.Han
 	return fh, snapshot, release, nil
 }
 
-// shutdown implements the 'shutdown' LSP handler. It releases resources
+// Shutdown implements the 'shutdown' LSP handler. It releases resources
 // associated with the server and waits for all ongoing work to complete.
 func (s *server) Shutdown(ctx context.Context) error {
 	ctx, done := event.Start(ctx, "lsp.Server.shutdown")

gopls/internal/server/selection_range.go

@@ -15,7 +15,7 @@ import (
 	"golang.org/x/tools/internal/event"
 )
 
-// selectionRange defines the textDocument/selectionRange feature,
+// SelectionRange defines the textDocument/selectionRange feature,
 // which, given a list of positions within a file,
 // reports a linked list of enclosing syntactic blocks, innermost first.
 //

gopls/internal/test/integration/env.go

@@ -225,7 +225,7 @@ func (a *Awaiter) onShowMessage(_ context.Context, params *protocol.ShowMessageP
 	return nil
 }
 
-// ListenToShownDocuments registers a listener to incoming showDocument
+// ListenToShownMessages registers a listener to incoming showMessage
 // notifications. Call the resulting func to deregister the listener and
 // receive all notifications that have occurred since the listener was
 // registered.

gopls/internal/test/integration/expectation.go

@@ -452,7 +452,7 @@ type WorkStatus struct {
 	EndMsg string
 }
 
-// CompletedProgress expects that workDone progress is complete for the given
+// CompletedProgressToken expects that workDone progress is complete for the given
 // progress token. When non-nil WorkStatus is provided, it will be filled
 // when the expectation is met.
 //

gopls/internal/util/moremaps/maps.go

@@ -22,7 +22,7 @@ func Group[K comparable, V any](s []V, key func(V) K) map[K][]V {
 	return m
 }
 
-// Keys returns the keys of the map M, like slices.Collect(maps.Keys(m)).
+// KeySlice returns the keys of the map M, like slices.Collect(maps.Keys(m)).
 func KeySlice[M ~map[K]V, K comparable, V any](m M) []K {
 	r := make([]K, 0, len(m))
 	for k := range m {

internal/aliases/aliases_test.go

@@ -81,7 +81,7 @@ func TestNewAlias(t *testing.T) {
 	}
 }
 
-// TestNewAlias tests that alias.NewAlias can create a parameterized alias
+// TestNewParameterizedAlias tests that alias.NewAlias can create a parameterized alias
 // A[T] of a type whose underlying and Unaliased type is *T. The test then
 // instantiates A[Named] and checks that the underlying and Unaliased type
 // of A[Named] is *Named.

internal/event/export/metric/data.go

@@ -34,7 +34,7 @@ type Int64Data struct {
 	IsGauge bool
 	// Rows holds the per group values for the metric.
 	Rows []int64
-	// End is the last time this metric was updated.
+	// EndTime is the last time this metric was updated.
 	EndTime time.Time
 
 	groups [][]label.Label
@@ -49,7 +49,7 @@ type Float64Data struct {
 	IsGauge bool
 	// Rows holds the per group values for the metric.
 	Rows []float64
-	// End is the last time this metric was updated.
+	// EndTime is the last time this metric was updated.
 	EndTime time.Time
 
 	groups [][]label.Label
@@ -62,7 +62,7 @@ type HistogramInt64Data struct {
 	Info *HistogramInt64
 	// Rows holds the per group values for the metric.
 	Rows []*HistogramInt64Row
-	// End is the last time this metric was updated.
+	// EndTime is the last time this metric was updated.
 	EndTime time.Time
 
 	groups [][]label.Label
@@ -89,7 +89,7 @@ type HistogramFloat64Data struct {
 	Info *HistogramFloat64
 	// Rows holds the per group values for the metric.
 	Rows []*HistogramFloat64Row
-	// End is the last time this metric was updated.
+	// EndTime is the last time this metric was updated.
 	EndTime time.Time
 
 	groups [][]label.Label

internal/jsonrpc2/wire.go

@@ -47,7 +47,7 @@ type wireRequest struct {
 	ID *ID `json:"id,omitempty"`
 }
 
-// WireResponse is a reply to a Request.
+// wireResponse is a reply to a Request.
 // It will always have the ID field set to tie it back to a request, and will
 // have either the Result or Error fields set depending on whether it is a
 // success or failure response.

internal/modindex/index.go

@@ -244,7 +244,7 @@ func writeIndexToFile(x *Index, fd *os.File) error {
 // tests can override this
 var IndexDir = indexDir
 
-// IndexDir computes the directory containing the index
+// indexDir computes the directory containing the index
 func indexDir() (string, error) {
 	dir, err := os.UserCacheDir()
 	if err != nil {

internal/refactor/inline/callee.go

@@ -769,7 +769,7 @@ func isSelectionOperand(stack []ast.Node) bool {
 // use of b.
 type shadowMap map[string]int
 
-// addShadows returns the [shadowMap] augmented by the set of names
+// add returns the [shadowMap] augmented by the set of names
 // locally shadowed at the location of the reference in the callee
 // (identified by the stack). The name of the reference itself is
 // excluded.

internal/testenv/testenv.go

@@ -364,7 +364,7 @@ func NeedsGo1Point(t testing.TB, x int) {
 	}
 }
 
-// SkipAfterGo1Point skips t if the ambient go command version in the PATH of
+// SkipAfterGoCommand1Point skips t if the ambient go command version in the PATH of
 // the current process is newer than 1.x.
 //
 // SkipAfterGoCommand1Point memoizes the result of running the go command, so