diff --git a/lib/bcoin/block.js b/lib/bcoin/block.js index 02432202..52bc2fee 100644 --- a/lib/bcoin/block.js +++ b/lib/bcoin/block.js @@ -319,7 +319,7 @@ Block.prototype.__defineGetter__('commitmentHash', function() { /** * Do non-contextual verification on the block. Including checking the block * size, the coinbase and the merkle root. This is consensus-critical. - * @name verify + * @alias verify * @param {Object?} ret - Return object, may be * set with properties `reason` and `score`. * @returns {Boolean} diff --git a/lib/bcoin/compactblock.js b/lib/bcoin/compactblock.js index f9f5fbc0..2ef4e53f 100644 --- a/lib/bcoin/compactblock.js +++ b/lib/bcoin/compactblock.js @@ -67,7 +67,7 @@ utils.inherits(CompactBlock, bcoin.abstractblock); /** * Verify the block headers. - * @name verify + * @alias verify * @param {Object?} ret - Return object, may be * set with properties `reason` and `score`. * @returns {Boolean} diff --git a/lib/bcoin/headers.js b/lib/bcoin/headers.js index 3922256a..7e736aca 100644 --- a/lib/bcoin/headers.js +++ b/lib/bcoin/headers.js @@ -51,7 +51,7 @@ Headers.prototype.render = function render() { /** * Do non-contextual verification on the headers. - * @name verify + * @alias verify * @param {Object?} ret - Return object, may be * set with properties `reason` and `score`. * @returns {Boolean} diff --git a/lib/bcoin/http/request.js b/lib/bcoin/http/request.js index 580f2dbf..bd6b9b01 100644 --- a/lib/bcoin/http/request.js +++ b/lib/bcoin/http/request.js @@ -5,6 +5,10 @@ * https://github.com/indutny/bcoin */ +/** + * @module request + */ + var Stream = require('stream').Stream; var assert = require('../utils').assert; @@ -13,9 +17,7 @@ var USER_AGENT = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1)' + ' AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36'; /** - * Request - * @exports request - * @function + * Make an HTTP request. * @param {Object} options * @param {String} options.uri * @param {Object?} options.query @@ -33,7 +35,7 @@ var USER_AGENT = 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_1)' * @param {String?} options.expect - Type to expect (see options.type). * Error will be returned if the response is not of this type. * @param {Number?} options.limit - Byte limit on response. - * @param {Function} callback + * @param {Function?} callback - Will return a stream if not present. */ function request(options, callback, stream) { diff --git a/lib/bcoin/merkleblock.js b/lib/bcoin/merkleblock.js index 11bfa2e8..e0e1c615 100644 --- a/lib/bcoin/merkleblock.js +++ b/lib/bcoin/merkleblock.js @@ -192,7 +192,7 @@ MerkleBlock.prototype._verifyPartial = function _verifyPartial() { /** * Do non-contextual verification on the block. * Verify the headers and the partial merkle tree. - * @name verify + * @alias verify * @param {Object?} ret - Return object, may be * set with properties `reason` and `score`. * @returns {Boolean}