updated jsDOC comments where callbacks are optional

Author: VaclavObornik

lib/admin.js

@@ -58,7 +58,7 @@ var Admin = function(db, topology, promiseLibrary) {
  * @param {object} [options=null] Optional settings.
  * @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
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.command = function(command, options, callback) {
@@ -87,7 +87,7 @@ Admin.prototype.command = function(command, options, callback) {
  * Retrieve the server information for the current
  * instance of the db client
  *
- * @param {Admin~resultCallback} callback The command result callback
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.buildInfo = function(callback) {
@@ -108,7 +108,7 @@ Admin.prototype.buildInfo = function(callback) {
  * Retrieve the server information for the current
  * instance of the db client
  *
- * @param {Admin~resultCallback} callback The command result callback
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.serverInfo = function(callback) {
@@ -131,7 +131,7 @@ Admin.prototype.serverInfo = function(callback) {
 /**
  * Retrieve this db's server status.
  *
- * @param {Admin~resultCallback} callback The command result callback
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.serverStatus = function(callback) {
@@ -163,7 +163,7 @@ var serverStatus = function(self, callback) {
 /**
  * Retrieve the current profiling Level for MongoDB
  *
- * @param {Admin~resultCallback} callback The command result callback
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.profilingLevel = function(callback) {
@@ -200,7 +200,7 @@ var profilingLevel = function(self, callback) {
 /**
  * Ping the MongoDB server and retrieve results
  *
- * @param {Admin~resultCallback} callback The command result callback
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.ping = function(options, callback) {
@@ -226,7 +226,7 @@ Admin.prototype.ping = function(options, callback) {
  * @method
  * @param {string} username The username.
  * @param {string} [password] The password.
- * @param {Admin~resultCallback} callback The command result callback
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.authenticate = function(username, password, callback) {
@@ -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
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.logout = function(callback) {
@@ -296,7 +296,7 @@ var writeConcern = function(options, db) {
  * @param {boolean} [options.fsync=false] Specify a file sync write concern.
  * @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
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.addUser = function(username, password, options, callback) {
@@ -333,7 +333,7 @@ Admin.prototype.addUser = function(username, password, options, callback) {
  * @param {number} [options.wtimeout=null] The write concern timeout.
  * @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
+ * @param {Admin~resultCallback} [callback] The command result callback
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.removeUser = function(username, options, callback) {
@@ -365,7 +365,7 @@ Admin.prototype.removeUser = function(username, options, callback) {
  * Set the current profiling level of MongoDB
  *
  * @param {string} level The new profiling level (off, slow_only, all).
- * @param {Admin~resultCallback} callback The command result callback.
+ * @param {Admin~resultCallback} [callback] The command result callback.
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.setProfilingLevel = function(level, callback) {
@@ -412,7 +412,7 @@ var setProfilingLevel = function(self, level, callback) {
 /**
  * Retrive the current profiling information for MongoDB
  *
- * @param {Admin~resultCallback} callback The command result callback.
+ * @param {Admin~resultCallback} [callback] The command result callback.
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.profilingInfo = function(callback) {
@@ -443,7 +443,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.
+ * @param {Admin~resultCallback} [callback] The command result callback.
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.validateCollection = function(collectionName, options, callback) {
@@ -497,7 +497,7 @@ var validateCollection = function(self, collectionName, options, callback) {
 /**
  * List the available databases
  *
- * @param {Admin~resultCallback} callback The command result callback.
+ * @param {Admin~resultCallback} [callback] The command result callback.
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.listDatabases = function(callback) {
@@ -517,7 +517,7 @@ Admin.prototype.listDatabases = function(callback) {
 /**
  * Get ReplicaSet status
  *
- * @param {Admin~resultCallback} callback The command result callback.
+ * @param {Admin~resultCallback} [callback] The command result callback.
  * @return {Promise} returns Promise if no callback passed
  */
 Admin.prototype.replSetGetStatus = function(callback) {

lib/aggregation_cursor.js

@@ -287,7 +287,7 @@ AggregationCursor.prototype.get = AggregationCursor.prototype.toArray;
 /**
  * Get the next available document from the cursor, returns null if no more documents are available.
  * @function AggregationCursor.prototype.next
- * @param {AggregationCursor~resultCallback} callback The result callback.
+ * @param {AggregationCursor~resultCallback} [callback] The result callback.
  * @throws {MongoError}
  * @return {Promise} returns Promise if no callback passed
  */
@@ -319,7 +319,7 @@ AggregationCursor.prototype.get = AggregationCursor.prototype.toArray;
  * results when this cursor had been previouly accessed. In that case,
  * cursor.rewind() can be used to reset the cursor.
  * @method AggregationCursor.prototype.toArray
- * @param {AggregationCursor~toArrayResultCallback} callback The result callback.
+ * @param {AggregationCursor~toArrayResultCallback} [callback] The result callback.
  * @throws {MongoError}
  * @return {Promise} returns Promise if no callback passed
  */

lib/bulk/ordered.js

@@ -446,7 +446,7 @@ var executeCommands = function(self, callback) {
  * @param {number} [options.wtimeout=null] The write concern timeout.
  * @param {boolean} [options.j=false] Specify a journal write concern.
  * @param {boolean} [options.fsync=false] Specify a file sync write concern.
- * @param {OrderedBulkOperation~resultCallback} callback The result callback
+ * @param {OrderedBulkOperation~resultCallback} [callback] The result callback
  * @throws {MongoError}
  * @return {Promise} returns Promise if no callback passed
  */

lib/bulk/unordered.js

@@ -454,7 +454,7 @@ var executeBatches = function(self, callback) {
  * @param {number} [options.wtimeout=null] The write concern timeout.
  * @param {boolean} [options.j=false] Specify a journal write concern.
  * @param {boolean} [options.fsync=false] Specify a file sync write concern.
- * @param {UnorderedBulkOperation~resultCallback} callback The result callback
+ * @param {UnorderedBulkOperation~resultCallback} [callback] The result callback
  * @throws {MongoError}
  * @return {Promise} returns Promise if no callback passed
  */