From 67f35296b2b79b35e6eb296a8b709ee2bbcab3bf Mon Sep 17 00:00:00 2001 From: Christopher Jeffrey Date: Fri, 15 Apr 2016 07:32:44 -0700 Subject: [PATCH] docs fixes. --- lib/bcoin/chainblock.js | 1 + lib/bcoin/script.js | 14 +++++++------- 2 files changed, 8 insertions(+), 7 deletions(-) diff --git a/lib/bcoin/chainblock.js b/lib/bcoin/chainblock.js index 76de858e..04b6f1c7 100644 --- a/lib/bcoin/chainblock.js +++ b/lib/bcoin/chainblock.js @@ -462,6 +462,7 @@ ChainBlock.prototype.inspect = function inspect() { /** * Test whether an object is a {@link ChainBlock}. + * @param {Object} obj * @returns {Boolean} */ diff --git a/lib/bcoin/script.js b/lib/bcoin/script.js index 5d92aab8..e3bcb1c5 100644 --- a/lib/bcoin/script.js +++ b/lib/bcoin/script.js @@ -550,7 +550,7 @@ Stack.prototype.over = function over() { /** * Perform the OP_PICK operation. - * @param {module:script~VerifyFlags} flags + * @param {VerifyFlags} flags * @throws {ScriptError} */ @@ -560,7 +560,7 @@ Stack.prototype.pick = function pick(flags) { /** * Perform the OP_ROLL operation. - * @param {module.script~VerifyFlags} flags + * @param {VerifyFlags} flags * @throws {ScriptError} */ @@ -2695,7 +2695,7 @@ Script.isData = function isData(data) { /** * Test whether the data element is a valid key if VERIFY_STRICTENC is enabled. * @param {Buffer} key - * @param {module.script~VerifyFlags?} flags + * @param {VerifyFlags?} flags * @returns {Boolean} */ @@ -2749,7 +2749,7 @@ Script.isKeyEncoding = function isKeyEncoding(key) { * and VERIFY_STRING_ENC to be enabled respectively. Note that * this will allow zero-length signatures. * @param {Buffer} sig - * @param {module.script~VerifyFlags?} flags + * @param {VerifyFlags?} flags * @returns {Boolean} */ @@ -3198,7 +3198,7 @@ Script.fromSymbolic = function fromSymbolic(items) { * @param {Script} output * @param {TX} tx * @param {Number} i - * @param {module.script~VerifyFlags} flags + * @param {VerifyFlags} flags * @returns {Boolean} */ @@ -3311,7 +3311,7 @@ Script.verify = function verify(input, witness, output, tx, i, flags) { * the witness to a stack and execute the program. * @param {Witness} witness * @param {Script} output - * @param {module.script~VerifyFlags} flags + * @param {VerifyFlags} flags * @param {TX} tx * @param {Number} i */ @@ -3409,7 +3409,7 @@ Script.concat = function concat(scripts) { * @param {Buffer} msg - Signature hash. * @param {Buffer} sig * @param {Buffer} key - * @param {module.script~VerifyFlags?} flags - If none of VERIFY_DERSIG, + * @param {VerifyFlags?} flags - If none of VERIFY_DERSIG, * VERIFY_LOW_S, or VERIFY_STRICTENC are enabled, the signature * is treated as historical, allowing odd signature lengths * and high S values.