fix docs.

This commit is contained in:
Christopher Jeffrey 2016-04-16 21:11:33 -07:00
parent a06eec2986
commit 81e978f51a
No known key found for this signature in database
GPG Key ID: 8962AB9DE6666BBD
5 changed files with 10 additions and 8 deletions

View File

@ -319,7 +319,7 @@ Block.prototype.__defineGetter__('commitmentHash', function() {
/** /**
* Do non-contextual verification on the block. Including checking the block * Do non-contextual verification on the block. Including checking the block
* size, the coinbase and the merkle root. This is consensus-critical. * size, the coinbase and the merkle root. This is consensus-critical.
* @name verify * @alias verify
* @param {Object?} ret - Return object, may be * @param {Object?} ret - Return object, may be
* set with properties `reason` and `score`. * set with properties `reason` and `score`.
* @returns {Boolean} * @returns {Boolean}

View File

@ -67,7 +67,7 @@ utils.inherits(CompactBlock, bcoin.abstractblock);
/** /**
* Verify the block headers. * Verify the block headers.
* @name verify * @alias verify
* @param {Object?} ret - Return object, may be * @param {Object?} ret - Return object, may be
* set with properties `reason` and `score`. * set with properties `reason` and `score`.
* @returns {Boolean} * @returns {Boolean}

View File

@ -51,7 +51,7 @@ Headers.prototype.render = function render() {
/** /**
* Do non-contextual verification on the headers. * Do non-contextual verification on the headers.
* @name verify * @alias verify
* @param {Object?} ret - Return object, may be * @param {Object?} ret - Return object, may be
* set with properties `reason` and `score`. * set with properties `reason` and `score`.
* @returns {Boolean} * @returns {Boolean}

View File

@ -5,6 +5,10 @@
* https://github.com/indutny/bcoin * https://github.com/indutny/bcoin
*/ */
/**
* @module request
*/
var Stream = require('stream').Stream; var Stream = require('stream').Stream;
var assert = require('../utils').assert; 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'; + ' AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2227.1 Safari/537.36';
/** /**
* Request * Make an HTTP request.
* @exports request
* @function
* @param {Object} options * @param {Object} options
* @param {String} options.uri * @param {String} options.uri
* @param {Object?} options.query * @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). * @param {String?} options.expect - Type to expect (see options.type).
* Error will be returned if the response is not of this type. * Error will be returned if the response is not of this type.
* @param {Number?} options.limit - Byte limit on response. * @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) { function request(options, callback, stream) {

View File

@ -192,7 +192,7 @@ MerkleBlock.prototype._verifyPartial = function _verifyPartial() {
/** /**
* Do non-contextual verification on the block. * Do non-contextual verification on the block.
* Verify the headers and the partial merkle tree. * Verify the headers and the partial merkle tree.
* @name verify * @alias verify
* @param {Object?} ret - Return object, may be * @param {Object?} ret - Return object, may be
* set with properties `reason` and `score`. * set with properties `reason` and `score`.
* @returns {Boolean} * @returns {Boolean}