all: correct name for comments

Change-Id: I390c380349e99ad421264b673ad7734eddb639d3
GitHub-Last-Rev: 32e849a642
GitHub-Pull-Request: golang/go#75905
Reviewed-on: https://go-review.googlesource.com/c/go/+/711941
Reviewed-by: Jorropo <jorropo.pgm@gmail.com>
Reviewed-by: Keith Randall <khr@golang.org>
Reviewed-by: Keith Randall <khr@google.com>
Auto-Submit: Jorropo <jorropo.pgm@gmail.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Auto-Submit: Keith Randall <khr@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>

src/cmd/compile/internal/bitvec/bv.go

@@ -93,7 +93,7 @@ func (bv BitVec) Unset(i int32) {
 	bv.B[i/wordBits] &^= mask
 }
 
-// bvnext returns the smallest index >= i for which bvget(bv, i) == 1.
+// Next returns the smallest index >= i for which bvget(bv, i) == 1.
 // If there is no such index, bvnext returns -1.
 func (bv BitVec) Next(i int32) int32 {
 	if i >= bv.N {

src/cmd/compile/internal/ir/expr.go

@@ -617,7 +617,7 @@ func (o Op) IsSlice3() bool {
 	return false
 }
 
-// A SliceHeader expression constructs a slice header from its parts.
+// A SliceHeaderExpr constructs a slice header from its parts.
 type SliceHeaderExpr struct {
 	miniExpr
 	Ptr Node
@@ -665,7 +665,7 @@ func NewStarExpr(pos src.XPos, x Node) *StarExpr {
 func (n *StarExpr) Implicit() bool     { return n.flags&miniExprImplicit != 0 }
 func (n *StarExpr) SetImplicit(b bool) { n.flags.set(miniExprImplicit, b) }
 
-// A TypeAssertionExpr is a selector expression X.(Type).
+// A TypeAssertExpr is a selector expression X.(Type).
 // Before type-checking, the type is Ntype.
 type TypeAssertExpr struct {
 	miniExpr

src/cmd/compile/internal/s390x/ggen.go

@@ -11,7 +11,7 @@ import (
 	"cmd/internal/obj/s390x"
 )
 
-// clearLoopCutOff is the (somewhat arbitrary) value above which it is better
+// clearLoopCutoff is the (somewhat arbitrary) value above which it is better
 // to have a loop of clear instructions (e.g. XCs) rather than just generating
 // multiple instructions (i.e. loop unrolling).
 // Must be between 256 and 4096.

src/cmd/compile/internal/types/type.go

@@ -328,7 +328,7 @@ func (t *Type) funcType() *Func {
 	return t.extra.(*Func)
 }
 
-// StructType contains Type fields specific to struct types.
+// Struct contains Type fields specific to struct types.
 type Struct struct {
 	fields fields
 

src/cmd/compile/internal/types2/object.go

@@ -328,7 +328,7 @@ func (obj *TypeName) IsAlias() bool {
 	}
 }
 
-// A Variable represents a declared variable (including function parameters and results, and struct fields).
+// A Var represents a declared variable (including function parameters and results, and struct fields).
 type Var struct {
 	object
 	origin   *Var // if non-nil, the Var from which this one was instantiated

src/cmd/go/internal/vet/vet.go

@@ -396,7 +396,7 @@ type jsonError struct {
 	Err string `json:"error"`
 }
 
-// A TextEdit describes the replacement of a portion of a file.
+// A jsonTextEdit describes the replacement of a portion of a file.
 // Start and End are zero-based half-open indices into the original byte
 // sequence of the file, and New is the new text.
 type jsonTextEdit struct {
@@ -424,7 +424,7 @@ type jsonDiagnostic struct {
 	Related        []jsonRelatedInformation `json:"related,omitempty"`
 }
 
-// A jsonRelated describes a secondary position and message related to
+// A jsonRelatedInformation describes a secondary position and message related to
 // a primary diagnostic.
 type jsonRelatedInformation struct {
 	Posn    string `json:"posn"` // e.g. "file.go:line:column"

src/cmd/internal/obj/x86/evex.go

@@ -165,7 +165,7 @@ func evexZcase(zcase uint8) bool {
 	return zcase > Zevex_first && zcase < Zevex_last
 }
 
-// evexSuffixBits carries instruction EVEX suffix set flags.
+// evexSuffix carries instruction EVEX suffix set flags.
 //
 // Examples:
 //

src/cmd/internal/objfile/goobj.go

@@ -227,7 +227,7 @@ func (f *goobjFile) pcln() (textStart uint64, symtab, pclntab []byte, err error)
 	return 0, nil, nil, fmt.Errorf("pcln not available in go object file")
 }
 
-// Find returns the file name, line, and function data for the given pc.
+// PCToLine returns the file name, line, and function data for the given pc.
 // Returns "",0,nil if unknown.
 // This function implements the Liner interface in preference to pcln() above.
 func (f *goobjFile) PCToLine(pc uint64) (string, int, *gosym.Func) {

src/cmd/link/internal/loader/symbolbuilder.go

@@ -139,7 +139,7 @@ func (sb *SymbolBuilder) SetRelocAdd(i int, a int64) {
 	sb.relocs[i].SetAdd(a)
 }
 
-// SetRelocAdd sets the size of the 'i'-th relocation on this sym to 'sz'
+// SetRelocSiz sets the size of the 'i'-th relocation on this sym to 'sz'
 func (sb *SymbolBuilder) SetRelocSiz(i int, sz uint8) {
 	sb.relocs[i].SetSiz(sz)
 }

src/crypto/internal/fips140/rsa/pkcs1v22.go

@@ -316,7 +316,7 @@ func VerifyPSS(pub *PublicKey, hash hash.Hash, digest []byte, sig []byte) error
 	return verifyPSS(pub, hash, digest, sig, pssSaltLengthAutodetect)
 }
 
-// VerifyPSS verifies sig with RSASSA-PSS and an expected salt length.
+// VerifyPSSWithSaltLength verifies sig with RSASSA-PSS and an expected salt length.
 func VerifyPSSWithSaltLength(pub *PublicKey, hash hash.Hash, digest []byte, sig []byte, saltLength int) error {
 	if saltLength < 0 {
 		return errors.New("crypto/rsa: salt length cannot be negative")

src/crypto/x509/oid.go

@@ -286,7 +286,7 @@ func (oid OID) EqualASN1OID(other asn1.ObjectIdentifier) bool {
 	return i == len(other)
 }
 
-// Strings returns the string representation of the Object Identifier.
+// String returns the string representation of the Object Identifier.
 func (oid OID) String() string {
 	var b strings.Builder
 	b.Grow(32)

src/debug/dwarf/entry.go

@@ -229,7 +229,7 @@ func formToClass(form format, attr Attr, vers int, b *buf) Class {
 	}
 }
 
-// An entry is a sequence of attribute/value pairs.
+// An Entry is a sequence of attribute/value pairs.
 type Entry struct {
 	Offset   Offset // offset of Entry in DWARF info
 	Tag      Tag    // tag (kind of Entry)

src/go/scanner/scanner.go

@@ -107,7 +107,7 @@ func (s *Scanner) peek() byte {
 	return 0
 }
 
-// A mode value is a set of flags (or 0).
+// A Mode value is a set of flags (or 0).
 // They control scanner behavior.
 type Mode uint
 

src/go/types/object.go

@@ -331,7 +331,7 @@ func (obj *TypeName) IsAlias() bool {
 	}
 }
 
-// A Variable represents a declared variable (including function parameters and results, and struct fields).
+// A Var represents a declared variable (including function parameters and results, and struct fields).
 type Var struct {
 	object
 	origin   *Var // if non-nil, the Var from which this one was instantiated

src/internal/coverage/cmerge/merge.go

@@ -57,7 +57,7 @@ func (m *Merger) MergeCounters(dst, src []uint32) (error, bool) {
 	return nil, ovf
 }
 
-// Saturating add does a saturating addition of 'dst' and 'src',
+// SaturatingAdd does a saturating addition of 'dst' and 'src',
 // returning added value or math.MaxUint32 if there is an overflow.
 // Overflows are recorded in case the client needs to track them.
 func (m *Merger) SaturatingAdd(dst, src uint32) uint32 {
@@ -68,7 +68,7 @@ func (m *Merger) SaturatingAdd(dst, src uint32) uint32 {
 	return result
 }
 
-// Saturating add does a saturating addition of 'dst' and 'src',
+// SaturatingAdd does a saturating addition of 'dst' and 'src',
 // returning added value or math.MaxUint32 plus an overflow flag.
 func SaturatingAdd(dst, src uint32) (uint32, bool) {
 	d, s := uint64(dst), uint64(src)

src/internal/goarch/goarch.go

@@ -34,7 +34,7 @@ const (
 // It is also the size of the machine's native word size (that is, 4 on 32-bit systems, 8 on 64-bit).
 const PtrSize = 4 << (^uintptr(0) >> 63)
 
-// PtrSize is bit width of a pointer.
+// PtrBits is bit width of a pointer.
 const PtrBits = PtrSize * 8
 
 // ArchFamily is the architecture family (AMD64, ARM, ...)

src/internal/runtime/maps/table.go

@@ -716,7 +716,7 @@ func (it *Iter) Key() unsafe.Pointer {
 	return it.key
 }
 
-// Key returns a pointer to the current element. nil indicates end of
+// Elem returns a pointer to the current element. nil indicates end of
 // iteration.
 //
 // Must not be called prior to Next.

src/internal/trace/event.go

@@ -197,7 +197,7 @@ type Range struct {
 	Scope ResourceID
 }
 
-// RangeAttributes provides attributes about a completed Range.
+// RangeAttribute provides attributes about a completed Range.
 type RangeAttribute struct {
 	// Name is the human-readable name for the range.
 	Name string

src/runtime/mspanset.go

@@ -407,7 +407,7 @@ func (p *atomicMSpanPointer) Load() *mspan {
 	return (*mspan)(p.p.Load())
 }
 
-// Store stores an *mspan.
+// StoreNoWB stores an *mspan.
 func (p *atomicMSpanPointer) StoreNoWB(s *mspan) {
 	p.p.StoreNoWB(unsafe.Pointer(s))
 }

src/text/template/parse/parse.go

@@ -35,7 +35,7 @@ type Tree struct {
 	stackDepth int // depth of nested parenthesized expressions
 }
 
-// A mode value is a set of flags (or 0). Modes control parser behavior.
+// A Mode value is a set of flags (or 0). Modes control parser behavior.
 type Mode uint
 
 const (