Kaynağa Gözat

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.)
master
Lyubo Marinov 8 yıl önce
ebeveyn
işleme
d37468975c

+ 2
- 3
react/features/room-lock/components/PasswordRequiredPrompt.native.js Dosyayı Görüntüle

45
      * @returns {ReactElement}
45
      * @returns {ReactElement}
46
      */
46
      */
47
     render() {
47
     render() {
48
-
49
         return (
48
         return (
50
             <Dialog
49
             <Dialog
51
                 bodyKey = 'dialog.passwordLabel'
50
                 bodyKey = 'dialog.passwordLabel'
59
      * Notifies this prompt that it has been dismissed by cancel.
58
      * Notifies this prompt that it has been dismissed by cancel.
60
      *
59
      *
61
      * @private
60
      * @private
62
-     * @returns {boolean} whether to hide dialog.
61
+     * @returns {boolean} True to hide this dialog/prompt; otherwise, false.
63
      */
62
      */
64
     _onCancel() {
63
     _onCancel() {
65
         // XXX The user has canceled this prompt for a password so we are to
64
         // XXX The user has canceled this prompt for a password so we are to
75
      *
74
      *
76
      * @param {string} value - The submitted value.
75
      * @param {string} value - The submitted value.
77
      * @private
76
      * @private
78
-     * @returns {boolean} whether to hide dialog.
77
+     * @returns {boolean} True to hide this dialog/prompt; otherwise, false.
79
      */
78
      */
80
     _onSubmit(value) {
79
     _onSubmit(value) {
81
         const conference = this.props.conference;
80
         const conference = this.props.conference;

+ 5
- 7
react/features/room-lock/components/RoomLockPrompt.native.js Dosyayı Görüntüle

45
      * @returns {ReactElement}
45
      * @returns {ReactElement}
46
      */
46
      */
47
     render() {
47
     render() {
48
-
49
         return (
48
         return (
50
             <Dialog
49
             <Dialog
51
                 bodyKey = 'dialog.passwordLabel'
50
                 bodyKey = 'dialog.passwordLabel'
59
      * Notifies this prompt that it has been dismissed by cancel.
58
      * Notifies this prompt that it has been dismissed by cancel.
60
      *
59
      *
61
      * @private
60
      * @private
62
-     * @returns {boolean} whether to hide the dialog
61
+     * @returns {boolean} True to hide this dialog/prompt; otherwise, false.
63
      */
62
      */
64
     _onCancel() {
63
     _onCancel() {
65
         // An undefined password is understood to cancel the request to lock the
64
         // An undefined password is understood to cancel the request to lock the
73
      *
72
      *
74
      * @param {string} value - The submitted value.
73
      * @param {string} value - The submitted value.
75
      * @private
74
      * @private
76
-     * @returns {boolean} returns false, we do not want to hide dialog as this
77
-     * will be handled inside endRoomLockRequest after setting password is
78
-     * resolved.
75
+     * @returns {boolean} False because we do not want to hide this
76
+     * dialog/prompt as the hiding will be handled inside endRoomLockRequest
77
+     * after setting the password is resolved.
79
      */
78
      */
80
     _onSubmit(value) {
79
     _onSubmit(value) {
81
         this.props.dispatch(endRoomLockRequest(this.props.conference, value));
80
         this.props.dispatch(endRoomLockRequest(this.props.conference, value));
82
 
81
 
83
-        // do not hide
84
-        return false;
82
+        return false; // Do not hide.
85
     }
83
     }
86
 }
84
 }
87
 
85
 

Loading…
İptal
Kaydet