docs

lib/bcoin/block.js

@@ -354,7 +354,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.
- * @alias verify
+ * @alias Block#verify
  * @param {Object?} ret - Return object, may be
  * set with properties `reason` and `score`.
  * @returns {Boolean}

lib/bcoin/compactblock.js

@@ -72,7 +72,7 @@ CompactBlock.prototype.getSize = function getSize() {
 
 /**
  * Verify the block headers.
- * @alias verify
+ * @alias CompactBlock#verify
  * @param {Object?} ret - Return object, may be
  * set with properties `reason` and `score`.
  * @returns {Boolean}

lib/bcoin/headers.js

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

lib/bcoin/mempool.js

@@ -1898,6 +1898,7 @@ MempoolEntry.prototype.isFree = function isFree(height) {
  * "Guessed" pointer size based on ISA. This
  * assumes 64 bit for arm since the arm
  * version number is not exposed by node.js.
+ * @memberof Mempool
  * @const {Number}
  */
 
@@ -1913,6 +1914,7 @@ var ptrSize = (process.platform == null
  * replicate bitcoind's memory usage algorithm.
  * (I know javascript doesn't have malloc or
  * pointers).
+ * @memberof Mempool
  * @param {Number} alloc - Size of Buffer object.
  * @returns {Number} Allocated size.
  */

lib/bcoin/merkleblock.js

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

lib/bcoin/miner.js

@@ -653,6 +653,7 @@ MinerBlock.prototype.destroy = function destroy() {
 /**
  * "Reverse" comparison so we don't have
  * to waste time reversing the block hash.
+ * @memberof Miner
  * @param {Buffer} a
  * @param {Buffer} b
  * @returns {Number}

lib/bcoin/workers.js

@@ -582,6 +582,7 @@ Master.listen = function listen(id, options) {
 
 /**
  * Jobs to execute within the worker.
+ * @memberof Workers
  * @const {Object}
  */
 
@@ -873,6 +874,7 @@ Parser.parseItem = function parseItem(p) {
 
 /**
  * Helper to retrieve number of cores.
+ * @memberof Workers
  * @returns {Number}
  */