From d37468975c1948f3fb3d9b307c7421911383dbf8 Mon Sep 17 00:00:00 2001
From: Lyubo Marinov <lmarinov@atlassian.com>
Date: Tue, 4 Apr 2017 13:35:44 -0500
Subject: [PATCH] Fix ESLint warnings

JSDoc comments didn't follow the ESLint rule for properly formatted
sentences.

BTW, I'm not blind to the fact that PasswordRequiredPrompt and
RoomLockPrompt participated in a birthing of source code through
copy+paste. (If we do not copy+paste, we will not have to fix one and
the same source code such as comments  multiple times.)
---
 .../components/PasswordRequiredPrompt.native.js      |  5 ++---
 .../room-lock/components/RoomLockPrompt.native.js    | 12 +++++-------
 2 files changed, 7 insertions(+), 10 deletions(-)

diff --git a/react/features/room-lock/components/PasswordRequiredPrompt.native.js b/react/features/room-lock/components/PasswordRequiredPrompt.native.js
index f5efce88f..e16138d51 100644
--- a/react/features/room-lock/components/PasswordRequiredPrompt.native.js
+++ b/react/features/room-lock/components/PasswordRequiredPrompt.native.js
@@ -45,7 +45,6 @@ class PasswordRequiredPrompt extends Component {
      * @returns {ReactElement}
      */
     render() {
-
         return (
             <Dialog
                 bodyKey = 'dialog.passwordLabel'
@@ -59,7 +58,7 @@ class PasswordRequiredPrompt extends Component {
      * Notifies this prompt that it has been dismissed by cancel.
      *
      * @private
-     * @returns {boolean} whether to hide dialog.
+     * @returns {boolean} True to hide this dialog/prompt; otherwise, false.
      */
     _onCancel() {
         // XXX The user has canceled this prompt for a password so we are to
@@ -75,7 +74,7 @@ class PasswordRequiredPrompt extends Component {
      *
      * @param {string} value - The submitted value.
      * @private
-     * @returns {boolean} whether to hide dialog.
+     * @returns {boolean} True to hide this dialog/prompt; otherwise, false.
      */
     _onSubmit(value) {
         const conference = this.props.conference;
diff --git a/react/features/room-lock/components/RoomLockPrompt.native.js b/react/features/room-lock/components/RoomLockPrompt.native.js
index 38ef771df..c70f39f4f 100644
--- a/react/features/room-lock/components/RoomLockPrompt.native.js
+++ b/react/features/room-lock/components/RoomLockPrompt.native.js
@@ -45,7 +45,6 @@ class RoomLockPrompt extends Component {
      * @returns {ReactElement}
      */
     render() {
-
         return (
             <Dialog
                 bodyKey = 'dialog.passwordLabel'
@@ -59,7 +58,7 @@ class RoomLockPrompt extends Component {
      * Notifies this prompt that it has been dismissed by cancel.
      *
      * @private
-     * @returns {boolean} whether to hide the dialog
+     * @returns {boolean} True to hide this dialog/prompt; otherwise, false.
      */
     _onCancel() {
         // An undefined password is understood to cancel the request to lock the
@@ -73,15 +72,14 @@ class RoomLockPrompt extends Component {
      *
      * @param {string} value - The submitted value.
      * @private
-     * @returns {boolean} returns false, we do not want to hide dialog as this
-     * will be handled inside endRoomLockRequest after setting password is
-     * resolved.
+     * @returns {boolean} False because we do not want to hide this
+     * dialog/prompt as the hiding will be handled inside endRoomLockRequest
+     * after setting the password is resolved.
      */
     _onSubmit(value) {
         this.props.dispatch(endRoomLockRequest(this.props.conference, value));
 
-        // do not hide
-        return false;
+        return false; // Do not hide.
     }
 }