mirror of
https://github.com/golang/go.git
synced 2025-05-19 06:14:40 +00:00
all: change some function documentation to be more idiomatic
Change-Id: I932de9bb061a8ba3332ef03207983e8b98d6f1e5 Reviewed-on: https://go-review.googlesource.com/c/go/+/187918 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org> Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org> TryBot-Result: Gobot Gobot <gobot@golang.org>
This commit is contained in:
parent
a25c2878c7
commit
c4ca60313e
@ -555,7 +555,7 @@ func decryptAndCheck(random io.Reader, priv *PrivateKey, c *big.Int) (m *big.Int
|
||||
}
|
||||
|
||||
// DecryptOAEP decrypts ciphertext using RSA-OAEP.
|
||||
|
||||
//
|
||||
// OAEP is parameterised by a hash function that is used as a random oracle.
|
||||
// Encryption and decryption of a given message must use the same hash function
|
||||
// and sha256.New() is a reasonable choice.
|
||||
|
@ -41,7 +41,7 @@ func NewWriter(w io.Writer) *Writer {
|
||||
}
|
||||
}
|
||||
|
||||
// Writer writes a single CSV record to w along with any necessary quoting.
|
||||
// Write writes a single CSV record to w along with any necessary quoting.
|
||||
// A record is a slice of strings with each string being one field.
|
||||
// Writes are buffered, so Flush must eventually be called to ensure
|
||||
// that the record is written to the underlying io.Writer.
|
||||
|
@ -205,7 +205,7 @@ func (v *Map) AddFloat(key string, delta float64) {
|
||||
}
|
||||
}
|
||||
|
||||
// Deletes the given key from the map.
|
||||
// Delete deletes the given key from the map.
|
||||
func (v *Map) Delete(key string) {
|
||||
v.keysMu.Lock()
|
||||
defer v.keysMu.Unlock()
|
||||
|
@ -42,7 +42,7 @@ func NewScope(parent *Scope, pos, end token.Pos, comment string) *Scope {
|
||||
// Parent returns the scope's containing (parent) scope.
|
||||
func (s *Scope) Parent() *Scope { return s.parent }
|
||||
|
||||
// Len() returns the number of scope elements.
|
||||
// Len returns the number of scope elements.
|
||||
func (s *Scope) Len() int { return len(s.elems) }
|
||||
|
||||
// Names returns the scope's element names in sorted order.
|
||||
@ -57,7 +57,7 @@ func (s *Scope) Names() []string {
|
||||
return names
|
||||
}
|
||||
|
||||
// NumChildren() returns the number of scopes nested in s.
|
||||
// NumChildren returns the number of scopes nested in s.
|
||||
func (s *Scope) NumChildren() int { return len(s.children) }
|
||||
|
||||
// Child returns the i'th child scope for 0 <= i < NumChildren().
|
||||
|
@ -24,7 +24,7 @@ import (
|
||||
//
|
||||
type Qualifier func(*Package) string
|
||||
|
||||
// RelativeTo(pkg) returns a Qualifier that fully qualifies members of
|
||||
// RelativeTo returns a Qualifier that fully qualifies members of
|
||||
// all packages other than pkg.
|
||||
func RelativeTo(pkg *Package) Qualifier {
|
||||
if pkg == nil {
|
||||
|
@ -148,7 +148,7 @@ type Address struct {
|
||||
Address string // user@domain
|
||||
}
|
||||
|
||||
// Parses a single RFC 5322 address, e.g. "Barry Gibbs <bg@example.com>"
|
||||
// ParseAddress parses a single RFC 5322 address, e.g. "Barry Gibbs <bg@example.com>"
|
||||
func ParseAddress(address string) (*Address, error) {
|
||||
return (&addrParser{s: address}).parseSingleAddress()
|
||||
}
|
||||
|
Loading…
x
Reference in New Issue
Block a user