Documentation fixes

Author: dcodeIO

README.md

@@ -154,8 +154,8 @@ Asynchronously generates a salt.
 | rounds          | *number | function(Error, string=)* | Number of rounds to use, defaults to 10 if omitted 
 | seed_length     | *number | function(Error, string=)* | Not supported. 
 | callback        | *function(Error, string=)* | Callback receiving the error, if any, and the resulting salt 
-| @returns        | *Promise*       | If `callback` has been omitted
-| **@throws**     | *Error*         | If the callback argument is present but not a function
+| **@returns**    | *Promise*       | If `callback` has been omitted
+| **@throws**     | *Error*         | If `callback` is present but not a function
 
 ### hashSync(s, salt=)
 
@@ -177,8 +177,8 @@ Asynchronously generates a hash for the given string.
 | salt            | *number | string* | Salt length to generate or salt to use 
 | callback        | *function(Error, string=)* | Callback receiving the error, if any, and the resulting hash 
 | progressCallback | *function(number)* | Callback successively called with the percentage of rounds completed (0.0 - 1.0), maximally once per `MAX_EXECUTION_TIME = 100` ms.
-| @returns        | *Promise*       | If `callback` has been omitted
-| **@throws**     | *Error*         | If the callback argument is present but not a function 
+| **@returns**    | *Promise*       | If `callback` has been omitted
+| **@throws**     | *Error*         | If `callback` is present but not a function
 
 ### compareSync(s, hash)
 
@@ -201,8 +201,8 @@ Asynchronously compares the given data against the given hash.
 | hash            | *string*        | Data to be compared to 
 | callback        | *function(Error, boolean)* | Callback receiving the error, if any, otherwise the result 
 | progressCallback | *function(number)* | Callback successively called with the percentage of rounds completed (0.0 - 1.0), maximally once per `MAX_EXECUTION_TIME = 100` ms.
-| @returns        | *Promise*       | If `callback` has been omitted 
-| **@throws**     | *Error*         | If the callback argument is present but not a function
+| **@returns**    | *Promise*       | If `callback` has been omitted 
+| **@throws**     | *Error*         | If `callback` is present but not a function
 
 ### getRounds(hash)
 
@@ -212,7 +212,7 @@ Gets the number of rounds used to encrypt the specified hash.
 |-----------------|-----------------|---------------
 | hash            | *string*        | Hash to extract the used number of rounds from 
 | **@returns**    | *number*        | Number of rounds used 
-| **@throws**     | *Error*         | If hash is not a string 
+| **@throws**     | *Error*         | If `hash` is not a string 
 
 ### getSalt(hash)
 

dist/bcrypt.js

@@ -132,7 +132,7 @@
      * @param {(number|function(Error, string=))=} seed_length Not supported.
      * @param {function(Error, string=)=} callback Callback receiving the error, if any, and the resulting salt
      * @returns {!Promise} If `callback` has been omitted
-     * @throws {Error} If the callback argument is present but not a function
+     * @throws {Error} If `callback` is present but not a function
      * @expose
      */
     bcrypt.genSalt = function(rounds, seed_length, callback) {
@@ -198,7 +198,7 @@
      * @param {function(number)=} progressCallback Callback successively called with the percentage of rounds completed
      *  (0.0 - 1.0), maximally once per `MAX_EXECUTION_TIME = 100` ms.
      * @returns {!Promise} If `callback` has been omitted
-     * @throws {Error} If the callback argument is present but not a function
+     * @throws {Error} If `callback` is present but not a function
      * @expose
      */
     bcrypt.hash = function(s, salt, callback, progressCallback) {
@@ -276,7 +276,7 @@
      * @param {function(number)=} progressCallback Callback successively called with the percentage of rounds completed
      *  (0.0 - 1.0), maximally once per `MAX_EXECUTION_TIME = 100` ms.
      * @returns {!Promise} If `callback` has been omitted
-     * @throws {Error} If the callback argument is present but not a function
+     * @throws {Error} If `callback` is present but not a function
      * @expose
      */
     bcrypt.compare = function(s, hash, callback, progressCallback) {
@@ -318,7 +318,7 @@
      * Gets the number of rounds used to encrypt the specified hash.
      * @param {string} hash Hash to extract the used number of rounds from
      * @returns {number} Number of rounds used
-     * @throws {Error} If hash is not a string
+     * @throws {Error} If `hash` is not a string
      * @expose
      */
     bcrypt.getRounds = function(hash) {

src/bcrypt.js

@@ -92,7 +92,7 @@ bcrypt.genSaltSync = function(rounds, seed_length) {
  * @param {(number|function(Error, string=))=} seed_length Not supported.
  * @param {function(Error, string=)=} callback Callback receiving the error, if any, and the resulting salt
  * @returns {!Promise} If `callback` has been omitted
- * @throws {Error} If the callback argument is present but not a function
+ * @throws {Error} If `callback` is present but not a function
  * @expose
  */
 bcrypt.genSalt = function(rounds, seed_length, callback) {
@@ -158,7 +158,7 @@ bcrypt.hashSync = function(s, salt) {
  * @param {function(number)=} progressCallback Callback successively called with the percentage of rounds completed
  *  (0.0 - 1.0), maximally once per `MAX_EXECUTION_TIME = 100` ms.
  * @returns {!Promise} If `callback` has been omitted
- * @throws {Error} If the callback argument is present but not a function
+ * @throws {Error} If `callback` is present but not a function
  * @expose
  */
 bcrypt.hash = function(s, salt, callback, progressCallback) {
@@ -236,7 +236,7 @@ bcrypt.compareSync = function(s, hash) {
  * @param {function(number)=} progressCallback Callback successively called with the percentage of rounds completed
  *  (0.0 - 1.0), maximally once per `MAX_EXECUTION_TIME = 100` ms.
  * @returns {!Promise} If `callback` has been omitted
- * @throws {Error} If the callback argument is present but not a function
+ * @throws {Error} If `callback` is present but not a function
  * @expose
  */
 bcrypt.compare = function(s, hash, callback, progressCallback) {
@@ -278,7 +278,7 @@ bcrypt.compare = function(s, hash, callback, progressCallback) {
  * Gets the number of rounds used to encrypt the specified hash.
  * @param {string} hash Hash to extract the used number of rounds from
  * @returns {number} Number of rounds used
- * @throws {Error} If hash is not a string
+ * @throws {Error} If `hash` is not a string
  * @expose
  */
 bcrypt.getRounds = function(hash) {