🎨 Update JSDoc

index.js

@@ -35,7 +35,7 @@ sassLint.getConfig = function (config, configPath) {
  * Parses our results object to count errors and return
  * paths to files with detected errors.
  *
- * @param {object} results our results object
+ * @param {Array} results our results Array
  * @returns {object} errors object containing the error count and paths for files incl. errors
  */
 sassLint.errorCount = function (results) {
@@ -58,7 +58,7 @@ sassLint.errorCount = function (results) {
  * Parses our results object to count warnings and return
  * paths to files with detected warnings.
  *
- * @param {object} results our results object
+ * @param {Array} results our results array
  * @returns {object} warnings object containing the error count and paths for files incl. warnings
  */
 sassLint.warningCount = function (results) {
@@ -81,7 +81,7 @@ sassLint.warningCount = function (results) {
  * Parses our results object to count warnings and errors and return
  * a cumulative count of both
  *
- * @param {object} results our results object
+ * @param {Array} results our results array
  * @returns {int} the cumulative count of errors and warnings detected
  */
 sassLint.resultCount = function (results) {
@@ -188,7 +188,7 @@ sassLint.lintFileText = function (file, options, configPath) {
  * @param {string} files a glob pattern or single file path as a lint target
  * @param {object} options user specified rules/options passed in
  * @param {string} configPath path to a config file
- * @returns {object} results object containing all results
+ * @returns {Array} results object containing all results
  */
 sassLint.lintFiles = function (files, options, configPath) {
   var that = this,
@@ -245,10 +245,10 @@ sassLint.lintFiles = function (files, options, configPath) {
 /**
  * Handles formatting of results using EsLint formatters
  *
- * @param {object} results our results object
+ * @param {Array} results our results array
  * @param {object} options user specified rules/options passed in
  * @param {string} configPath path to a config file
- * @returns {object} results our results object in the user specified format
+ * @returns {string} results our results object in the user specified format
  */
 sassLint.format = function (results, options, configPath) {
   var config = this.getConfig(options, configPath),
@@ -263,10 +263,10 @@ sassLint.format = function (results, options, configPath) {
  * Handles outputting results whether this be straight to the console/stdout or to a file.
  * Passes results to the format function to ensure results are output in the chosen format
  *
- * @param {object} results our results object
+ * @param {Array} results our results array
  * @param {object} options user specified rules/options passed in
  * @param {string} configPath path to a config file
- * @returns {object} results our results object
+ * @returns {string} the formatted results string
  */
 sassLint.outputResults = function (results, options, configPath) {
   var config = this.getConfig(options, configPath);
@@ -295,7 +295,7 @@ sassLint.outputResults = function (results, options, configPath) {
  * Throws an error if there are any errors detected. The error includes a count of all errors
  * and a list of all files that include errors.
  *
- * @param {object} results - our results object
+ * @param {Array} results - our results array
  * @param {object} [options] - extra options to use when running failOnError, e.g. max-warnings
  * @param {string} [configPath] - path to the config file
  * @returns {void}