From a58ed7711fbe7f30e3147f31da081d289b507e54 Mon Sep 17 00:00:00 2001 From: crandmck Date: Mon, 7 Apr 2014 16:32:12 -0700 Subject: [PATCH] Add param info to constructor JSDoc --- lib/storage-service.js | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/lib/storage-service.js b/lib/storage-service.js index 24c30c4..62221c8 100644 --- a/lib/storage-service.js +++ b/lib/storage-service.js @@ -11,8 +11,16 @@ module.exports = StorageService; * * @options {Object} options The options to create a provider; see below. * @prop {Object} connector - * @prop {String} provider Use 'filesystem' for local file system. Other supported values are: 'amazon', 'rackspace', 'azure', and 'openstack'. - * @prop {String} root With 'filesystem' provider, the path to the root of storage directory. + * @prop {String} provider Storage service provider. Must be one of: + * + * + * Other supported values depend on the provider. + * See the [documentation](http://docs.strongloop.com/display/DOC/Storage+service) for more information. * @class */ function StorageService(options) { @@ -76,7 +84,8 @@ StorageService.prototype.getContainers = function (cb) { *
  • 'openstack'
  • * * - * Other supported values depend on the provider. See the [documentation](http://docs.strongloop.com/display/DOC/Storage+service) for more information. + * Other supported values depend on the provider. + * See the [documentation](http://docs.strongloop.com/display/DOC/Storage+service) for more information. * @callback {Function} callback Callback function. */