fixed all api docs to correctly include the return Promise

Author: christkv

lib/admin.js

@@ -58,7 +58,7 @@ var Admin = function(db, topology, promiseLibrary) {
  * @param {(ReadPreference|string)} [options.readPreference=null] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
  * @param {number} [options.maxTimeMS=null] Number of milliseconds to wait before aborting the query.
  * @param {Admin~resultCallback} callback The command result callback
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.command = function(command, options, callback) {
   var self = this;
@@ -87,7 +87,7 @@ Admin.prototype.command = function(command, options, callback) {
  * instance of the db client
  *
  * @param {Admin~resultCallback} callback The command result callback
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.buildInfo = function(callback) {
   var self = this;
@@ -108,7 +108,7 @@ Admin.prototype.buildInfo = function(callback) {
  * instance of the db client
  *
  * @param {Admin~resultCallback} callback The command result callback
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.serverInfo = function(callback) {
   var self = this;
@@ -131,7 +131,7 @@ Admin.prototype.serverInfo = function(callback) {
  * Retrieve this db's server status.
  *
  * @param {Admin~resultCallback} callback The command result callback
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.serverStatus = function(callback) {
   var self = this;
@@ -163,7 +163,7 @@ var serverStatus = function(self, callback) {
  * Retrieve the current profiling Level for MongoDB
  *
  * @param {Admin~resultCallback} callback The command result callback
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.profilingLevel = function(callback) {
   var self = this;
@@ -200,7 +200,7 @@ var profilingLevel = function(self, callback) {
  * Ping the MongoDB server and retrieve results
  *
  * @param {Admin~resultCallback} callback The command result callback
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.ping = function(options, callback) {
   var self = this;
@@ -226,7 +226,7 @@ Admin.prototype.ping = function(options, callback) {
  * @param {string} username The username.
  * @param {string} [password] The password.
  * @param {Admin~resultCallback} callback The command result callback
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.authenticate = function(username, password, callback) {
   var self = this;
@@ -246,7 +246,7 @@ Admin.prototype.authenticate = function(username, password, callback) {
  * Logout user from server, fire off on all connections and remove all auth info
  * @method
  * @param {Admin~resultCallback} callback The command result callback
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.logout = function(callback) {
   var self = this;
@@ -275,7 +275,7 @@ Admin.prototype.logout = function(callback) {
  * @param {object} [options.customData=null] Custom data associated with the user (only Mongodb 2.6 or higher)
  * @param {object[]} [options.roles=null] Roles associated with the created user (only Mongodb 2.6 or higher)
  * @param {Admin~resultCallback} callback The command result callback
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.addUser = function(username, password, options, callback) {
   var self = this;
@@ -309,7 +309,7 @@ Admin.prototype.addUser = function(username, password, options, callback) {
  * @param {boolean} [options.j=false] Specify a journal write concern.
  * @param {boolean} [options.fsync=false] Specify a file sync write concern.
  * @param {Admin~resultCallback} callback The command result callback
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.removeUser = function(username, options, callback) {
   var self = this;
@@ -337,7 +337,7 @@ Admin.prototype.removeUser = function(username, options, callback) {
  *
  * @param {string} level The new profiling level (off, slow_only, all).
  * @param {Admin~resultCallback} callback The command result callback.
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.setProfilingLevel = function(level, callback) {
   var self = this;
@@ -384,7 +384,7 @@ var setProfilingLevel = function(self, level, callback) {
  * Retrive the current profiling information for MongoDB
  *
  * @param {Admin~resultCallback} callback The command result callback.
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.profilingInfo = function(callback) {
   var self = this;
@@ -415,7 +415,7 @@ var profilingInfo = function(self, callback) {
  * @param {string} collectionName The name of the collection to validate.
  * @param {object} [options=null] Optional settings.
  * @param {Admin~resultCallback} callback The command result callback.
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.validateCollection = function(collectionName, options, callback) {
   var self = this;
@@ -468,7 +468,7 @@ var validateCollection = function(self, collectionName, options, callback) {
  * List the available databases
  *
  * @param {Admin~resultCallback} callback The command result callback.
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.listDatabases = function(callback) {
   var self = this;
@@ -488,7 +488,7 @@ Admin.prototype.listDatabases = function(callback) {
  * Get ReplicaSet status
  *
  * @param {Admin~resultCallback} callback The command result callback.
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.replSetGetStatus = function(callback) {
   var self = this;

lib/aggregation_cursor.js

@@ -292,7 +292,7 @@ AggregationCursor.prototype.get = AggregationCursor.prototype.toArray;
  * @function AggregationCursor.prototype.next
  * @param {AggregationCursor~resultCallback} callback The result callback.
  * @throws {MongoError}
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 
 /**
@@ -324,7 +324,7 @@ AggregationCursor.prototype.get = AggregationCursor.prototype.toArray;
  * @method AggregationCursor.prototype.toArray
  * @param {AggregationCursor~toArrayResultCallback} callback The result callback.
  * @throws {MongoError}
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 
 /**
@@ -351,7 +351,7 @@ AggregationCursor.prototype.get = AggregationCursor.prototype.toArray;
  * Close the cursor, sending a AggregationCursor command and emitting close.
  * @method AggregationCursor.prototype.close
  * @param {AggregationCursor~resultCallback} [callback] The result callback.
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */   
 
 /**
@@ -364,7 +364,7 @@ AggregationCursor.prototype.get = AggregationCursor.prototype.toArray;
  * Execute the explain for the cursor
  * @method AggregationCursor.prototype.explain
  * @param {AggregationCursor~resultCallback} [callback] The result callback.
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 
 /**

lib/bulk/ordered.js

@@ -448,7 +448,7 @@ var executeCommands = function(self, callback) {
  * @param {boolean} [options.fsync=false] Specify a file sync write concern.
  * @param {OrderedBulkOperation~resultCallback} callback The result callback
  * @throws {MongoError}
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 OrderedBulkOperation.prototype.execute = function(_writeConcern, callback) {
   var self = this;

lib/bulk/unordered.js

@@ -456,7 +456,7 @@ var executeBatches = function(self, callback) {
  * @param {boolean} [options.fsync=false] Specify a file sync write concern.
  * @param {UnorderedBulkOperation~resultCallback} callback The result callback
  * @throws {MongoError}
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 UnorderedBulkOperation.prototype.execute = function(_writeConcern, callback) {
   var self = this;

lib/command_cursor.js

@@ -186,7 +186,7 @@ CommandCursor.prototype.get = CommandCursor.prototype.toArray;
  * @function CommandCursor.prototype.next
  * @param {CommandCursor~resultCallback} callback The result callback.
  * @throws {MongoError}
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 
 /**
@@ -217,7 +217,7 @@ CommandCursor.prototype.get = CommandCursor.prototype.toArray;
  * @method CommandCursor.prototype.toArray
  * @param {CommandCursor~toArrayResultCallback} callback The result callback.
  * @throws {MongoError}
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 
 /**
@@ -244,7 +244,7 @@ CommandCursor.prototype.get = CommandCursor.prototype.toArray;
  * Close the cursor, sending a KillCursor command and emitting close.
  * @method CommandCursor.prototype.close
  * @param {CommandCursor~resultCallback} [callback] The result callback.
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */   
 
 /**

lib/cursor.js

@@ -368,7 +368,7 @@ Cursor.prototype.skip = function(value) {
  * @function external:CoreCursor#next
  * @param {Cursor~resultCallback} callback The result callback.
  * @throws {MongoError}
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 
 /**

lib/db.js

@@ -1121,7 +1121,7 @@ var addUser = function(self, username, password, options, callback) {
  * @param {object} [options.customData=null] Custom data associated with the user (only Mongodb 2.6 or higher)
  * @param {object[]} [options.roles=null] Roles associated with the created user (only Mongodb 2.6 or higher)
  * @param {Db~resultCallback} callback The command result callback
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Db.prototype.addUser = function(username, password, options, callback) {
   // Unpack the parameters
@@ -1210,7 +1210,7 @@ var removeUser = function(self, username, options, callback) {
  * @param {number} [options.wtimeout=null] The write concern timeout.
  * @param {boolean} [options.j=false] Specify a journal write concern.
  * @param {Db~resultCallback} callback The command result callback
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Db.prototype.removeUser = function(username, options, callback) {
   // Unpack the parameters
@@ -1304,7 +1304,7 @@ var authenticate = function(self, username, password, options, callback) {
  * @param {object} [options=null] Optional settings.
  * @param {string} [options.authMechanism=MONGODB-CR] The authentication mechanism to use, GSSAPI, MONGODB-CR, MONGODB-X509, PLAIN
  * @param {Db~resultCallback} callback The command result callback
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Db.prototype.authenticate = function(username, password, options, callback) {
   if(typeof options == 'function') callback = options, options = {};
@@ -1341,7 +1341,7 @@ Db.prototype.authenticate = function(username, password, options, callback) {
  * @param {object} [options=null] Optional settings.
  * @param {string} [options.dbName=null] Logout against different database than current.
  * @param {Db~resultCallback} callback The command result callback
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Db.prototype.logout = function(options, callback) {
   var self = this;
@@ -1389,7 +1389,7 @@ var getReadPreference = function(options, db) {
  * @param {boolean} [options.full=false] Returns the full raw index information.
  * @param {(ReadPreference|string)} [options.readPreference=null] The preferred read preference (ReadPreference.PRIMARY, ReadPreference.PRIMARY_PREFERRED, ReadPreference.SECONDARY, ReadPreference.SECONDARY_PREFERRED, ReadPreference.NEAREST).
  * @param {Db~resultCallback} callback The command result callback
- * @return {null}
+ * @return {Promise} returns Promise if no callback passed
  */
 Db.prototype.indexInformation = function(name, options, callback) {
   var self = this;