From 50d7d37034831e611f6be86233e8ba22dd2c3193 Mon Sep 17 00:00:00 2001
From: Braydon Fuller <braydon@bitpay.com>
Date: Mon, 16 Mar 2015 11:13:13 -0400
Subject: [PATCH] added jsdocs for bloomfilter and messages

---
 lib/bloomfilter.js      |  9 ++++++++-
 lib/inventory.js        |  1 +
 lib/messages/index.js   | 13 +++++++++++++
 lib/messages/message.js |  8 ++++++++
 4 files changed, 30 insertions(+), 1 deletion(-)

diff --git a/lib/bloomfilter.js b/lib/bloomfilter.js
index 10c7adc..ef1bd83 100644
--- a/lib/bloomfilter.js
+++ b/lib/bloomfilter.js
@@ -4,8 +4,12 @@ var bitcore = require('bitcore');
 var BloomFilter = require('bloom-filter');
 var BufferReader = bitcore.encoding.BufferReader;
 var BufferWriter = bitcore.encoding.BufferWriter;
-var $ = bitcore.util.preconditions;
 
+/**
+ * A constructor for Bloom Filters
+ * @see https://github.com/bitpay/bloom-filter
+ * @param {Buffer} - payload
+ */
 BloomFilter.fromBuffer = function fromBuffer(payload) {
   var obj = {};
   var parser = new BufferReader(payload);
@@ -20,6 +24,9 @@ BloomFilter.fromBuffer = function fromBuffer(payload) {
   return new BloomFilter(obj);
 };
 
+/**
+ * @returns {Buffer}
+ */
 BloomFilter.prototype.toBuffer = function toBuffer() {
   var bw = new BufferWriter();
   bw.writeVarintNum(this.vData.length);
diff --git a/lib/inventory.js b/lib/inventory.js
index 5d4b134..da26983 100644
--- a/lib/inventory.js
+++ b/lib/inventory.js
@@ -13,6 +13,7 @@ var _ = bitcore.deps._;
  * @param {Object} - obj
  * @param {Number} - obj.type - Inventory.TYPE
  * @param {Buffer} - obj.hash - The hash for the inventory
+ * @constructor
  */
 function Inventory(obj) {
   this.type = obj.type;
diff --git a/lib/messages/index.js b/lib/messages/index.js
index 7e5ec7a..54bba09 100644
--- a/lib/messages/index.js
+++ b/lib/messages/index.js
@@ -4,6 +4,16 @@ var bitcore = require('bitcore');
 var BufferUtil = bitcore.util.buffer;
 var Hash = bitcore.crypto.Hash;
 
+/**
+ * A factory to build Bitcoin protocol messages.
+ * @param {Object} - [options]
+ * @param {Number} - [options.magicNumber]
+ * @param {Function} - [options.Block] - A block constructor
+ * @param {Function} - [options.BlockHeader] - A block header constructor
+ * @param {Function} - [options.MerkleBlock] - A merkle block constructor
+ * @param {Function} - [options.Transaction] - A transaction constructor
+ * @constructor
+ */
 function Messages(options) {
   this.builder = Messages.builder(options);
 
@@ -25,6 +35,9 @@ Messages.PAYLOAD_START = 16;
 Messages.Message = require('./message');
 Messages.builder = require('./builder');
 
+/**
+ * @param {Buffers} dataBuffer
+ */
 Messages.prototype.parseBuffer = function(dataBuffer) {
   /* jshint maxstatements: 18 */
   if (dataBuffer.length < Messages.MINIMUM_LENGTH) {
diff --git a/lib/messages/message.js b/lib/messages/message.js
index f1a938a..60fa2fb 100644
--- a/lib/messages/message.js
+++ b/lib/messages/message.js
@@ -7,6 +7,10 @@ var Hash = bitcore.crypto.Hash;
 /**
  * Base message that can be inherited to add an additional
  * `getPayload` method to modify the message payload.
+ * @param {Object} - options
+ * @param {String} - options.command
+ * @param {Number} - options.magicNumber
+ * @constructor
  */
 function Message(options) {
   if(!options) {
@@ -16,6 +20,10 @@ function Message(options) {
   this.magicNumber = options.magicNumber;
 }
 
+/**
+ * @returns {Buffer} - Serialized message
+ * @constructor
+ */
 Message.prototype.toBuffer = Message.prototype.serialize = function() {
 
   var commandBuf = new Buffer(Array(12));