From f4b0d029df95fde851d62ef9d2f215a2d00c34cd Mon Sep 17 00:00:00 2001 From: Christopher Jeffrey Date: Tue, 31 May 2016 13:29:42 -0700 Subject: [PATCH] docs. --- lib/bcoin/hd.js | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/lib/bcoin/hd.js b/lib/bcoin/hd.js index 51db0ca8..08b0674c 100644 --- a/lib/bcoin/hd.js +++ b/lib/bcoin/hd.js @@ -223,7 +223,7 @@ Mnemonic.getWordlist = function getWordlist(language) { }; /** - * Test an object to see if it is an Mnemonic. + * Test whether an object is a Mnemonic. * @param {Object} obj * @returns {Boolean} */ @@ -434,7 +434,7 @@ HD.parsePath = function parsePath(path, max) { HD.cache = new LRU(500); /** - * Test an object to see if it is an HD key. + * Test whether an object is an HD key. * @param {Object} obj * @returns {Boolean} */ @@ -450,7 +450,7 @@ HD.isHD = function isHD(obj) { * @constructor * @param {Object|Base58String} options * @param {Base58String?} options.xkey - Serialized base58 key. - * @param {(Mnemonic|Object)?} options.mnemonic - mnemonic or mnemonic options. + * @param {Mnemonic?} options.mnemonic * @param {Number?} options.depth * @param {Buffer?} options.parentFingerPrint * @param {Number?} options.childIndex @@ -963,8 +963,8 @@ HDPrivateKey.prototype.toBase58 = function toBase58(network) { }; /** - * Serialize the key - * @param {Network|String} network + * Serialize the key. + * @param {Network|NetworkType} network * @returns {Buffer} */ @@ -1113,7 +1113,7 @@ HDPrivateKey.fromJSON = function fromJSON(json, passphrase) { }; /** - * Test an object to see if it is a HDPrivateKey. + * Test whether an object is an HDPrivateKey. * @param {Object} obj * @returns {Boolean} */ @@ -1462,8 +1462,8 @@ HDPublicKey.prototype.toBase58 = function toBase58(network) { }; /** - * Serialize the key - * @param {Network|String} network + * Serialize the key. + * @param {Network|NetworkType} network * @returns {Buffer} */ @@ -1510,7 +1510,7 @@ HDPublicKey.fromRaw = function fromRaw(data) { }; /** - * Test an object to see if it is a HDPublicKey. + * Test whether an object is a HDPublicKey. * @param {Object} obj * @returns {Boolean} */ @@ -1563,7 +1563,8 @@ HDPublicKey.isHDPublicKey = function isHDPublicKey(obj) { * @memberof HDPublicKey# * @param {Buffer} msg * @param {Buffer} sig - * @returns {Buffer} + * @param {Buffer} key + * @returns {Boolean} */ HD.prototype.verify = function verify() {