fix jsdocs for message commands

This commit is contained in:
Braydon Fuller 2015-03-16 12:59:29 -04:00
parent f1aa4d3bc0
commit 39d1ae9ac8
3 changed files with 17 additions and 4 deletions

View File

@ -13,7 +13,8 @@ var magicNumber = bitcore.Networks.defaultNetwork.networkMagic.readUInt32LE(0);
/**
* Request peer to add data to a bloom filter already set by 'filterload'
* @param {Buffer} data - Array of bytes representing bloom filter data
* @param {Object} options
* @param {Buffer} options.data - Array of bytes representing bloom filter data
* @extends Message
* @constructor
*/

View File

@ -40,14 +40,26 @@ function GetdataMessage(options) {
}
inherits(GetdataMessage, Message);
/**
* @param {Buffer|String} hash - The hash of the transaction inventory item
* @returns {GetdataMessage}
*/
GetdataMessage.forTransaction = function(hash) {
return new GetdataMessage([Inventory.forTransaction(hash)]);
};
/**
* @param {Buffer|String} hash - The hash of the block inventory item
* @returns {GetdataMessage}
*/
GetdataMessage.forBlock = function(hash) {
return new GetdataMessage([Inventory.forBlock(hash)]);
};
/**
* @param {Buffer|String} hash - The hash of the filtered block inventory item
* @returns {GetdataMessage}
*/
GetdataMessage.forFilteredBlock = function(hash) {
return new GetdataMessage([Inventory.forFilteredBlock(hash)]);
};

View File

@ -41,7 +41,7 @@ inherits(NotfoundMessage, Message);
/**
* @param {Buffer|String} hash - The hash of the transaction inventory item
* @returns {InvMessage}
* @returns {NotfoundMessage}
*/
NotfoundMessage.forTransaction = function(hash) {
return new NotfoundMessage([Inventory.forTransaction(hash)]);
@ -49,7 +49,7 @@ NotfoundMessage.forTransaction = function(hash) {
/**
* @param {Buffer|String} hash - The hash of the block inventory item
* @returns {InvMessage}
* @returns {NotfoundMessage}
*/
NotfoundMessage.forBlock = function(hash) {
return new NotfoundMessage([Inventory.forBlock(hash)]);
@ -57,7 +57,7 @@ NotfoundMessage.forBlock = function(hash) {
/**
* @param {Buffer|String} hash - The hash of the filtered block inventory item
* @returns {InvMessage}
* @returns {NotfoundMessage}
*/
NotfoundMessage.forFilteredBlock = function(hash) {
return new NotfoundMessage([Inventory.forFilteredBlock(hash)]);