all: add period for comments

Change-Id: Ibba1da1c0f430a144fc44dcbd82568825ba71966

Author: egonelbre

bloomfilter/filter.go

@@ -20,10 +20,10 @@ const (
 )
 
 // rangeOffsets contains offsets for selecting subranges
-// that minimize overlap in the first hash functions
+// that minimize overlap in the first hash functions.
 var rangeOffsets = [...]byte{9, 13, 19, 23}
 
-// Filter is a bloom filter implementation
+// Filter is a bloom filter implementation.
 type Filter struct {
 	seed      byte
 	hashCount byte
@@ -47,7 +47,7 @@ func NewOptimal(expectedElements int, falsePositiveRate float64) *Filter {
 	return newExplicit(seed, byte(hashCount), sizeInBytes)
 }
 
-// NewOptimalMaxSize returns a filter based on expected element count and false positive rate, capped at a maximum size in bytes
+// NewOptimalMaxSize returns a filter based on expected element count and false positive rate, capped at a maximum size in bytes.
 func NewOptimalMaxSize(expectedElements int, falsePositiveRate float64, maxSize memory.Size) *Filter {
 	hashCount, sizeInBytes := getHashCountAndSize(expectedElements, falsePositiveRate)
 	seed := byte(rand.Intn(255))
@@ -77,7 +77,7 @@ func (filter *Filter) Parameters() (hashCount, size int) {
 	return int(filter.hashCount), len(filter.table)
 }
 
-// Add adds an element to the bloom filter
+// Add adds an element to the bloom filter.
 func (filter *Filter) Add(pieceID storj.PieceID) {
 	offset, rangeOffset := initialConditions(filter.seed)
 
@@ -94,7 +94,7 @@ func (filter *Filter) Add(pieceID storj.PieceID) {
 	}
 }
 
-// Contains return true if pieceID may be in the set
+// Contains return true if pieceID may be in the set.
 func (filter *Filter) Contains(pieceID storj.PieceID) bool {
 	offset, rangeOffset := initialConditions(filter.seed)
 

bloomfilter/filter_test.go

@@ -62,7 +62,7 @@ func TestBytes_Failing(t *testing.T) {
 	}
 }
 
-// generateTestIDs generates n piece ids
+// generateTestIDs generates n piece ids.
 func generateTestIDs(n int) []storj.PieceID {
 	ids := make([]storj.PieceID, n)
 	for i := range ids {
@@ -128,7 +128,7 @@ type stats struct {
 	avg, min, mean, max, mse float64
 }
 
-// calculates average, minimum, maximum and mean squared error
+// summarize calculates average, minimum, maximum and mean squared error.
 func summarize(expected float64, values []float64) (r stats) {
 	sort.Float64s(values)
 

context2/nocancel.go

@@ -31,7 +31,7 @@ func (noCancelContext) Done() <-chan struct{} {
 	return nil
 }
 
-// Err always returns nil
+// Err always returns nil.
 func (noCancelContext) Err() error {
 	return nil
 }

encryption/aesgcm.go

@@ -130,7 +130,7 @@ func (s *aesgcmDecrypter) Transform(out, in []byte, blockNum int64) ([]byte, err
 	return plainData, nil
 }
 
-// EncryptAESGCM encrypts byte data with a key and nonce. The cipher data is returned
+// EncryptAESGCM encrypts byte data with a key and nonce. It returns the cipher data.
 func EncryptAESGCM(data []byte, key *storj.Key, nonce *AESGCMNonce) (cipherData []byte, err error) {
 	block, err := aes.NewCipher(key[:])
 	if err != nil {
@@ -144,7 +144,7 @@ func EncryptAESGCM(data []byte, key *storj.Key, nonce *AESGCMNonce) (cipherData
 	return cipherData, nil
 }
 
-// DecryptAESGCM decrypts byte data with a key and nonce. The plain data is returned
+// DecryptAESGCM decrypts byte data with a key and nonce. It returns the plain data.
 func DecryptAESGCM(cipherData []byte, key *storj.Key, nonce *AESGCMNonce) (data []byte, err error) {
 	if len(cipherData) == 0 {
 		return []byte{}, Error.New("empty cipher data")

encryption/common.go

@@ -8,11 +8,11 @@ import (
 	"github.com/zeebo/errs"
 )
 
-// Error is the default encryption errs class
+// Error is the default encryption errs class.
 var Error = errs.Class("encryption error")
 
-// ErrDecryptFailed is the errs class when the decryption fails
+// ErrDecryptFailed is the errs class when the decryption fails.
 var ErrDecryptFailed = errs.Class("decryption failed, check encryption key")
 
-// ErrInvalidConfig is the errs class for invalid configuration
+// ErrInvalidConfig is the errs class for invalid configuration.
 var ErrInvalidConfig = errs.Class("invalid encryption configuration")

encryption/encryption.go

@@ -11,28 +11,28 @@ import (
 )
 
 const (
-	// AESGCMNonceSize is the size of an AES-GCM nonce
+	// AESGCMNonceSize is the size of an AES-GCM nonce.
 	AESGCMNonceSize = 12
-	// unit32Size is the number of bytes in the uint32 type
+	// unit32Size is the number of bytes in the uint32 type.
 	uint32Size = 4
 )
 
-// AESGCMNonce represents the nonce used by the AES-GCM protocol
+// AESGCMNonce represents the nonce used by the AES-GCM protocol.
 type AESGCMNonce [AESGCMNonceSize]byte
 
-// ToAESGCMNonce returns the nonce as a AES-GCM nonce
+// ToAESGCMNonce returns the nonce as a AES-GCM nonce.
 func ToAESGCMNonce(nonce *storj.Nonce) *AESGCMNonce {
 	aes := new(AESGCMNonce)
 	copy((*aes)[:], nonce[:AESGCMNonceSize])
 	return aes
 }
 
-// Increment increments the nonce with the given amount
+// Increment increments the nonce with the given amount.
 func Increment(nonce *storj.Nonce, amount int64) (truncated bool, err error) {
 	return incrementBytes(nonce[:], amount)
 }
 
-// Encrypt encrypts data with the given cipher, key and nonce
+// Encrypt encrypts data with the given cipher, key and nonce.
 func Encrypt(data []byte, cipher storj.CipherSuite, key *storj.Key, nonce *storj.Nonce) (cipherData []byte, err error) {
 	// Don't encrypt empty slice
 	if len(data) == 0 {
@@ -53,7 +53,7 @@ func Encrypt(data []byte, cipher storj.CipherSuite, key *storj.Key, nonce *storj
 	}
 }
 
-// Decrypt decrypts cipherData with the given cipher, key and nonce
+// Decrypt decrypts cipherData with the given cipher, key and nonce.
 func Decrypt(cipherData []byte, cipher storj.CipherSuite, key *storj.Key, nonce *storj.Nonce) (data []byte, err error) {
 	// Don't decrypt empty slice
 	if len(cipherData) == 0 {
@@ -74,7 +74,7 @@ func Decrypt(cipherData []byte, cipher storj.CipherSuite, key *storj.Key, nonce
 	}
 }
 
-// NewEncrypter creates a Transformer using the given cipher, key and nonce to encrypt data passing through it
+// NewEncrypter creates a Transformer using the given cipher, key and nonce to encrypt data passing through it.
 func NewEncrypter(cipher storj.CipherSuite, key *storj.Key, startingNonce *storj.Nonce, encryptedBlockSize int) (Transformer, error) {
 	switch cipher {
 	case storj.EncNull:
@@ -90,7 +90,7 @@ func NewEncrypter(cipher storj.CipherSuite, key *storj.Key, startingNonce *storj
 	}
 }
 
-// NewDecrypter creates a Transformer using the given cipher, key and nonce to decrypt data passing through it
+// NewDecrypter creates a Transformer using the given cipher, key and nonce to decrypt data passing through it.
 func NewDecrypter(cipher storj.CipherSuite, key *storj.Key, startingNonce *storj.Nonce, encryptedBlockSize int) (Transformer, error) {
 	switch cipher {
 	case storj.EncNull:
@@ -106,12 +106,12 @@ func NewDecrypter(cipher storj.CipherSuite, key *storj.Key, startingNonce *storj
 	}
 }
 
-// EncryptKey encrypts keyToEncrypt with the given cipher, key and nonce
+// EncryptKey encrypts keyToEncrypt with the given cipher, key and nonce.
 func EncryptKey(keyToEncrypt *storj.Key, cipher storj.CipherSuite, key *storj.Key, nonce *storj.Nonce) (storj.EncryptedPrivateKey, error) {
 	return Encrypt(keyToEncrypt[:], cipher, key, nonce)
 }
 
-// DecryptKey decrypts keyToDecrypt with the given cipher, key and nonce
+// DecryptKey decrypts keyToDecrypt with the given cipher, key and nonce.
 func DecryptKey(keyToDecrypt storj.EncryptedPrivateKey, cipher storj.CipherSuite, key *storj.Key, nonce *storj.Nonce) (*storj.Key, error) {
 	plainData, err := Decrypt(keyToDecrypt, cipher, key, nonce)
 	if err != nil {
@@ -124,7 +124,7 @@ func DecryptKey(keyToDecrypt storj.EncryptedPrivateKey, cipher storj.CipherSuite
 	return &decryptedKey, nil
 }
 
-// DeriveKey derives new key from the given key and message using HMAC-SHA512
+// DeriveKey derives new key from the given key and message using HMAC-SHA512.
 func DeriveKey(key *storj.Key, message string) (*storj.Key, error) {
 	mac := hmac.New(sha512.New, key[:])
 	_, err := mac.Write([]byte(message))

encryption/path.go

@@ -397,7 +397,7 @@ func decryptPathComponent(comp string, cipher storj.CipherSuite, key *storj.Key)
 // `\xff` escapes to `\xfe\x02`
 // `\x00` escapes to `\x01\x01`
 // `\x01` escapes to `\x01\x02
-// for more details see docs/design/path-component-encoding.md
+// for more details see docs/design/path-component-encoding.md.
 func encodeSegment(segment []byte) []byte {
 	if len(segment) == 0 {
 		return emptyComponent

encryption/secretbox.go

@@ -104,12 +104,12 @@ func (s *secretboxDecrypter) Transform(out, in []byte, blockNum int64) ([]byte,
 	return rv, nil
 }
 
-// EncryptSecretBox encrypts byte data with a key and nonce. The cipher data is returned
+// EncryptSecretBox encrypts byte data with a key and nonce. The cipher data is returned.
 func EncryptSecretBox(data []byte, key *storj.Key, nonce *storj.Nonce) (cipherData []byte, err error) {
 	return secretbox.Seal(nil, data, nonce.Raw(), key.Raw()), nil
 }
 
-// DecryptSecretBox decrypts byte data with a key and nonce. The plain data is returned
+// DecryptSecretBox decrypts byte data with a key and nonce. The plain data is returned.
 func DecryptSecretBox(cipherData []byte, key *storj.Key, nonce *storj.Nonce) (data []byte, err error) {
 	data, success := secretbox.Open(nil, cipherData, nonce.Raw(), key.Raw())
 	if !success {

encryption/transform.go

@@ -35,20 +35,20 @@ type transformedReader struct {
 	bytesRead    int
 }
 
-// NoopTransformer is a dummy Transformer that passes data through without modifying it
+// NoopTransformer is a dummy Transformer that passes data through without modifying it.
 type NoopTransformer struct{}
 
-// InBlockSize is 1
+// InBlockSize is 1.
 func (t *NoopTransformer) InBlockSize() int {
 	return 1
 }
 
-// OutBlockSize is 1
+// OutBlockSize is 1.
 func (t *NoopTransformer) OutBlockSize() int {
 	return 1
 }
 
-// Transform returns the input without modification
+// Transform returns the input without modification.
 func (t *NoopTransformer) Transform(out, in []byte, blockNum int64) ([]byte, error) {
 	return append(out, in...), nil
 }
@@ -137,7 +137,7 @@ func (t *transformedRanger) Size() int64 {
 
 // CalcEncompassingBlocks is a useful helper function that, given an offset,
 // length, and blockSize, will tell you which blocks contain the requested
-// offset and length
+// offset and length.
 func CalcEncompassingBlocks(offset, length int64, blockSize int) (
 	firstBlock, blockCount int64) {
 	firstBlock = offset / int64(blockSize)

errs2/collect.go

@@ -9,7 +9,7 @@ import (
 	"github.com/zeebo/errs"
 )
 
-// Collect returns first error from channel and all errors that happen within duration
+// Collect returns first error from channel and all errors that happen within duration.
 func Collect(errch chan error, duration time.Duration) error {
 	errch = discardNil(errch)
 	errlist := []error{<-errch}
@@ -24,7 +24,7 @@ func Collect(errch chan error, duration time.Duration) error {
 	}
 }
 
-// discard nil errors that are returned from services
+// discard nil errors that are returned from services.
 func discardNil(ch chan error) chan error {
 	r := make(chan error)
 	go func() {

fpath/editor.go

@@ -10,7 +10,7 @@ import (
 	"strings"
 )
 
-//EditFile opens the best OS-specific text editor we can find
+//EditFile opens the best OS-specific text editor we can find.
 func EditFile(fileToEdit string) error {
 	editorPath := getEditorPath()
 	if editorPath == "" {

fpath/os.go

@@ -15,7 +15,7 @@ import (
 	"github.com/zeebo/errs"
 )
 
-// IsRoot returns whether path is the root directory
+// IsRoot returns whether path is the root directory.
 func IsRoot(path string) bool {
 	abs, err := filepath.Abs(path)
 	if err == nil {
@@ -25,7 +25,7 @@ func IsRoot(path string) bool {
 	return filepath.Dir(path) == path
 }
 
-// ApplicationDir returns best base directory for specific OS
+// ApplicationDir returns best base directory for specific OS.
 func ApplicationDir(subdir ...string) string {
 	for i := range subdir {
 		if runtime.GOOS == "windows" || runtime.GOOS == "darwin" {
@@ -62,7 +62,7 @@ func ApplicationDir(subdir ...string) string {
 	return filepath.Join(append([]string{appdir}, subdir...)...)
 }
 
-// IsValidSetupDir checks if directory is valid for setup configuration
+// IsValidSetupDir checks if directory is valid for setup configuration.
 func IsValidSetupDir(name string) (ok bool, err error) {
 	_, err = os.Stat(name)
 	if err != nil {
@@ -100,7 +100,7 @@ func IsValidSetupDir(name string) (ok bool, err error) {
 	}
 }
 
-// IsWritable determines if a directory is writeable
+// IsWritable determines if a directory is writeable.
 func IsWritable(filepath string) (bool, error) {
 	info, err := os.Stat(filepath)
 	if err != nil {

fpath/path.go

@@ -50,7 +50,7 @@ func parseBucket(o string) (bucket, rest string) {
 	return "", o
 }
 
-// New creates new FPath from the given URL
+// New creates new FPath from the given URL.
 func New(p string) (FPath, error) {
 	fp := FPath{original: p}
 
@@ -101,7 +101,7 @@ func New(p string) (FPath, error) {
 	return fp, nil
 }
 
-// Join is appends the given segment to the path
+// Join is appends the given segment to the path.
 func (p FPath) Join(segment string) FPath {
 	if p.local {
 		p.original = filepath.Join(p.original, segment)
@@ -113,7 +113,7 @@ func (p FPath) Join(segment string) FPath {
 	return p
 }
 
-// Base returns the last segment of the path
+// Base returns the last segment of the path.
 func (p FPath) Base() string {
 	if p.local {
 		return filepath.Base(p.original)
@@ -124,25 +124,25 @@ func (p FPath) Base() string {
 	return path.Base(p.path)
 }
 
-// Bucket returns the first segment of path
+// Bucket returns the first segment of path.
 func (p FPath) Bucket() string {
 	return p.bucket
 }
 
-// Path returns the URL path without the scheme
+// Path returns the URL path without the scheme.
 func (p FPath) Path() string {
 	if p.local {
 		return p.original
 	}
 	return p.path
 }
 
-// IsLocal returns whether the path refers to local or remote location
+// IsLocal returns whether the path refers to local or remote location.
 func (p FPath) IsLocal() bool {
 	return p.local
 }
 
-// String returns the entire URL (untouched)
+// String returns the entire URL (untouched).
 func (p FPath) String() string {
 	return p.original
 }

fpath/temp_data.go

@@ -11,15 +11,15 @@ import "context"
 // other packages.
 type key int
 
-// temp is the context key for temp struct
+// temp is the context key for temp struct.
 const tempKey key = 0
 
 type temp struct {
 	inmemory  bool
 	directory string
 }
 
-// WithTempData creates context with information how store temporary data, in memory or on disk
+// WithTempData creates context with information how store temporary data, in memory or on disk.
 func WithTempData(ctx context.Context, directory string, inmemory bool) context.Context {
 	temp := temp{
 		inmemory:  inmemory,
@@ -28,7 +28,7 @@ func WithTempData(ctx context.Context, directory string, inmemory bool) context.
 	return context.WithValue(ctx, tempKey, temp)
 }
 
-// GetTempData returns if temporary data should be stored in memory or on disk
+// GetTempData returns if temporary data should be stored in memory or on disk.
 func GetTempData(ctx context.Context) (string, bool, bool) {
 	tempValue, ok := ctx.Value(tempKey).(temp)
 	if !ok {