Add documentation.

jaredhanson · Apr 1, 2014 · 13d3826 · 13d3826
1 parent c4812c8
commit 13d3826
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/lib/crane-amqp/broker.js b/lib/crane-amqp/broker.js
@@ -303,6 +303,21 @@ Broker.prototype.unsubscribe = function(queue, options, cb) {
     });
 }
 
+/**
+ * Declare a queue.
+ *
+ * Examples:
+ *
+ *     broker.declare('tasks/mail', function(err, queue) {
+ *       if (err) { throw err; }
+ *       ...
+ *     });
+ *
+ * @param {String} queue
+ * @param {Object} options
+ * @param {Function} cb
+ * @api public
+ */
 Broker.prototype.declare = function(queue, options, cb) {
   if (typeof options == 'function') {
     cb = options;

diff --git a/lib/crane-amqp/queue.js b/lib/crane-amqp/queue.js
@@ -5,7 +5,7 @@ var debug = require('debug')('crane-amqp');
 
 
 /**
- * `Broker` constructor.
+ * `Queue` constructor.
  *
  * @api protected
  */
@@ -17,6 +17,13 @@ function Queue(queue, exchange) {
 /**
  * Bind queue to topic.
  *
+ * Examples:
+ *
+ *     queue.bind('notifications/email/*', function(err) {
+ *       if (err) { throw err; }
+ *       ...
+ *     });
+ *
  * @api public
  */
 Queue.prototype.bind = function(topic, cb) {
@@ -48,6 +55,6 @@ Queue.prototype.bind = function(topic, cb) {
 
 
 /**
- * Expose `Broker`.
+ * Expose `Queue`.
  */
 module.exports = Queue;