make comments conform to jsdoc 3 fixes #201

motdotla · Jun 20, 2017 · 88ea524 · 88ea524
1 parent 89a02b6
commit 88ea524
Showing 1 changed file with 6 additions and 4 deletions.
diff --git 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'