From 4172291a10a5186fe7fb690d28608f32ba56e0c1 Mon Sep 17 00:00:00 2001
From: Juan Cruz Viotti <jviotti@openmailbox.org>
Date: Wed, 1 Mar 2017 14:26:47 -0400
Subject: [PATCH] chore: improve JSDoc ESLint rules (#1147)

- Prefer `@returns` to `@return`
- Prefer `@param` to `@arg`
- Prefer capitalised types

See: https://github.com/resin-io/etcher/pull/1111#discussion_r103483879
Signed-off-by: Juan Cruz Viotti <jviotti@openmailbox.org>
---
 .eslintrc.yml                     | 11 +++++++++++
 lib/gui/models/selection-state.js |  2 +-
 2 files changed, 12 insertions(+), 1 deletion(-)

diff --git a/.eslintrc.yml b/.eslintrc.yml
index db8a6541..affaa103 100644
--- a/.eslintrc.yml
+++ b/.eslintrc.yml
@@ -71,6 +71,17 @@ rules:
     - error
     - requireReturn: false
       requireReturnDescription: false
+      requireReturnType: true
+      requireParamDescription: true
+      preferType:
+        boolean: "Boolean"
+        number: "Number"
+        object: "Object"
+        string: "String"
+        array: "Array"
+      prefer:
+        arg: "param"
+        return: "returns"
   valid-typeof:
     - error
 
diff --git a/lib/gui/models/selection-state.js b/lib/gui/models/selection-state.js
index 04061eaf..dd1adc01 100644
--- a/lib/gui/models/selection-state.js
+++ b/lib/gui/models/selection-state.js
@@ -105,7 +105,7 @@ SelectionStateModel.service('SelectionStateModel', function(DrivesModel) {
    * @function
    * @public
    *
-   * @returns {object}
+   * @returns {Object} image
    *
    * @example
    * const image = SelectionStateModel.getImage();