diff --git a/lib/logWriter.js b/lib/logWriter.js index fe261fa..f05d239 100644 --- a/lib/logWriter.js +++ b/lib/logWriter.js @@ -67,12 +67,6 @@ * Save console logs on disk * * @constructor - * - * @param {Console2} cons A Console2 instance - * @param {Object} opt Logger's options - * @param {String} opt.rootPath Logs folder. Default 'logs'. - * @param {Boolean} opt.start Whether to start to log right now or not. Default true. - * Use false when you want to custom getPath, getFilename, etc. */ var LogWriter = function () {}; @@ -80,7 +74,8 @@ * LogWriter.prototype.getPath * * @param {Object} opt params - * @param {Object} opt.logger The logger + * @param {String} opt.rootPath root logs folder + * @param {String} opt.logger logger options * * @return {String} The path to current folder (without rootPath) */ @@ -98,7 +93,8 @@ * LogWriter.prototype.getFile * * @param {Object} opt params - * @param {Object} opt.logger The logger + * @param {String} opt.rootPath root logs folder + * @param {String} opt.logger logger options * * @return {String} the filname (with extension) */ @@ -116,7 +112,8 @@ * LogWriter.prototype.path * * @param {Object} opt params - * @param {Object} opt.logger The logger + * @param {String} opt.rootPath root logs folder + * @param {String} opt.logger logger options * * @return {String} the full path to file */ @@ -134,8 +131,10 @@ * Save a log on disk * * @param {Object} log The log to save - * @param {Object} opti Options + * + * @param {Object} opt Options * @param {String} opt.rootPath root logs folder + * @param {String} opt.logger logger options */ LogWriter.prototype.save = function (log, opt) { @@ -173,5 +172,4 @@ module.exports = LogWriter; - }());