Work on JSDoc comments
This commit is contained in:
parent
bcd4159724
commit
dc3011c800
|
@ -3,11 +3,12 @@ var StringDecoder = require('string_decoder').StringDecoder;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handle multipart/form-data upload to the storage service
|
* Handle multipart/form-data upload to the storage service
|
||||||
* @param provider The storage service provider
|
* @param {Object} provider The storage service provider
|
||||||
* @param {Request} req The HTTP request
|
* @param {Request} req The HTTP request
|
||||||
* @param {Response} res The HTTP response
|
* @param {Response} res The HTTP response
|
||||||
* @param {String} container The container name
|
* @param {String} container The container name
|
||||||
* @param {Function} cb The callback
|
* @callback {Function} cb Callback function
|
||||||
|
* @header storageService.upload(provider, req, res, container, cb)
|
||||||
*/
|
*/
|
||||||
exports.upload = function (provider, req, res, container, cb) {
|
exports.upload = function (provider, req, res, container, cb) {
|
||||||
var form = new IncomingForm(this.options);
|
var form = new IncomingForm(this.options);
|
||||||
|
@ -103,13 +104,14 @@ exports.upload = function (provider, req, res, container, cb) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Handle download from a container/file
|
* Handle download from a container/file.
|
||||||
* @param provider The storage service provider
|
* @param {Object} provider The storage service provider
|
||||||
* @param {Request} req The HTTP request
|
* @param {Request} req The HTTP request
|
||||||
* @param {Response} res The HTTP response
|
* @param {Response} res The HTTP response
|
||||||
* @param {String} container The container name
|
* @param {String} container The container name
|
||||||
* @param {String} file The file name
|
* @param {String} file The file name
|
||||||
* @param {Function} cb The callback
|
* @callback {Function} cb Callback function.
|
||||||
|
* @header storageService.download(provider, req, res, container, file, cb)
|
||||||
*/
|
*/
|
||||||
exports.download = function (provider, req, res, container, file, cb) {
|
exports.download = function (provider, req, res, container, file, cb) {
|
||||||
var reader = provider.download({
|
var reader = provider.download({
|
||||||
|
|
Loading…
Reference in New Issue