From 88ea524516b92e82d24615e3cefdf47176ce68d5 Mon Sep 17 00:00:00 2001 From: Max Beatty Date: Tue, 20 Jun 2017 11:37:09 -0700 Subject: [PATCH] make comments conform to jsdoc 3 fixes #201 --- lib/main.js | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/lib/main.js b/lib/main.js index 5da0ea71..1b7c5b0f 100644 --- a/lib/main.js +++ b/lib/main.js @@ -4,8 +4,8 @@ var fs = require('fs') /* * Parses a string or buffer into an object - * @param {String|Buffer} src - source to be parsed - * @returns {Object} + * @param {(string|Buffer)} src - source to be parsed + * @returns {Object} keys and values from src */ function parse (src) { var obj = {} @@ -39,8 +39,10 @@ function parse (src) { /* * Main entry point into dotenv. Allows configuration before loading .env - * @param {Object} options - valid options: path ('.env'), encoding ('utf8') - * @returns {Boolean} + * @param {Object} options - options for parsing .env file + * @param {string} [options.path=.env] - path to .env file + * @param {string} [options.encoding=utf8] - encoding of .env file + * @returns {Object} parsed object or error */ function config (options) { var path = '.env'