Minor JSDoc updates.

This commit is contained in:
Roel van Uden 2015-01-25 11:45:12 +01:00
parent f443152bd2
commit e1bade5992
6 changed files with 11 additions and 3 deletions

View File

@ -1,5 +1,4 @@
#!/usr/bin/env node
var path = require('path');
var fs = require('fs');
var lib = path.join(path.dirname(fs.realpathSync(__filename)), '..');
require(lib);
require(path.join(path.dirname(fs.realpathSync(__filename)), '..'));

View File

@ -28,6 +28,7 @@ module.exports = function(args, done) {
/**
* Splits the value into arguments.
* @private
* @param {string} value
* @returns {Array.<string>}
*/

View File

@ -26,6 +26,7 @@ module.exports = function (config, address, done) {
/**
* Completes a download and writes the message with an elapsed time.
* @private
* @param {string} message
* @param {number} begin
* @param {function(Error)} done
@ -72,6 +73,7 @@ function _download(config, page, player, done) {
/**
* Names the file based on the config, page, series and tag.
* @private
* @param {Object} config
* @param {Object} page
* @param {string} series

View File

@ -17,6 +17,7 @@ module.exports.get = function(config, options, done) {
/**
* Performs a POST request for the resource.
* @private
* @param {Object} config
* @param {(string|Object)} options
* @param {function(Error, Object, string)} done
@ -30,6 +31,7 @@ module.exports.post = function(config, options, done) {
/**
* Authenticates using the configured pass and user.
* @private
* @param {Object} config
* @param {function(Error)} done
*/
@ -53,6 +55,7 @@ function _authenticate(config, done) {
/**
* Modifies the options to use the authenticated cookie jar.
* @private
* @param {(string|Object)} options
* @returns {Object}
*/

View File

@ -38,6 +38,7 @@ module.exports = function(config, address, done) {
/**
* Downloads the episode.
* @private
* @param {Object.<string, string>} cache
* @param {Object} config
* @param {string} baseAddress

View File

@ -41,7 +41,8 @@ function _command() {
}
/**
* Unlinks the video and subtitle
* Unlinks the video and subtitle.
* @private
* @param {string} videoPath
* @param {string} subtitlePath
* @param {function(Error)} done
@ -55,6 +56,7 @@ function _unlink(videoPath, subtitlePath, done) {
/**
* Attempts to unlink the video and subtitle with a timeout between each try.
* @private
* @param {string} videoPath
* @param {string} subtitlePath
* @param {function(Error)} done