JSDoc for SAML #520

Author: ehennum

lib/marklogic.js

@@ -239,7 +239,7 @@ function expandExtlibsWrapper(action, args) {
  * @param {string} user - the user with permission to access the database
  * @param {string} password - the password for the user with permission to access
  * the database
- * @param {enum} [authType=digest] - the authentication type of digest|basic|certificate|kerberos
+ * @param {enum} [authType=digest] - the authentication type of digest|basic|certificate|kerberos|saml
  * @param {boolean} [ssl=false] - whether the REST server uses SSL; when true,
  * the connection parameters can include the
  * {@link http://nodejs.org/api/https.html#https_https_request_options_callback|supplemental
@@ -252,6 +252,7 @@ function expandExtlibsWrapper(action, args) {
  * @param {Buffer} [pfx] - the public x509 certificate and private key as a single PKCS12 file
  * to use for SSL
  * @param {string} [passphrase] - the passphrase for the PKCS12 file
+ * @param {string} [token] - the SAML token to use for authentication with the REST server
  * @returns {DatabaseClient} a client for accessing the database
  * as the user
  */
@@ -628,17 +629,13 @@ MarkLogicClient.prototype.createTimestamp = function databaseCreateTimestamp(val
 };
 
 /**
- * Supplies a logger to use for database interactions or, instead, takes
- * a logging level from the debug|info|warn|error|silent enumeration (where silent
- * is the initial setting) for the default console logger.
- * @method DatabaseClient#setLogger
- * @since 1.0
- * @param {object}  logger - an object providing debug(), info(), warn(), and error()
- * logging methods such as a logger provided by the
- * {@link https://github.com/trentm/node-bunyan|Bunyan} or
- * {@link https://github.com/flatiron/winston|Winston} logging libraries.
- * @param {boolean}  [isErrorFirst] - whether an error should be logged as the first parameter;
- * must be provided as true for Bunyan (but not for Winston); defaults to false
+ * Supplies a new authentication token to be used in subsequent requests
+ * instead of the current authentication token.
+ *
+ * Note: the token must be a SAML authentication token.
+ * @method DatabaseClient#setAuthToken
+ * @param {string}  token - an authentication token
+ * @since 2.2.0
  */
 MarkLogicClient.prototype.setAuthToken = function setAuthToken() {
   const argLen = arguments.length;