code review 6354100: bcrypt: Documentation

bcrypt/bcrypt.go

 // Copyright 2011 The Go Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
 // Package bcrypt implements Provos and Mazières's bcrypt adaptive hashing
 // algorithm. See http://www.usenix.org/event/usenix99/provos/provos.pdf
 package bcrypt
 
 // The code is a port of Provos and Mazières's C implementation.·
 import (
@@ skipping 65 matching lines @@
 type hashed struct {
         hash  []byte
         salt  []byte
         cost  uint32 // allowed range is MinCost to MaxCost
         major byte
         minor byte
 }
 
 // GenerateFromPassword returns the bcrypt hash of the password at the given
 // cost. If the cost given is less than MinCost, the cost will be set to
-// MinCost, instead. Use CompareHashAndPassword, as defined in this package,
+// DefaultCost, instead. Use CompareHashAndPassword, as defined in this package,
 // to compare the returned hashed password with its cleartext version.
 func GenerateFromPassword(password []byte, cost int) ([]byte, error) {
         p, err := newFromPassword(password, cost)
         if err != nil {
                 return nil, err
         }
         return p.Hash(), nil
 }
 
 // CompareHashAndPassword compares a bcrypt hashed password with its possible
@@ skipping 176 matching lines @@
 func (p *hashed) String() string {
         return fmt.Sprintf("&{hash: %#v, salt: %#v, cost: %d, major: %c, minor: %c}", string(p.hash), p.salt, p.cost, p.major, p.minor)
 }
 
 func checkCost(cost int) error {
         if cost < MinCost || cost > MaxCost {
                 return InvalidCostError(cost)
         }
         return nil
 }