瀏覽代碼

[RN] Fix documentation comments

* Javadoc introduced @code as a replacement of <code> and <tt> which is
  better aligned with other javadoc tags such as @link. Use it in the
  Java source code. If we switch to Kotlin, then we'll definitely use
  Markdown.

* There are more uses of @code in the JavaScript source code than <tt>
  so use @code for the sake of consistency. Eventually, I'd rather we
  switch to Markdown because it's easier on my eyes.

* Xcode is plain confused by @code and @link. The Internet says that
  Xcode supports the backquote character to denote the beginning and end
  of a string of characters which should be formatted for display as
  code but it doesn't work for me. <tt> is not rendered at all. So use
  the backquote which is rendered itself. Hopefully, if we switch to
  Markdown, then it'll be common between JavaScript and Objective-C
  source code.
efficient_tiling
Lyubo Marinov 7 年之前
父節點
當前提交
4bf19d73fd
共有 58 個檔案被更改,包括 333 行新增417 行删除
  1. 1
    24
      android/app/src/main/java/org/jitsi/meet/MainActivity.java
  2. 0
    3
      android/sdk/src/main/java/org/jitsi/meet/sdk/AndroidSettingsModule.java
  3. 1
    4
      android/sdk/src/main/java/org/jitsi/meet/sdk/AppInfoModule.java
  4. 7
    7
      android/sdk/src/main/java/org/jitsi/meet/sdk/AudioModeModule.java
  5. 2
    1
      android/sdk/src/main/java/org/jitsi/meet/sdk/BluetoothHeadsetMonitor.java
  6. 9
    9
      android/sdk/src/main/java/org/jitsi/meet/sdk/DefaultHardwareBackBtnHandlerImpl.java
  7. 5
    26
      android/sdk/src/main/java/org/jitsi/meet/sdk/JitsiMeetActivity.java
  8. 27
    28
      android/sdk/src/main/java/org/jitsi/meet/sdk/JitsiMeetView.java
  9. 0
    18
      android/sdk/src/main/java/org/jitsi/meet/sdk/JitsiMeetViewAdapter.java
  10. 7
    7
      android/sdk/src/main/java/org/jitsi/meet/sdk/JitsiMeetViewListener.java
  11. 1
    1
      android/sdk/src/main/java/org/jitsi/meet/sdk/ProximityModule.java
  12. 0
    9
      android/sdk/src/main/java/org/jitsi/meet/sdk/ReactPackageAdapter.java
  13. 2
    2
      ios/sdk/src/ExternalAPI.m
  14. 34
    37
      ios/sdk/src/JitsiMeetView.m
  15. 9
    13
      ios/sdk/src/JitsiMeetViewDelegate.h
  16. 2
    2
      ios/sdk/src/Proximity.m
  17. 1
    1
      ios/sdk/src/RCTBridgeWrapper.h
  18. 1
    1
      react/features/app/actions.js
  19. 1
    1
      react/features/authentication/actionTypes.js
  20. 1
    1
      react/features/authentication/actions.js
  21. 2
    2
      react/features/authentication/components/WaitForOwnerDialog.native.js
  22. 8
    8
      react/features/authentication/components/styles.js
  23. 1
    1
      react/features/base/config/functions.js
  24. 2
    2
      react/features/base/connection/functions.js
  25. 8
    8
      react/features/base/dialog/actions.js
  26. 10
    10
      react/features/base/dialog/components/AbstractDialog.js
  27. 10
    10
      react/features/base/dialog/components/Dialog.native.js
  28. 1
    1
      react/features/base/dialog/components/DialogContainer.js
  29. 3
    3
      react/features/base/dialog/components/styles.js
  30. 4
    4
      react/features/base/dialog/functions.js
  31. 1
    1
      react/features/base/lib-jitsi-meet/native/RTCPeerConnection.js
  32. 10
    10
      react/features/base/lib-jitsi-meet/native/Storage.js
  33. 3
    3
      react/features/base/media/functions.js
  34. 5
    5
      react/features/base/participants/components/Avatar.native.js
  35. 1
    1
      react/features/base/participants/constants.js
  36. 2
    2
      react/features/base/participants/reducer.js
  37. 1
    1
      react/features/base/react/components/web/Watermarks.js
  38. 27
    27
      react/features/base/redux/functions.js
  39. 11
    11
      react/features/base/tracks/actions.js
  40. 6
    6
      react/features/base/tracks/functions.js
  41. 6
    6
      react/features/base/tracks/middleware.js
  42. 1
    1
      react/features/base/util/loadScript.native.js
  43. 8
    8
      react/features/conference/components/Conference.native.js
  44. 3
    3
      react/features/filmstrip/components/Filmstrip.native.js
  45. 2
    2
      react/features/large-video/actions.js
  46. 44
    44
      react/features/mobile/callkit/middleware.js
  47. 3
    3
      react/features/mobile/external-api/middleware.js
  48. 7
    7
      react/features/mobile/image-cache/functions.js
  49. 1
    1
      react/features/mobile/image-cache/middleware.js
  50. 4
    4
      react/features/mobile/network-activity/components/NetworkActivityIndicator.js
  51. 1
    1
      react/features/overlay/reducer.js
  52. 2
    2
      react/features/toolbox/middleware.js
  53. 6
    6
      react/features/welcome/components/BlankPage.native.js
  54. 1
    1
      react/features/welcome/components/LocalVideoTrackUnderlay.native.js
  55. 1
    1
      react/features/welcome/components/WelcomePage.web.js
  56. 8
    8
      react/features/welcome/components/styles.js
  57. 6
    6
      react/features/welcome/functions.js
  58. 2
    2
      react/features/welcome/route.js

+ 1
- 24
android/app/src/main/java/org/jitsi/meet/MainActivity.java 查看文件

38
  * {@code react-native run-android}.
38
  * {@code react-native run-android}.
39
  */
39
  */
40
 public class MainActivity extends JitsiMeetActivity {
40
 public class MainActivity extends JitsiMeetActivity {
41
-    /**
42
-     * {@inheritDoc}
43
-     */
41
+    @Override
44
     protected JitsiMeetView initializeView() {
42
     protected JitsiMeetView initializeView() {
45
         JitsiMeetView view = super.initializeView();
43
         JitsiMeetView view = super.initializeView();
46
 
44
 
59
                             + data);
57
                             + data);
60
                 }
58
                 }
61
 
59
 
62
-                /**
63
-                 * {@inheritDoc}
64
-                 */
65
                 @Override
60
                 @Override
66
                 public void onConferenceFailed(Map<String, Object> data) {
61
                 public void onConferenceFailed(Map<String, Object> data) {
67
                     on("CONFERENCE_FAILED", data);
62
                     on("CONFERENCE_FAILED", data);
68
                 }
63
                 }
69
 
64
 
70
-                /**
71
-                 * {@inheritDoc}
72
-                 */
73
                 @Override
65
                 @Override
74
                 public void onConferenceJoined(Map<String, Object> data) {
66
                 public void onConferenceJoined(Map<String, Object> data) {
75
                     on("CONFERENCE_JOINED", data);
67
                     on("CONFERENCE_JOINED", data);
76
                 }
68
                 }
77
 
69
 
78
-                /**
79
-                 * {@inheritDoc}
80
-                 */
81
                 @Override
70
                 @Override
82
                 public void onConferenceLeft(Map<String, Object> data) {
71
                 public void onConferenceLeft(Map<String, Object> data) {
83
                     on("CONFERENCE_LEFT", data);
72
                     on("CONFERENCE_LEFT", data);
84
                 }
73
                 }
85
 
74
 
86
-                /**
87
-                 * {@inheritDoc}
88
-                 */
89
                 @Override
75
                 @Override
90
                 public void onConferenceWillJoin(Map<String, Object> data) {
76
                 public void onConferenceWillJoin(Map<String, Object> data) {
91
                     on("CONFERENCE_WILL_JOIN", data);
77
                     on("CONFERENCE_WILL_JOIN", data);
92
                 }
78
                 }
93
 
79
 
94
-                /**
95
-                 * {@inheritDoc}
96
-                 */
97
                 @Override
80
                 @Override
98
                 public void onConferenceWillLeave(Map<String, Object> data) {
81
                 public void onConferenceWillLeave(Map<String, Object> data) {
99
                     on("CONFERENCE_WILL_LEAVE", data);
82
                     on("CONFERENCE_WILL_LEAVE", data);
100
                 }
83
                 }
101
 
84
 
102
-                /**
103
-                 * {@inheritDoc}
104
-                 */
105
                 @Override
85
                 @Override
106
                 public void onLoadConfigError(Map<String, Object> data) {
86
                 public void onLoadConfigError(Map<String, Object> data) {
107
                     on("LOAD_CONFIG_ERROR", data);
87
                     on("LOAD_CONFIG_ERROR", data);
112
         return view;
92
         return view;
113
     }
93
     }
114
 
94
 
115
-    /**
116
-     * {@inheritDoc}
117
-     */
118
     @Override
95
     @Override
119
     protected void onCreate(Bundle savedInstanceState) {
96
     protected void onCreate(Bundle savedInstanceState) {
120
         // As this is the Jitsi Meet app (i.e. not the Jitsi Meet SDK), we do
97
         // As this is the Jitsi Meet app (i.e. not the Jitsi Meet SDK), we do

+ 0
- 3
android/sdk/src/main/java/org/jitsi/meet/sdk/AndroidSettingsModule.java 查看文件

19
         super(reactContext);
19
         super(reactContext);
20
     }
20
     }
21
 
21
 
22
-    /**
23
-     * {@inheritDoc}
24
-     */
25
     @Override
22
     @Override
26
     public String getName() {
23
     public String getName() {
27
         return "AndroidSettings";
24
         return "AndroidSettings";

+ 1
- 4
android/sdk/src/main/java/org/jitsi/meet/sdk/AppInfoModule.java 查看文件

17
     }
17
     }
18
 
18
 
19
     /**
19
     /**
20
-     * Gets a <tt>Map</tt> of constants this module exports to JS. Supports JSON
20
+     * Gets a {@code Map} of constants this module exports to JS. Supports JSON
21
      * types.
21
      * types.
22
      *
22
      *
23
      * @return a {@link Map} of constants this module exports to JS
23
      * @return a {@link Map} of constants this module exports to JS
54
         return constants;
54
         return constants;
55
     }
55
     }
56
 
56
 
57
-    /**
58
-     * {@inheritDoc}
59
-     */
60
     @Override
57
     @Override
61
     public String getName() {
58
     public String getName() {
62
         return "AppInfo";
59
         return "AppInfo";

+ 7
- 7
android/sdk/src/main/java/org/jitsi/meet/sdk/AudioModeModule.java 查看文件

40
  * Module implementing a simple API to select the appropriate audio device for a
40
  * Module implementing a simple API to select the appropriate audio device for a
41
  * conference call.
41
  * conference call.
42
  *
42
  *
43
- * Audio calls should use <tt>AudioModeModule.AUDIO_CALL</tt>, which uses the
43
+ * Audio calls should use {@code AudioModeModule.AUDIO_CALL}, which uses the
44
  * builtin earpiece, wired headset or bluetooth headset. The builtin earpiece is
44
  * builtin earpiece, wired headset or bluetooth headset. The builtin earpiece is
45
  * the default audio device.
45
  * the default audio device.
46
  *
46
  *
47
- * Video calls should should use <tt>AudioModeModule.VIDEO_CALL</tt>, which uses
47
+ * Video calls should should use {@code AudioModeModule.VIDEO_CALL}, which uses
48
  * the builtin speaker, earpiece, wired headset or bluetooth headset. The
48
  * the builtin speaker, earpiece, wired headset or bluetooth headset. The
49
  * builtin speaker is the default audio device.
49
  * builtin speaker is the default audio device.
50
  *
50
  *
51
  * Before a call has started and after it has ended the
51
  * Before a call has started and after it has ended the
52
- * <tt>AudioModeModule.DEFAULT</tt> mode should be used.
52
+ * {@code AudioModeModule.DEFAULT} mode should be used.
53
  */
53
  */
54
 class AudioModeModule extends ReactContextBaseJavaModule {
54
 class AudioModeModule extends ReactContextBaseJavaModule {
55
     /**
55
     /**
74
             : Intent.ACTION_HEADSET_PLUG;
74
             : Intent.ACTION_HEADSET_PLUG;
75
 
75
 
76
     /**
76
     /**
77
-     * The name of <tt>AudioModeModule</tt> to be used in the React Native
77
+     * The name of {@code AudioModeModule} to be used in the React Native
78
      * bridge.
78
      * bridge.
79
      */
79
      */
80
     private static final String MODULE_NAME = "AudioMode";
80
     private static final String MODULE_NAME = "AudioMode";
81
 
81
 
82
     /**
82
     /**
83
-     * The <tt>Log</tt> tag <tt>AudioModeModule</tt> is to log messages with.
83
+     * The {@code Log} tag {@code AudioModeModule} is to log messages with.
84
      */
84
      */
85
     static final String TAG = MODULE_NAME;
85
     static final String TAG = MODULE_NAME;
86
 
86
 
291
      * Updates the audio route for the given mode.
291
      * Updates the audio route for the given mode.
292
      *
292
      *
293
      * @param mode the audio mode to be used when computing the audio route.
293
      * @param mode the audio mode to be used when computing the audio route.
294
-     * @return true if the audio route was updated successfully, false
295
-     * otherwise.
294
+     * @return {@code true} if the audio route was updated successfully;
295
+     * {@code false}, otherwise.
296
      */
296
      */
297
     private boolean updateAudioRoute(int mode) {
297
     private boolean updateAudioRoute(int mode) {
298
         Log.d(TAG, "Update audio route for mode: " + mode);
298
         Log.d(TAG, "Update audio route for mode: " + mode);

+ 2
- 1
android/sdk/src/main/java/org/jitsi/meet/sdk/BluetoothHeadsetMonitor.java 查看文件

137
     /**
137
     /**
138
      * Returns the current headset availability.
138
      * Returns the current headset availability.
139
      *
139
      *
140
-     * @return true if there is a Bluetooth headset connected, false otherwise.
140
+     * @return {@code true} if there is a Bluetooth headset connected;
141
+     * {@code false}, otherwise.
141
      */
142
      */
142
     public boolean isHeadsetAvailable() {
143
     public boolean isHeadsetAvailable() {
143
         return headsetAvailable;
144
         return headsetAvailable;

+ 9
- 9
android/sdk/src/main/java/org/jitsi/meet/sdk/DefaultHardwareBackBtnHandlerImpl.java 查看文件

21
 import com.facebook.react.modules.core.DefaultHardwareBackBtnHandler;
21
 import com.facebook.react.modules.core.DefaultHardwareBackBtnHandler;
22
 
22
 
23
 /**
23
 /**
24
- * Defines the default behavior of <tt>JitsiMeetActivity</tt> and
25
- * <tt>JitsiMeetView</tt> upon invoking the back button if no
26
- * <tt>JitsiMeetView</tt> handles the invocation. For example, a
27
- * <tt>JitsiMeetView</tt> may (1) handle the invocation of the back button
24
+ * Defines the default behavior of {@code JitsiMeetActivity} and
25
+ * {@code JitsiMeetView} upon invoking the back button if no
26
+ * {@code JitsiMeetView} handles the invocation. For example, a
27
+ * {@code JitsiMeetView} may (1) handle the invocation of the back button
28
  * during a conference by leaving the conference and (2) not handle the
28
  * during a conference by leaving the conference and (2) not handle the
29
  * invocation when not in a conference.
29
  * invocation when not in a conference.
30
  */
30
  */
32
     implements DefaultHardwareBackBtnHandler {
32
     implements DefaultHardwareBackBtnHandler {
33
 
33
 
34
     /**
34
     /**
35
-     * The <tt>Activity</tt> to which the default handling of the back button
35
+     * The {@code Activity} to which the default handling of the back button
36
      * is being provided by this instance.
36
      * is being provided by this instance.
37
      */
37
      */
38
     private final Activity activity;
38
     private final Activity activity;
39
 
39
 
40
     /**
40
     /**
41
-     * Initializes a new <tt>DefaultHardwareBackBtnHandlerImpl</tt> instance to
41
+     * Initializes a new {@code DefaultHardwareBackBtnHandlerImpl} instance to
42
      * provide the default handling of the back button to a specific
42
      * provide the default handling of the back button to a specific
43
-     * <tt>Activity</tt>.
43
+     * {@code Activity}.
44
      *
44
      *
45
-     * @param activity - the <tt>Activity</tt> to which the new instance is to
45
+     * @param activity the {@code Activity} to which the new instance is to
46
      * provide the default behavior of the back button
46
      * provide the default behavior of the back button
47
      */
47
      */
48
     public DefaultHardwareBackBtnHandlerImpl(Activity activity) {
48
     public DefaultHardwareBackBtnHandlerImpl(Activity activity) {
52
     /**
52
     /**
53
      * {@inheritDoc}
53
      * {@inheritDoc}
54
      *
54
      *
55
-     * Finishes the associated <tt>Activity</tt>.
55
+     * Finishes the associated {@code Activity}.
56
      */
56
      */
57
     @Override
57
     @Override
58
     public void invokeDefaultOnBackPressed() {
58
     public void invokeDefaultOnBackPressed() {

+ 5
- 26
android/sdk/src/main/java/org/jitsi/meet/sdk/JitsiMeetActivity.java 查看文件

30
 
30
 
31
 /**
31
 /**
32
  * Base Activity for applications integrating Jitsi Meet at a higher level. It
32
  * Base Activity for applications integrating Jitsi Meet at a higher level. It
33
- * contains all the required wiring between the <tt>JKConferenceView</tt> and
33
+ * contains all the required wiring between the {@code JKConferenceView} and
34
  * the Activity lifecycle methods already implemented.
34
  * the Activity lifecycle methods already implemented.
35
  *
35
  *
36
- * In this activity we use a single <tt>JKConferenceView</tt> instance. This
36
+ * In this activity we use a single {@code JKConferenceView} instance. This
37
  * instance gives us access to a view which displays the welcome page and the
37
  * instance gives us access to a view which displays the welcome page and the
38
  * conference itself. All lifetime methods associated with this Activity are
38
  * conference itself. All lifetime methods associated with this Activity are
39
  * hooked to the React Native subsystem via proxy calls through the
39
  * hooked to the React Native subsystem via proxy calls through the
40
- * <tt>JKConferenceView</tt> static methods.
40
+ * {@code JKConferenceView} static methods.
41
  */
41
  */
42
 public class JitsiMeetActivity
42
 public class JitsiMeetActivity
43
     extends AppCompatActivity {
43
     extends AppCompatActivity {
50
         = (int) (Math.random() * Short.MAX_VALUE);
50
         = (int) (Math.random() * Short.MAX_VALUE);
51
 
51
 
52
     /**
52
     /**
53
-     * The default behavior of this <tt>JitsiMeetActivity</tt> upon invoking the
53
+     * The default behavior of this {@code JitsiMeetActivity} upon invoking the
54
      * back button if {@link #view} does not handle the invocation.
54
      * back button if {@link #view} does not handle the invocation.
55
      */
55
      */
56
     private DefaultHardwareBackBtnHandler defaultBackButtonImpl;
56
     private DefaultHardwareBackBtnHandler defaultBackButtonImpl;
132
      * Loads the given URL and displays the conference. If the specified URL is
132
      * Loads the given URL and displays the conference. If the specified URL is
133
      * null, the welcome page is displayed instead.
133
      * null, the welcome page is displayed instead.
134
      *
134
      *
135
-     * @param url - The conference URL.
135
+     * @param url The conference URL.
136
      */
136
      */
137
     public void loadURL(@Nullable URL url) {
137
     public void loadURL(@Nullable URL url) {
138
         view.loadURL(url);
138
         view.loadURL(url);
139
     }
139
     }
140
 
140
 
141
-    /**
142
-     * {@inheritDoc}
143
-     */
144
     @Override
141
     @Override
145
     protected void onActivityResult(
142
     protected void onActivityResult(
146
             int requestCode,
143
             int requestCode,
154
         }
151
         }
155
     }
152
     }
156
 
153
 
157
-    /**
158
-     * {@inheritDoc}
159
-     */
160
     @Override
154
     @Override
161
     public void onBackPressed() {
155
     public void onBackPressed() {
162
         if (!JitsiMeetView.onBackPressed()) {
156
         if (!JitsiMeetView.onBackPressed()) {
174
         }
168
         }
175
     }
169
     }
176
 
170
 
177
-    /**
178
-     * {@inheritDoc}
179
-     */
180
     @Override
171
     @Override
181
     protected void onCreate(Bundle savedInstanceState) {
172
     protected void onCreate(Bundle savedInstanceState) {
182
         super.onCreate(savedInstanceState);
173
         super.onCreate(savedInstanceState);
196
         initializeContentView();
187
         initializeContentView();
197
     }
188
     }
198
 
189
 
199
-    /**
200
-     * {@inheritDoc}
201
-     */
202
     @Override
190
     @Override
203
     protected void onDestroy() {
191
     protected void onDestroy() {
204
         super.onDestroy();
192
         super.onDestroy();
211
         JitsiMeetView.onHostDestroy(this);
199
         JitsiMeetView.onHostDestroy(this);
212
     }
200
     }
213
 
201
 
214
-    /**
215
-     * {@inheritDoc}
216
-     */
217
     @Override
202
     @Override
218
     public void onNewIntent(Intent intent) {
203
     public void onNewIntent(Intent intent) {
219
         JitsiMeetView.onNewIntent(intent);
204
         JitsiMeetView.onNewIntent(intent);
220
     }
205
     }
221
 
206
 
222
-    /**
223
-     * {@inheritDoc}
224
-     */
225
     @Override
207
     @Override
226
     protected void onPause() {
208
     protected void onPause() {
227
         super.onPause();
209
         super.onPause();
230
         defaultBackButtonImpl = null;
212
         defaultBackButtonImpl = null;
231
     }
213
     }
232
 
214
 
233
-    /**
234
-     * {@inheritDoc}
235
-     */
236
     @Override
215
     @Override
237
     protected void onResume() {
216
     protected void onResume() {
238
         super.onResume();
217
         super.onResume();

+ 27
- 28
android/sdk/src/main/java/org/jitsi/meet/sdk/JitsiMeetView.java 查看文件

84
     /**
84
     /**
85
      * Internal method to initialize the React Native instance manager. We
85
      * Internal method to initialize the React Native instance manager. We
86
      * create a single instance in order to load the JavaScript bundle a single
86
      * create a single instance in order to load the JavaScript bundle a single
87
-     * time. All <tt>ReactRootView</tt> instances will be tied to the one and
88
-     * only <tt>ReactInstanceManager</tt>.
87
+     * time. All {@code ReactRootView} instances will be tied to the one and
88
+     * only {@code ReactInstanceManager}.
89
      *
89
      *
90
-     * @param application - <tt>Application</tt> instance which is running.
90
+     * @param application {@code Application} instance which is running.
91
      */
91
      */
92
     private static void initReactInstanceManager(Application application) {
92
     private static void initReactInstanceManager(Application application) {
93
         reactInstanceManager
93
         reactInstanceManager
118
      * Loads a specific URL {@code String} in all existing
118
      * Loads a specific URL {@code String} in all existing
119
      * {@code JitsiMeetView}s.
119
      * {@code JitsiMeetView}s.
120
      *
120
      *
121
-     * @param urlString - The URL {@code String} to load in all existing
121
+     * @param urlString he URL {@code String} to load in all existing
122
      * {@code JitsiMeetView}s.
122
      * {@code JitsiMeetView}s.
123
      * @return If the specified {@code urlString} was submitted for loading in
123
      * @return If the specified {@code urlString} was submitted for loading in
124
      * at least one {@code JitsiMeetView}, then {@code true}; otherwise,
124
      * at least one {@code JitsiMeetView}, then {@code true}; otherwise,
140
 
140
 
141
     /**
141
     /**
142
      * Activity lifecycle method which should be called from
142
      * Activity lifecycle method which should be called from
143
-     * <tt>Activity.onBackPressed</tt> so we can do the required internal
143
+     * {@code Activity.onBackPressed} so we can do the required internal
144
      * processing.
144
      * processing.
145
      *
145
      *
146
-     * @return - true if the back-press was processed, false otherwise. In case
147
-     * false is returned the application should call the parent's
146
+     * @return {@code true} if the back-press was processed; {@code false},
147
+     * otherwise. If {@code false}, the application should call the parent's
148
      * implementation.
148
      * implementation.
149
      */
149
      */
150
     public static boolean onBackPressed() {
150
     public static boolean onBackPressed() {
158
 
158
 
159
     /**
159
     /**
160
      * Activity lifecycle method which should be called from
160
      * Activity lifecycle method which should be called from
161
-     * <tt>Activity.onDestroy</tt> so we can do the required internal
161
+     * {@code Activity.onDestroy} so we can do the required internal
162
      * processing.
162
      * processing.
163
      *
163
      *
164
-     * @param activity - <tt>Activity</tt> being destroyed.
164
+     * @param activity {@code Activity} being destroyed.
165
      */
165
      */
166
     public static void onHostDestroy(Activity activity) {
166
     public static void onHostDestroy(Activity activity) {
167
         if (reactInstanceManager != null) {
167
         if (reactInstanceManager != null) {
171
 
171
 
172
     /**
172
     /**
173
      * Activity lifecycle method which should be called from
173
      * Activity lifecycle method which should be called from
174
-     * <tt>Activity.onPause</tt> so we can do the required internal processing.
174
+     * {@code Activity.onPause} so we can do the required internal processing.
175
      *
175
      *
176
-     * @param activity - <tt>Activity</tt> being paused.
176
+     * @param activity {@code Activity} being paused.
177
      */
177
      */
178
     public static void onHostPause(Activity activity) {
178
     public static void onHostPause(Activity activity) {
179
         if (reactInstanceManager != null) {
179
         if (reactInstanceManager != null) {
183
 
183
 
184
     /**
184
     /**
185
      * Activity lifecycle method which should be called from
185
      * Activity lifecycle method which should be called from
186
-     * <tt>Activity.onResume</tt> so we can do the required internal processing.
186
+     * {@code Activity.onResume} so we can do the required internal processing.
187
      *
187
      *
188
-     * @param activity - <tt>Activity</tt> being resumed.
188
+     * @param activity {@code Activity} being resumed.
189
      */
189
      */
190
     public static void onHostResume(Activity activity) {
190
     public static void onHostResume(Activity activity) {
191
         onHostResume(activity, new DefaultHardwareBackBtnHandlerImpl(activity));
191
         onHostResume(activity, new DefaultHardwareBackBtnHandlerImpl(activity));
193
 
193
 
194
     /**
194
     /**
195
      * Activity lifecycle method which should be called from
195
      * Activity lifecycle method which should be called from
196
-     * <tt>Activity.onResume</tt> so we can do the required internal processing.
196
+     * {@code Activity.onResume} so we can do the required internal processing.
197
      *
197
      *
198
-     * @param activity - <tt>Activity</tt> being resumed.
199
-     * @param defaultBackButtonImpl - a <tt>DefaultHardwareBackBtnHandler</tt>
200
-     * to handle invoking the back button if no <tt>JitsiMeetView</tt> handles
201
-     * it.
198
+     * @param activity {@code Activity} being resumed.
199
+     * @param defaultBackButtonImpl a {@code DefaultHardwareBackBtnHandler} to
200
+     * handle invoking the back button if no {@code JitsiMeetView} handles it.
202
      */
201
      */
203
     public static void onHostResume(
202
     public static void onHostResume(
204
             Activity activity,
203
             Activity activity,
210
 
209
 
211
     /**
210
     /**
212
      * Activity lifecycle method which should be called from
211
      * Activity lifecycle method which should be called from
213
-     * <tt>Activity.onNewIntent</tt> so we can do the required internal
212
+     * {@code Activity.onNewIntent} so we can do the required internal
214
      * processing. Note that this is only needed if the activity's "launchMode"
213
      * processing. Note that this is only needed if the activity's "launchMode"
215
      * was set to "singleTask". This is required for deep linking to work once
214
      * was set to "singleTask". This is required for deep linking to work once
216
      * the application is already running.
215
      * the application is already running.
217
      *
216
      *
218
-     * @param intent - <tt>Intent</tt> instance which was received.
217
+     * @param intent {@code Intent} instance which was received.
219
      */
218
      */
220
     public static void onNewIntent(Intent intent) {
219
     public static void onNewIntent(Intent intent) {
221
         // XXX At least twice we received bug reports about malfunctioning
220
         // XXX At least twice we received bug reports about malfunctioning
301
     /**
300
     /**
302
      * Gets the default base {@code URL} used to join a conference when a
301
      * Gets the default base {@code URL} used to join a conference when a
303
      * partial URL (e.g. a room name only) is specified to
302
      * partial URL (e.g. a room name only) is specified to
304
-     * {@link #loadURLString(String)} or {@link #loadURLObject(Bundle}. If not
303
+     * {@link #loadURLString(String)} or {@link #loadURLObject(Bundle)}. If not
305
      * set or if set to {@code null}, the default built in JavaScript is used:
304
      * set or if set to {@code null}, the default built in JavaScript is used:
306
      * {@link https://meet.jit.si}
305
      * {@link https://meet.jit.si}
307
      *
306
      *
326
      * page is rendered when this {@code JitsiMeetView} is not at a URL
325
      * page is rendered when this {@code JitsiMeetView} is not at a URL
327
      * identifying a Jitsi Meet conference/room.
326
      * identifying a Jitsi Meet conference/room.
328
      *
327
      *
329
-     * @return {@true} if the Welcome page is enabled; otherwise, {@code false}.
328
+     * @return {@code true} if the Welcome page is enabled; otherwise,
329
+     * {@code false}.
330
      */
330
      */
331
     public boolean getWelcomePageEnabled() {
331
     public boolean getWelcomePageEnabled() {
332
         return welcomePageEnabled;
332
         return welcomePageEnabled;
337
      * the specified {@code URL} is {@code null} and the Welcome page is
337
      * the specified {@code URL} is {@code null} and the Welcome page is
338
      * enabled, the Welcome page is displayed instead.
338
      * enabled, the Welcome page is displayed instead.
339
      *
339
      *
340
-     * @param url - The {@code URL} to load which may identify a conference to
340
+     * @param url The {@code URL} to load which may identify a conference to
341
      * join.
341
      * join.
342
      */
342
      */
343
     public void loadURL(@Nullable URL url) {
343
     public void loadURL(@Nullable URL url) {
352
      * clients/consumers. If the specified URL is {@code null} and the Welcome
352
      * clients/consumers. If the specified URL is {@code null} and the Welcome
353
      * page is enabled, the Welcome page is displayed instead.
353
      * page is enabled, the Welcome page is displayed instead.
354
      *
354
      *
355
-     * @param urlObject - The URL to load which may identify a conference to
356
-     * join.
355
+     * @param urlObject The URL to load which may identify a conference to join.
357
      */
356
      */
358
     public void loadURLObject(@Nullable Bundle urlObject) {
357
     public void loadURLObject(@Nullable Bundle urlObject) {
359
         Bundle props = new Bundle();
358
         Bundle props = new Bundle();
386
      * join. If the specified URL {@code String} is {@code null} and the Welcome
385
      * join. If the specified URL {@code String} is {@code null} and the Welcome
387
      * page is enabled, the Welcome page is displayed instead.
386
      * page is enabled, the Welcome page is displayed instead.
388
      *
387
      *
389
-     * @param urlString - The URL {@code String} to load which may identify a
388
+     * @param urlString The URL {@code String} to load which may identify a
390
      * conference to join.
389
      * conference to join.
391
      */
390
      */
392
     public void loadURLString(@Nullable String urlString) {
391
     public void loadURLString(@Nullable String urlString) {
407
      * {@link #loadURLString(String)} or {@link #loadURLObject(Bundle)}. Must be
406
      * {@link #loadURLString(String)} or {@link #loadURLObject(Bundle)}. Must be
408
      * called before {@link #loadURL(URL)} for it to take effect.
407
      * called before {@link #loadURL(URL)} for it to take effect.
409
      *
408
      *
410
-     * @param defaultURL - The {@code URL} to be set as the default base URL.
409
+     * @param defaultURL The {@code URL} to be set as the default base URL.
411
      * @see #getDefaultURL()
410
      * @see #getDefaultURL()
412
      */
411
      */
413
     public void setDefaultURL(URL defaultURL) {
412
     public void setDefaultURL(URL defaultURL) {
418
      * Sets a specific {@link JitsiMeetViewListener} on this
417
      * Sets a specific {@link JitsiMeetViewListener} on this
419
      * {@code JitsiMeetView}.
418
      * {@code JitsiMeetView}.
420
      *
419
      *
421
-     * @param listener - The {@code JitsiMeetViewListener} to set on this
420
+     * @param listener The {@code JitsiMeetViewListener} to set on this
422
      * {@code JitsiMeetView}.
421
      * {@code JitsiMeetView}.
423
      */
422
      */
424
     public void setListener(JitsiMeetViewListener listener) {
423
     public void setListener(JitsiMeetViewListener listener) {

+ 0
- 18
android/sdk/src/main/java/org/jitsi/meet/sdk/JitsiMeetViewAdapter.java 查看文件

23
  * all methods in the interface if they are only interested in some.
23
  * all methods in the interface if they are only interested in some.
24
  */
24
  */
25
 public abstract class JitsiMeetViewAdapter implements JitsiMeetViewListener {
25
 public abstract class JitsiMeetViewAdapter implements JitsiMeetViewListener {
26
-    /**
27
-     * {@inheritDoc}
28
-     */
29
     @Override
26
     @Override
30
     public void onConferenceFailed(Map<String, Object> data) {
27
     public void onConferenceFailed(Map<String, Object> data) {
31
     }
28
     }
32
 
29
 
33
-    /**
34
-     * {@inheritDoc}
35
-     */
36
     @Override
30
     @Override
37
     public void onConferenceJoined(Map<String, Object> data) {
31
     public void onConferenceJoined(Map<String, Object> data) {
38
     }
32
     }
39
 
33
 
40
-    /**
41
-     * {@inheritDoc}
42
-     */
43
     @Override
34
     @Override
44
     public void onConferenceLeft(Map<String, Object> data) {
35
     public void onConferenceLeft(Map<String, Object> data) {
45
     }
36
     }
46
 
37
 
47
-    /**
48
-     * {@inheritDoc}
49
-     */
50
     @Override
38
     @Override
51
     public void onConferenceWillJoin(Map<String, Object> data) {
39
     public void onConferenceWillJoin(Map<String, Object> data) {
52
     }
40
     }
53
 
41
 
54
-    /**
55
-     * {@inheritDoc}
56
-     */
57
     @Override
42
     @Override
58
     public void onConferenceWillLeave(Map<String, Object> data) {
43
     public void onConferenceWillLeave(Map<String, Object> data) {
59
     }
44
     }
60
 
45
 
61
-    /**
62
-     * {@inheritDoc}
63
-     */
64
     @Override
46
     @Override
65
     public void onLoadConfigError(Map<String, Object> data) {
47
     public void onLoadConfigError(Map<String, Object> data) {
66
     }
48
     }

+ 7
- 7
android/sdk/src/main/java/org/jitsi/meet/sdk/JitsiMeetViewListener.java 查看文件

26
      * Called when joining a conference fails or an ongoing conference is
26
      * Called when joining a conference fails or an ongoing conference is
27
      * interrupted due to a failure.
27
      * interrupted due to a failure.
28
      *
28
      *
29
-     * @param data - Map with an "error" key describing the problem, and
30
-     * a "url" key with the conference URL.
29
+     * @param data Map with an "error" key describing the problem, and a "url"
30
+     * key with the conference URL.
31
      */
31
      */
32
     void onConferenceFailed(Map<String, Object> data);
32
     void onConferenceFailed(Map<String, Object> data);
33
 
33
 
34
     /**
34
     /**
35
      * Called when a conference was joined.
35
      * Called when a conference was joined.
36
      *
36
      *
37
-     * @param data - Map with a "url" key with the conference URL.
37
+     * @param data Map with a "url" key with the conference URL.
38
      */
38
      */
39
     void onConferenceJoined(Map<String, Object> data);
39
     void onConferenceJoined(Map<String, Object> data);
40
 
40
 
41
     /**
41
     /**
42
      * Called when the conference was left, typically after hanging up.
42
      * Called when the conference was left, typically after hanging up.
43
      *
43
      *
44
-     * @param data - Map with a "url" key with the conference URL.
44
+     * @param data Map with a "url" key with the conference URL.
45
      */
45
      */
46
     void onConferenceLeft(Map<String, Object> data);
46
     void onConferenceLeft(Map<String, Object> data);
47
 
47
 
48
     /**
48
     /**
49
      * Called before the conference is joined.
49
      * Called before the conference is joined.
50
      *
50
      *
51
-     * @param data - Map with a "url" key with the conference URL.
51
+     * @param data Map with a "url" key with the conference URL.
52
      */
52
      */
53
     void onConferenceWillJoin(Map<String, Object> data);
53
     void onConferenceWillJoin(Map<String, Object> data);
54
 
54
 
55
     /**
55
     /**
56
      * Called before the conference is left.
56
      * Called before the conference is left.
57
      *
57
      *
58
-     * @param data - Map with a "url" key with the conference URL.
58
+     * @param data Map with a "url" key with the conference URL.
59
      */
59
      */
60
     void onConferenceWillLeave(Map<String, Object> data);
60
     void onConferenceWillLeave(Map<String, Object> data);
61
 
61
 
63
      * Called when loading the main configuration file from the Jitsi Meet
63
      * Called when loading the main configuration file from the Jitsi Meet
64
      * deployment fails.
64
      * deployment fails.
65
      *
65
      *
66
-     * @param data - Map with an "error" key with the error and a "url" key with
66
+     * @param data Map with an "error" key with the error and a "url" key with
67
      * the conference URL which necessitated the loading of the configuration
67
      * the conference URL which necessitated the loading of the configuration
68
      * file.
68
      * file.
69
      */
69
      */

+ 1
- 1
android/sdk/src/main/java/org/jitsi/meet/sdk/ProximityModule.java 查看文件

33
  */
33
  */
34
 class ProximityModule extends ReactContextBaseJavaModule {
34
 class ProximityModule extends ReactContextBaseJavaModule {
35
     /**
35
     /**
36
-     * The name of <tt>ProximityModule</tt> to be used in the React Native
36
+     * The name of {@code ProximityModule} to be used in the React Native
37
      * bridge.
37
      * bridge.
38
      */
38
      */
39
     private static final String MODULE_NAME = "Proximity";
39
     private static final String MODULE_NAME = "Proximity";

+ 0
- 9
android/sdk/src/main/java/org/jitsi/meet/sdk/ReactPackageAdapter.java 查看文件

26
 import java.util.List;
26
 import java.util.List;
27
 
27
 
28
 public class ReactPackageAdapter implements ReactPackage {
28
 public class ReactPackageAdapter implements ReactPackage {
29
-    /**
30
-     * {@inheritDoc}
31
-     */
32
     @Override
29
     @Override
33
     public List<Class<? extends JavaScriptModule>> createJSModules() {
30
     public List<Class<? extends JavaScriptModule>> createJSModules() {
34
         return Collections.emptyList();
31
         return Collections.emptyList();
35
     }
32
     }
36
 
33
 
37
-    /**
38
-     * {@inheritDoc}
39
-     */
40
     @Override
34
     @Override
41
     public List<NativeModule> createNativeModules(
35
     public List<NativeModule> createNativeModules(
42
             ReactApplicationContext reactContext) {
36
             ReactApplicationContext reactContext) {
43
         return Collections.emptyList();
37
         return Collections.emptyList();
44
     }
38
     }
45
 
39
 
46
-    /**
47
-     * {@inheritDoc}
48
-     */
49
     @Override
40
     @Override
50
     public List<ViewManager> createViewManagers(
41
     public List<ViewManager> createViewManagers(
51
             ReactApplicationContext reactContext) {
42
             ReactApplicationContext reactContext) {

+ 2
- 2
ios/sdk/src/ExternalAPI.m 查看文件

31
  *
31
  *
32
  * @param name The name of the event.
32
  * @param name The name of the event.
33
  * @param data The details/specifics of the event to send determined
33
  * @param data The details/specifics of the event to send determined
34
- * by/associated with the specified {@code name}.
34
+ * by/associated with the specified `name`.
35
  * @param scope
35
  * @param scope
36
  */
36
  */
37
 RCT_EXPORT_METHOD(sendEvent:(NSString *)name
37
 RCT_EXPORT_METHOD(sendEvent:(NSString *)name
64
  * method name.
64
  * method name.
65
  *
65
  *
66
  * @param eventName The event name to convert to a method name.
66
  * @param eventName The event name to convert to a method name.
67
- * @return A method name constructed from the specified {@code eventName}.
67
+ * @return A method name constructed from the specified `eventName`.
68
  */
68
  */
69
 - (NSString *)methodNameFromEventName:(NSString *)eventName {
69
 - (NSString *)methodNameFromEventName:(NSString *)eventName {
70
    NSMutableString *methodName
70
    NSMutableString *methodName

+ 34
- 37
ios/sdk/src/JitsiMeetView.m 查看文件

27
 #import "RCTBridgeWrapper.h"
27
 #import "RCTBridgeWrapper.h"
28
 
28
 
29
 /**
29
 /**
30
- * A <tt>RCTFatalHandler</tt> implementation which swallows JavaScript errors.
31
- * In the Release configuration, React Native will (intentionally) raise an
32
- * unhandled NSException for an unhandled JavaScript error. This will
33
- * effectively kill the application. <tt>_RCTFatal</tt> is suitable to be in
34
- * accord with the Web i.e. not kill the application.
30
+ * A `RCTFatalHandler` implementation which swallows JavaScript errors. In the
31
+ * Release configuration, React Native will (intentionally) raise an unhandled
32
+ * `NSException` for an unhandled JavaScript error. This will effectively kill
33
+ * the application. `_RCTFatal` is suitable to be in accord with the Web i.e.
34
+ * not kill the application.
35
  */
35
  */
36
 RCTFatalHandler _RCTFatal = ^(NSError *error) {
36
 RCTFatalHandler _RCTFatal = ^(NSError *error) {
37
     id jsStackTrace = error.userInfo[RCTJSStackTraceKey];
37
     id jsStackTrace = error.userInfo[RCTJSStackTraceKey];
51
 };
51
 };
52
 
52
 
53
 /**
53
 /**
54
- * Helper function to dynamically load custom fonts. The UIAppFonts key in the
54
+ * Helper function to dynamically load custom fonts. The `UIAppFonts` key in the
55
  * plist file doesn't work for frameworks, so fonts have to be manually loaded.
55
  * plist file doesn't work for frameworks, so fonts have to be manually loaded.
56
  */
56
  */
57
 void loadCustomFonts(Class clazz) {
57
 void loadCustomFonts(Class clazz) {
87
 void registerFatalErrorHandler() {
87
 void registerFatalErrorHandler() {
88
 #if !DEBUG
88
 #if !DEBUG
89
     // In the Release configuration, React Native will (intentionally) raise an
89
     // In the Release configuration, React Native will (intentionally) raise an
90
-    // unhandled NSException for an unhandled JavaScript error. This will
90
+    // unhandled `NSException` for an unhandled JavaScript error. This will
91
     // effectively kill the application. In accord with the Web, do not kill the
91
     // effectively kill the application. In accord with the Web, do not kill the
92
     // application.
92
     // application.
93
     if (!RCTGetFatalHandler()) {
93
     if (!RCTGetFatalHandler()) {
98
 
98
 
99
 @interface JitsiMeetView() {
99
 @interface JitsiMeetView() {
100
     /**
100
     /**
101
-     * The unique identifier of this {@code JitsiMeetView} within the process
102
-     * for the purposes of {@link ExternalAPI}. The name scope was inspired by
103
-     * postis which we use on Web for the similar purposes of the iframe-based
104
-     * external API.
101
+     * The unique identifier of this `JitsiMeetView` within the process for the
102
+     * purposes of `ExternalAPI`. The name scope was inspired by postis which we
103
+     * use on Web for the similar purposes of the iframe-based external API.
105
      */
104
      */
106
     NSString *externalAPIScope;
105
     NSString *externalAPIScope;
107
 
106
 
115
 static RCTBridgeWrapper *bridgeWrapper;
114
 static RCTBridgeWrapper *bridgeWrapper;
116
 
115
 
117
 /**
116
 /**
118
- * Copy of the {@code launchOptions} dictionary that the application was started
119
- * with. It is required for the initial URL to be used if a (Universal) link was
120
- * used to launch a new instance of the application.
117
+ * Copy of the `launchOptions` dictionary that the application was started with.
118
+ * It is required for the initial URL to be used if a (Universal) link was used
119
+ * to launch a new instance of the application.
121
  */
120
  */
122
 static NSDictionary *_launchOptions;
121
 static NSDictionary *_launchOptions;
123
 
122
 
124
 /**
123
 /**
125
- * The {@code JitsiMeetView}s associated with their {@code ExternalAPI} scopes
126
- * (i.e. unique identifiers within the process).
124
+ * The `JitsiMeetView`s associated with their `ExternalAPI` scopes (i.e. unique
125
+ * identifiers within the process).
127
  */
126
  */
128
 static NSMapTable<NSString *, JitsiMeetView *> *views;
127
 static NSMapTable<NSString *, JitsiMeetView *> *views;
129
 
128
 
238
 #pragma mark API
237
 #pragma mark API
239
 
238
 
240
 /**
239
 /**
241
- * Loads a specific {@link NSURL} which may identify a conference to join. If
242
- * the specified {@code NSURL} is {@code nil} and the Welcome page is enabled,
243
- * the Welcome page is displayed instead.
240
+ * Loads a specific `NSURL` which may identify a conference to join. If the
241
+ * specified `NSURL` is `nil` and the Welcome page is enabled, the Welcome page
242
+ * is displayed instead.
244
  *
243
  *
245
- * @param url - The {@code NSURL} to load which may identify a conference to
246
- * join.
244
+ * @param url The `NSURL` to load which may identify a conference to join.
247
  */
245
  */
248
 - (void)loadURL:(NSURL *)url {
246
 - (void)loadURL:(NSURL *)url {
249
     [self loadURLString:url ? url.absoluteString : nil];
247
     [self loadURLString:url ? url.absoluteString : nil];
251
 
249
 
252
 /**
250
 /**
253
  * Loads a specific URL which may identify a conference to join. The URL is
251
  * Loads a specific URL which may identify a conference to join. The URL is
254
- * specified in the form of an {@link NSDictionary} of properties which (1)
255
- * internally are sufficient to construct a URL {@code NSString} while (2)
256
- * abstracting the specifics of constructing the URL away from API
257
- * clients/consumers. If the specified URL is {@code nil} and the Welcome page
258
- * is enabled, the Welcome page is displayed instead.
252
+ * specified in the form of an `NSDictionary` of properties which (1)
253
+ * internally are sufficient to construct a URL `NSString` while (2) abstracting
254
+ * the specifics of constructing the URL away from API clients/consumers. If the
255
+ * specified URL is `nil` and the Welcome page is enabled, the Welcome page is
256
+ * displayed instead.
259
  *
257
  *
260
- * @param urlObject - The URL to load which may identify a conference to join.
258
+ * @param urlObject The URL to load which may identify a conference to join.
261
  */
259
  */
262
 - (void)loadURLObject:(NSDictionary *)urlObject {
260
 - (void)loadURLObject:(NSDictionary *)urlObject {
263
     NSMutableDictionary *props = [[NSMutableDictionary alloc] init];
261
     NSMutableDictionary *props = [[NSMutableDictionary alloc] init];
303
 }
301
 }
304
 
302
 
305
 /**
303
 /**
306
- * Loads a specific URL {@link NSString} which may identify a conference to
307
- * join. If the specified URL {@code NSString} is {@code nil} and the Welcome
308
- * page is enabled, the Welcome page is displayed instead.
304
+ * Loads a specific URL `NSString` which may identify a conference to
305
+ * join. If the specified URL `NSString` is `nil` and the Welcome page is
306
+ * enabled, the Welcome page is displayed instead.
309
  *
307
  *
310
- * @param urlString - The URL {@code NSString} to load which may identify a
311
- * conference to join.
308
+ * @param urlString The URL `NSString` to load which may identify a conference
309
+ * to join.
312
  */
310
  */
313
 - (void)loadURLString:(NSString *)urlString {
311
 - (void)loadURLString:(NSString *)urlString {
314
     [self loadURLObject:urlString ? @{ @"url": urlString } : nil];
312
     [self loadURLObject:urlString ? @{ @"url": urlString } : nil];
317
 #pragma mark Private methods
315
 #pragma mark Private methods
318
 
316
 
319
 /**
317
 /**
320
- * Loads a specific {@link NSURL} in all existing {@code JitsiMeetView}s.
318
+ * Loads a specific `NSURL` in all existing `JitsiMeetView`s.
321
  *
319
  *
322
- * @param url - The {@code NSURL} to load in all existing
323
- * {@code JitsiMeetView}s.
324
- * @return {@code YES} if the specified {@code url} was submitted for loading in
325
- * at least one {@code JitsiMeetView}; otherwise, {@code NO}.
320
+ * @param url The `NSURL` to load in all existing `JitsiMeetView`s.
321
+ * @return `YES` if the specified `url` was submitted for loading in at least
322
+ * one `JitsiMeetView`; otherwise, `NO`.
326
  */
323
  */
327
 + (BOOL)loadURLInViews:(NSURL *)url {
324
 + (BOOL)loadURLInViews:(NSURL *)url {
328
     return
325
     return

+ 9
- 13
ios/sdk/src/JitsiMeetViewDelegate.h 查看文件

22
  * Called when a joining a conference was unsuccessful or when there was an
22
  * Called when a joining a conference was unsuccessful or when there was an
23
  * error while in a conference.
23
  * error while in a conference.
24
  *
24
  *
25
- * The {@code data} dictionary contains an "error" key describing the error and
26
- * a {@code url} key with the conference URL.
25
+ * The `data` dictionary contains an `error` key describing the error and a
26
+ * `url` key with the conference URL.
27
  */
27
  */
28
 - (void)conferenceFailed:(NSDictionary *)data;
28
 - (void)conferenceFailed:(NSDictionary *)data;
29
 
29
 
30
 /**
30
 /**
31
  * Called when a conference was joined.
31
  * Called when a conference was joined.
32
  *
32
  *
33
- * The {@code data} dictionary contains a {@code url} key with the conference
34
- * URL.
33
+ * The `data` dictionary contains a `url` key with the conference URL.
35
  */
34
  */
36
 - (void)conferenceJoined:(NSDictionary *)data;
35
 - (void)conferenceJoined:(NSDictionary *)data;
37
 
36
 
38
 /**
37
 /**
39
  * Called when a conference was left.
38
  * Called when a conference was left.
40
  *
39
  *
41
- * The {@code data} dictionary contains a {@code url} key with the conference
42
- * URL.
40
+ * The `data` dictionary contains a `url` key with the conference URL.
43
  */
41
  */
44
 - (void)conferenceLeft:(NSDictionary *)data;
42
 - (void)conferenceLeft:(NSDictionary *)data;
45
 
43
 
46
 /**
44
 /**
47
  * Called before a conference is joined.
45
  * Called before a conference is joined.
48
  *
46
  *
49
- * The {@code data} dictionary contains a {@code url} key with the conference
50
- * URL.
47
+ * The `data` dictionary contains a `url` key with the conference URL.
51
  */
48
  */
52
 - (void)conferenceWillJoin:(NSDictionary *)data;
49
 - (void)conferenceWillJoin:(NSDictionary *)data;
53
 
50
 
54
 /**
51
 /**
55
  * Called before a conference is left.
52
  * Called before a conference is left.
56
  *
53
  *
57
- * The {@code data} dictionary contains a {@code url} key with the conference
58
- * URL.
54
+ * The `data` dictionary contains a `url` key with the conference URL.
59
  */
55
  */
60
 - (void)conferenceWillLeave:(NSDictionary *)data;
56
 - (void)conferenceWillLeave:(NSDictionary *)data;
61
 
57
 
63
  * Called when loading the main configuration file from the Jitsi Meet
59
  * Called when loading the main configuration file from the Jitsi Meet
64
  * deployment file.
60
  * deployment file.
65
  *
61
  *
66
- * The {@code data} dictionary contains an {@code error} key with the error and
67
- * a {@code url} key with the conference URL which necessitated the loading of
68
- * the configuration file.
62
+ * The `data` dictionary contains an `error` key with the error and a `url` key
63
+ * with the conference URL which necessitated the loading of the configuration
64
+ * file.
69
  */
65
  */
70
 - (void)loadConfigError:(NSDictionary *)data;
66
 - (void)loadConfigError:(NSDictionary *)data;
71
 
67
 

+ 2
- 2
ios/sdk/src/Proximity.m 查看文件

30
  * proximity sensor automatically dims the screen and disables touch controls,
30
  * proximity sensor automatically dims the screen and disables touch controls,
31
  * so there is nothing else to do (unlike on Android)!
31
  * so there is nothing else to do (unlike on Android)!
32
  *
32
  *
33
- * @param enabled {@code YES} to enable proximity (sensor) monitoring;
34
- * {@code NO}, otherwise.
33
+ * @param enabled `YES` to enable proximity (sensor) monitoring; `NO`,
34
+ * otherwise.
35
  */
35
  */
36
 RCT_EXPORT_METHOD(setEnabled:(BOOL)enabled) {
36
 RCT_EXPORT_METHOD(setEnabled:(BOOL)enabled) {
37
     [[UIDevice currentDevice] setProximityMonitoringEnabled:enabled];
37
     [[UIDevice currentDevice] setProximityMonitoringEnabled:enabled];

+ 1
- 1
ios/sdk/src/RCTBridgeWrapper.h 查看文件

20
 #import <React/RCTBridgeDelegate.h>
20
 #import <React/RCTBridgeDelegate.h>
21
 
21
 
22
 /**
22
 /**
23
- * A wrapper around the <tt>RCTBridge</tt> which implements the delegate methods
23
+ * A wrapper around the `RCTBridge` which implements the delegate methods
24
  * that allow us to serve the JS bundle from within the framework's resources
24
  * that allow us to serve the JS bundle from within the framework's resources
25
  * directory. This is the recommended way for those cases where the builtin API
25
  * directory. This is the recommended way for those cases where the builtin API
26
  * doesn't cut it, as is the case.
26
  * doesn't cut it, as is the case.

+ 1
- 1
react/features/app/actions.js 查看文件

50
 
50
 
51
     /**
51
     /**
52
      * Notifies that an attempt to load a configuration has completed. Due to
52
      * Notifies that an attempt to load a configuration has completed. Due to
53
-     * the asynchronous nature of the loading, the specified <tt>config</tt> may
53
+     * the asynchronous nature of the loading, the specified {@code config} may
54
      * or may not be required by the time the notification arrives.
54
      * or may not be required by the time the notification arrives.
55
      *
55
      *
56
      * @param {string|undefined} error - If the loading has failed, the error
56
      * @param {string|undefined} error - If the loading has failed, the error

+ 1
- 1
react/features/authentication/actionTypes.js 查看文件

31
 /**
31
 /**
32
  * The type of (redux) action which informs that the authentication and role
32
  * The type of (redux) action which informs that the authentication and role
33
  * upgrade process has finished either with success or with a specific error.
33
  * upgrade process has finished either with success or with a specific error.
34
- * If <tt>error</tt> is <tt>undefined</tt>, then the process succeeded;
34
+ * If {@code error} is {@code undefined}, then the process succeeded;
35
  * otherwise, it failed. Refer to
35
  * otherwise, it failed. Refer to
36
  * {@link JitsiConference#authenticateAndUpgradeRole} in lib-jitsi-meet for the
36
  * {@link JitsiConference#authenticateAndUpgradeRole} in lib-jitsi-meet for the
37
  * error details.
37
  * error details.

+ 1
- 1
react/features/authentication/actions.js 查看文件

129
  *
129
  *
130
  * @param {Object} thenableWithCancel - The process of authenticating and
130
  * @param {Object} thenableWithCancel - The process of authenticating and
131
  * upgrading the local participant's role.
131
  * upgrading the local participant's role.
132
- * @param {Object} progressOrError - If the value is a <tt>number</tt>, then the
132
+ * @param {Object} progressOrError - If the value is a {@code number}, then the
133
  * process of authenticating and upgrading the local participant's role has
133
  * process of authenticating and upgrading the local participant's role has
134
  * succeeded in one of its two/multiple steps; otherwise, it has failed with the
134
  * succeeded in one of its two/multiple steps; otherwise, it has failed with the
135
  * specified error. Refer to {@link JitsiConference#authenticateAndUpgradeRole}
135
  * specified error. Refer to {@link JitsiConference#authenticateAndUpgradeRole}

+ 2
- 2
react/features/authentication/components/WaitForOwnerDialog.native.js 查看文件

100
     }
100
     }
101
 
101
 
102
     /**
102
     /**
103
-     * Renders a specific <tt>string</tt> which may contain HTML.
103
+     * Renders a specific {@code string} which may contain HTML.
104
      *
104
      *
105
-     * @param {string} html - The <tt>string</tt> which may contain HTML to
105
+     * @param {string} html - The {@code string} which may contain HTML to
106
      * render.
106
      * render.
107
      * @returns {ReactElement[]|string}
107
      * @returns {ReactElement[]|string}
108
      */
108
      */

+ 8
- 8
react/features/authentication/components/styles.js 查看文件

1
 import { BoxModel, createStyleSheet } from '../../base/styles';
1
 import { BoxModel, createStyleSheet } from '../../base/styles';
2
 
2
 
3
 /**
3
 /**
4
- * The style common to <tt>LoginDialog</tt> and <tt>WaitForOwnerDialog</tt>.
4
+ * The style common to {@code LoginDialog} and {@code WaitForOwnerDialog}.
5
  */
5
  */
6
 const dialog = {
6
 const dialog = {
7
     marginBottom: BoxModel.margin,
7
     marginBottom: BoxModel.margin,
9
 };
9
 };
10
 
10
 
11
 /**
11
 /**
12
- * The style common to <tt>Text</tt> rendered by <tt>LoginDialog</tt> and
13
- * <tt>WaitForOwnerDialog</tt>.
12
+ * The style common to {@code Text} rendered by {@code LoginDialog} and
13
+ * {@code WaitForOwnerDialog}.
14
  */
14
  */
15
 const text = {
15
 const text = {
16
 };
16
 };
20
  */
20
  */
21
 export default createStyleSheet({
21
 export default createStyleSheet({
22
     /**
22
     /**
23
-     * The style of bold <tt>Text</tt> rendered by the <tt>Dialog</tt>s of the
23
+     * The style of bold {@code Text} rendered by the {@code Dialog}s of the
24
      * feature authentication.
24
      * feature authentication.
25
      */
25
      */
26
     boldDialogText: {
26
     boldDialogText: {
29
     },
29
     },
30
 
30
 
31
     /**
31
     /**
32
-     * The style of <tt>Text</tt> rendered by the <tt>Dialog</tt>s of the
32
+     * The style of {@code Text} rendered by the {@code Dialog}s of the
33
      * feature authentication.
33
      * feature authentication.
34
      */
34
      */
35
     dialogText: {
35
     dialogText: {
37
     },
37
     },
38
 
38
 
39
     /**
39
     /**
40
-     * The style of <tt>TextInput</tt> rendered by the <tt>Dialog</tt>s of the
40
+     * The style of {@code TextInput} rendered by the {@code Dialog}s of the
41
      * feature authentication.
41
      * feature authentication.
42
      */
42
      */
43
     dialogTextInput: {
43
     dialogTextInput: {
48
     },
48
     },
49
 
49
 
50
     /**
50
     /**
51
-     * The style of <tt>LoginDialog</tt>.
51
+     * The style of {@code LoginDialog}.
52
      */
52
      */
53
     loginDialog: {
53
     loginDialog: {
54
         ...dialog,
54
         ...dialog,
57
     },
57
     },
58
 
58
 
59
     /**
59
     /**
60
-     * The style of <tt>WaitForOwnerDialog</tt>.
60
+     * The style of {@code WaitForOwnerDialog}.
61
      */
61
      */
62
     waitForOwnerDialog: {
62
     waitForOwnerDialog: {
63
         ...dialog,
63
         ...dialog,

+ 1
- 1
react/features/base/config/functions.js 查看文件

83
 /* eslint-enable no-shadow */
83
 /* eslint-enable no-shadow */
84
 
84
 
85
 /**
85
 /**
86
- * Sends HTTP POST request to specified <tt>endpoint</tt>. In request the name
86
+ * Sends HTTP POST request to specified {@code endpoint}. In request the name
87
  * of the room is included in JSON format:
87
  * of the room is included in JSON format:
88
  * {
88
  * {
89
  *     "rooomName": "someroom12345"
89
  *     "rooomName": "someroom12345"

+ 2
- 2
react/features/base/connection/functions.js 查看文件

56
  * Converts a specific id to jid if it's not jid yet.
56
  * Converts a specific id to jid if it's not jid yet.
57
  *
57
  *
58
  * @param {string} id - User id or jid.
58
  * @param {string} id - User id or jid.
59
- * @param {Object} configHosts - The <tt>hosts</tt> part of the <tt>config</tt>
59
+ * @param {Object} configHosts - The {@code hosts} part of the {@code config}
60
  * object.
60
  * object.
61
  * @returns {string} A string in the form of a JID (i.e.
61
  * @returns {string} A string in the form of a JID (i.e.
62
- * <tt>user@server.com</tt>).
62
+ * {@code user@server.com}).
63
  */
63
  */
64
 export function toJid(id: string, { authdomain, domain }: Object): string {
64
 export function toJid(id: string, { authdomain, domain }: Object): string {
65
     return id.indexOf('@') >= 0 ? id : `${id}@${authdomain || domain}`;
65
     return id.indexOf('@') >= 0 ? id : `${id}@${authdomain || domain}`;

+ 8
- 8
react/features/base/dialog/actions.js 查看文件

6
 /**
6
 /**
7
  * Signals Dialog to close its dialog.
7
  * Signals Dialog to close its dialog.
8
  *
8
  *
9
- * @param {Object} [component] - The <tt>Dialog</tt> component to close/hide. If
10
- * <tt>undefined</tt>, closes/hides <tt>Dialog</tt> regardless of which
11
- * component it's rendering; otherwise, closes/hides <tt>Dialog</tt> only if
12
- * it's rendering the specified <tt>component</tt>.
9
+ * @param {Object} [component] - The {@code Dialog} component to close/hide. If
10
+ * {@code undefined}, closes/hides {@code Dialog} regardless of which
11
+ * component it's rendering; otherwise, closes/hides {@code Dialog} only if
12
+ * it's rendering the specified {@code component}.
13
  * @returns {{
13
  * @returns {{
14
  *     type: HIDE_DIALOG,
14
  *     type: HIDE_DIALOG,
15
  *     component: (React.Component | undefined)
15
  *     component: (React.Component | undefined)
26
  * Signals Dialog to open dialog.
26
  * Signals Dialog to open dialog.
27
  *
27
  *
28
  * @param {Object} component - The component to display as dialog.
28
  * @param {Object} component - The component to display as dialog.
29
- * @param {Object} [componentProps] - The React <tt>Component</tt> props of the
30
- * specified <tt>component</tt>.
29
+ * @param {Object} [componentProps] - The React {@code Component} props of the
30
+ * specified {@code component}.
31
  * @returns {{
31
  * @returns {{
32
  *     type: OPEN_DIALOG,
32
  *     type: OPEN_DIALOG,
33
  *     component: React.Component,
33
  *     component: React.Component,
48
  * dialog.
48
  * dialog.
49
  *
49
  *
50
  * @param {Object} component - The component to display as dialog.
50
  * @param {Object} component - The component to display as dialog.
51
- * @param {Object} [componentProps] - The React <tt>Component</tt> props of the
52
- * specified <tt>component</tt>.
51
+ * @param {Object} [componentProps] - The React {@code Component} props of the
52
+ * specified {@code component}.
53
  * @returns {Function}
53
  * @returns {Function}
54
  */
54
  */
55
 export function toggleDialog(component: Object, componentProps: ?Object) {
55
 export function toggleDialog(component: Object, componentProps: ?Object) {

+ 10
- 10
react/features/base/dialog/components/AbstractDialog.js 查看文件

9
  */
9
  */
10
 export default class AbstractDialog extends Component {
10
 export default class AbstractDialog extends Component {
11
     /**
11
     /**
12
-     * <tt>AbstractDialog</tt> React <tt>Component</tt>'s prop types.
12
+     * {@code AbstractDialog} React {@code Component}'s prop types.
13
      *
13
      *
14
      * @static
14
      * @static
15
      */
15
      */
17
         ...DIALOG_PROP_TYPES,
17
         ...DIALOG_PROP_TYPES,
18
 
18
 
19
         /**
19
         /**
20
-         * The React <tt>Component</tt> children of <tt>AbstractDialog</tt>
20
+         * The React {@code Component} children of {@code AbstractDialog}
21
          * which represents the dialog's body.
21
          * which represents the dialog's body.
22
          */
22
          */
23
         children: PropTypes.node,
23
         children: PropTypes.node,
29
     };
29
     };
30
 
30
 
31
     /**
31
     /**
32
-     * Initializes a new <tt>AbstractDialog</tt> instance.
32
+     * Initializes a new {@code AbstractDialog} instance.
33
      *
33
      *
34
-     * @param {Object} props - The read-only React <tt>Component</tt> props with
34
+     * @param {Object} props - The read-only React {@code Component} props with
35
      * which the new instance is to be initialized.
35
      * which the new instance is to be initialized.
36
      */
36
      */
37
     constructor(props) {
37
     constructor(props) {
82
     }
82
     }
83
 
83
 
84
     /**
84
     /**
85
-     * Submits this dialog. If the React <tt>Component</tt> prop
86
-     * <tt>onSubmit</tt> is defined, the function that is the value of the prop
87
-     * is invoked. If the function returns a <tt>thenable</tt>, then the
88
-     * resolution of the <tt>thenable</tt> is awaited. If the submission
85
+     * Submits this dialog. If the React {@code Component} prop
86
+     * {@code onSubmit} is defined, the function that is the value of the prop
87
+     * is invoked. If the function returns a {@code thenable}, then the
88
+     * resolution of the {@code thenable} is awaited. If the submission
89
      * completes successfully, a redux action will be dispatched to hide this
89
      * completes successfully, a redux action will be dispatched to hide this
90
      * dialog.
90
      * dialog.
91
      *
91
      *
126
     }
126
     }
127
 
127
 
128
     /**
128
     /**
129
-     * Notifies this <tt>AbstractDialog</tt> that it has been submitted
129
+     * Notifies this {@code AbstractDialog} that it has been submitted
130
      * successfully. Dispatches a redux action to hide this dialog after it has
130
      * successfully. Dispatches a redux action to hide this dialog after it has
131
      * been submitted.
131
      * been submitted.
132
      *
132
      *
140
     }
140
     }
141
 
141
 
142
     /**
142
     /**
143
-     * Notifies this <tt>AbstractDialog</tt> that its submission has failed.
143
+     * Notifies this {@code AbstractDialog} that its submission has failed.
144
      *
144
      *
145
      * @private
145
      * @private
146
      * @returns {void}
146
      * @returns {void}

+ 10
- 10
react/features/base/dialog/components/Dialog.native.js 查看文件

13
 
13
 
14
 /**
14
 /**
15
  * The value of the style property {@link _TAG_KEY} which identifies the
15
  * The value of the style property {@link _TAG_KEY} which identifies the
16
- * OK/submit button of <tt>Prompt</tt>.
16
+ * OK/submit button of {@code Prompt}.
17
  */
17
  */
18
 const _SUBMIT_TEXT_TAG_VALUE = '_SUBMIT_TEXT_TAG_VALUE';
18
 const _SUBMIT_TEXT_TAG_VALUE = '_SUBMIT_TEXT_TAG_VALUE';
19
 
19
 
20
 /**
20
 /**
21
- * The name of the style property which identifies ancestors of <tt>Prompt</tt>
21
+ * The name of the style property which identifies ancestors of {@code Prompt}
22
  * such as its OK/submit button for the purposes of workarounds implemented by
22
  * such as its OK/submit button for the purposes of workarounds implemented by
23
- * <tt>Dialog</tt>.
23
+ * {@code Dialog}.
24
  *
24
  *
25
  * XXX The value may trigger a react-native warning in the Debug configuration
25
  * XXX The value may trigger a react-native warning in the Debug configuration
26
  * but, unfortunately, I couldn't find a value that wouldn't.
26
  * but, unfortunately, I couldn't find a value that wouldn't.
28
 const _TAG_KEY = '_TAG_KEY';
28
 const _TAG_KEY = '_TAG_KEY';
29
 
29
 
30
 /**
30
 /**
31
- * Implements <tt>AbstractDialog</tt> on react-native using <tt>Prompt</tt>.
31
+ * Implements {@code AbstractDialog} on react-native using {@code Prompt}.
32
  */
32
  */
33
 class Dialog extends AbstractDialog {
33
 class Dialog extends AbstractDialog {
34
     /**
34
     /**
35
-     * <tt>AbstractDialog</tt>'s React <tt>Component</tt> prop types.
35
+     * {@code AbstractDialog}'s React {@code Component} prop types.
36
      *
36
      *
37
      * @static
37
      * @static
38
      */
38
      */
164
     }
164
     }
165
 
165
 
166
     /**
166
     /**
167
-     * Creates a deep clone of a specific <tt>ReactElement</tt> with the results
167
+     * Creates a deep clone of a specific {@code ReactElement} with the results
168
      * of calling a specific function on every node of a specific
168
      * of calling a specific function on every node of a specific
169
-     * <tt>ReactElement</tt> tree.
169
+     * {@code ReactElement} tree.
170
      *
170
      *
171
-     * @param {ReactElement} element - The <tt>ReactElement</tt> to clone and
172
-     * call the specified <tt>f</tt> on.
171
+     * @param {ReactElement} element - The {@code ReactElement} to clone and
172
+     * call the specified {@code f} on.
173
      * @param {Function} f - The function to call on every node of the
173
      * @param {Function} f - The function to call on every node of the
174
-     * <tt>ReactElement</tt> tree represented by the specified <tt>element</tt>.
174
+     * {@code ReactElement} tree represented by the specified {@code element}.
175
      * @private
175
      * @private
176
      * @returns {ReactElement}
176
      * @returns {ReactElement}
177
      */
177
      */

+ 1
- 1
react/features/base/dialog/components/DialogContainer.js 查看文件

42
 }
42
 }
43
 
43
 
44
 /**
44
 /**
45
- * Maps (parts of) the redux state to the associated <tt>DialogContainer</tt>'s
45
+ * Maps (parts of) the redux state to the associated {@code DialogContainer}'s
46
  * props.
46
  * props.
47
  *
47
  *
48
  * @param {Object} state - The redux state.
48
  * @param {Object} state - The redux state.

+ 3
- 3
react/features/base/dialog/components/styles.js 查看文件

1
 import { ColorPalette, createStyleSheet } from '../../styles';
1
 import { ColorPalette, createStyleSheet } from '../../styles';
2
 
2
 
3
 /**
3
 /**
4
- * The React <tt>Component</tt> styles of the feature base/dialog.
4
+ * The React {@code Component} styles of the feature base/dialog.
5
  */
5
  */
6
 export default createStyleSheet({
6
 export default createStyleSheet({
7
     /**
7
     /**
8
-     * The style of the <tt>Text</tt> in a <tt>Dialog</tt> button.
8
+     * The style of the {@code Text} in a {@code Dialog} button.
9
      */
9
      */
10
     buttonText: {
10
     buttonText: {
11
         color: ColorPalette.blue
11
         color: ColorPalette.blue
12
     },
12
     },
13
 
13
 
14
     /**
14
     /**
15
-     * The style of the <tt>Text</tt> in a <tt>Dialog</tt> button which is
15
+     * The style of the {@code Text} in a {@code Dialog} button which is
16
      * disabled.
16
      * disabled.
17
      */
17
      */
18
     disabledButtonText: {
18
     disabledButtonText: {

+ 4
- 4
react/features/base/dialog/functions.js 查看文件

3
 import { toState } from '../redux';
3
 import { toState } from '../redux';
4
 
4
 
5
 /**
5
 /**
6
- * Checks if a <tt>Dialog</tt> with a specific <tt>component</tt> is currently
6
+ * Checks if a {@code Dialog} with a specific {@code component} is currently
7
  * open.
7
  * open.
8
  *
8
  *
9
  * @param {Function|Object} stateful - The redux store, the redux
9
  * @param {Function|Object} stateful - The redux store, the redux
10
- * <tt>getState</tt> function, or the redux state itself.
11
- * @param {React.Component} component - The <tt>component</tt> of a
12
- * <tt>Dialog</tt> to be checked.
10
+ * {@code getState} function, or the redux state itself.
11
+ * @param {React.Component} component - The {@code component} of a
12
+ * {@code Dialog} to be checked.
13
  * @returns {boolean}
13
  * @returns {boolean}
14
  */
14
  */
15
 export function isDialogOpen(stateful: Function | Object, component: Object) {
15
 export function isDialogOpen(stateful: Function | Object, component: Object) {

+ 1
- 1
react/features/base/lib-jitsi-meet/native/RTCPeerConnection.js 查看文件

114
 /**
114
 /**
115
  * Adapts react-native-webrtc's {@link RTCPeerConnection#setRemoteDescription}
115
  * Adapts react-native-webrtc's {@link RTCPeerConnection#setRemoteDescription}
116
  * implementation which uses the deprecated, callback-based version to the
116
  * implementation which uses the deprecated, callback-based version to the
117
- * <tt>Promise</tt>-based version.
117
+ * {@code Promise}-based version.
118
  *
118
  *
119
  * @param {RTCSessionDescription} sessionDescription - The RTCSessionDescription
119
  * @param {RTCSessionDescription} sessionDescription - The RTCSessionDescription
120
  * which specifies the configuration of the remote end of the connection.
120
  * which specifies the configuration of the remote end of the connection.

+ 10
- 10
react/features/base/lib-jitsi-meet/native/Storage.js 查看文件

2
 
2
 
3
 /**
3
 /**
4
  * A Web Sorage API implementation used for polyfilling
4
  * A Web Sorage API implementation used for polyfilling
5
- * <tt>window.localStorage</tt> and/or <tt>window.sessionStorage</tt>.
5
+ * {@code window.localStorage} and/or {@code window.sessionStorage}.
6
  * <p>
6
  * <p>
7
  * The Web Storage API is synchronous whereas React Native's builtin generic
7
  * The Web Storage API is synchronous whereas React Native's builtin generic
8
- * storage API <tt>AsyncStorage</tt> is asynchronous so the implementation with
8
+ * storage API {@code AsyncStorage} is asynchronous so the implementation with
9
  * persistence is optimistic: it will first store the value locally in memory so
9
  * persistence is optimistic: it will first store the value locally in memory so
10
  * that results can be served synchronously and then persist the value
10
  * that results can be served synchronously and then persist the value
11
  * asynchronously. If an asynchronous operation produces an error, it's ignored.
11
  * asynchronously. If an asynchronous operation produces an error, it's ignored.
12
  */
12
  */
13
 export default class Storage {
13
 export default class Storage {
14
     /**
14
     /**
15
-     * Initializes a new <tt>Storage</tt> instance. Loads all previously
16
-     * persisted data items from React Native's <tt>AsyncStorage</tt> if
15
+     * Initializes a new {@code Storage} instance. Loads all previously
16
+     * persisted data items from React Native's {@code AsyncStorage} if
17
      * necessary.
17
      * necessary.
18
      *
18
      *
19
      * @param {string|undefined} keyPrefix - The prefix of the
19
      * @param {string|undefined} keyPrefix - The prefix of the
20
-     * <tt>AsyncStorage</tt> keys to be persisted by this storage.
20
+     * {@code AsyncStorage} keys to be persisted by this storage.
21
      */
21
      */
22
     constructor(keyPrefix) {
22
     constructor(keyPrefix) {
23
         /**
23
         /**
24
-         * The prefix of the <tt>AsyncStorage</tt> keys persisted by this
25
-         * storage. If <tt>undefined</tt>, then the data items stored in this
24
+         * The prefix of the {@code AsyncStorage} keys persisted by this
25
+         * storage. If {@code undefined}, then the data items stored in this
26
          * storage will not be persisted.
26
          * storage will not be persisted.
27
          *
27
          *
28
          * @private
28
          * @private
81
      * Returns the value associated with a specific key in this storage.
81
      * Returns the value associated with a specific key in this storage.
82
      *
82
      *
83
      * @param {string} key - The name of the key to retrieve the value of.
83
      * @param {string} key - The name of the key to retrieve the value of.
84
-     * @returns {string|null} The value associated with <tt>key</tt> or
85
-     * <tt>null</tt>.
84
+     * @returns {string|null} The value associated with {@code key} or
85
+     * {@code null}.
86
      */
86
      */
87
     getItem(key) {
87
     getItem(key) {
88
         return this.hasOwnProperty(key) ? this[key] : null;
88
         return this.hasOwnProperty(key) ? this[key] : null;
128
      * value. If the key exists already, updates its value.
128
      * value. If the key exists already, updates its value.
129
      *
129
      *
130
      * @param {string} key - The name of the key to add/update.
130
      * @param {string} key - The name of the key to add/update.
131
-     * @param {string} value - The value to associate with <tt>key</tt>.
131
+     * @param {string} value - The value to associate with {@code key}.
132
      * @returns {void}
132
      * @returns {void}
133
      */
133
      */
134
     setItem(key, value) {
134
     setItem(key, value) {

+ 3
- 3
react/features/base/media/functions.js 查看文件

18
 
18
 
19
 /**
19
 /**
20
  * Determines whether video is currently muted by a specific
20
  * Determines whether video is currently muted by a specific
21
- * <tt>VIDEO_MUTISM_AUTHORITY</tt>.
21
+ * {@code VIDEO_MUTISM_AUTHORITY}.
22
  *
22
  *
23
  * @param {Function|Object} stateful - The redux store, state, or
23
  * @param {Function|Object} stateful - The redux store, state, or
24
  * {@code getState} function.
24
  * {@code getState} function.
25
- * @param {number} videoMutismAuthority - The <tt>VIDEO_MUTISM_AUTHORITY</tt>
25
+ * @param {number} videoMutismAuthority - The {@code VIDEO_MUTISM_AUTHORITY}
26
  * which is to be checked whether it has muted video.
26
  * which is to be checked whether it has muted video.
27
  * @returns {boolean} If video is currently muted by the specified
27
  * @returns {boolean} If video is currently muted by the specified
28
- * <tt>videoMutismAuthority</tt>, then <tt>true</tt>; otherwise, <tt>false</tt>.
28
+ * {@code videoMutismAuthority}, then {@code true}; otherwise, {@code false}.
29
  */
29
  */
30
 function _isVideoMutedByAuthority(
30
 function _isVideoMutedByAuthority(
31
         stateful: Function | Object,
31
         stateful: Function | Object,

+ 5
- 5
react/features/base/participants/components/Avatar.native.js 查看文件

11
  * specified one fails to load.
11
  * specified one fails to load.
12
  *
12
  *
13
  * XXX The relative path to the default/stock (image) file is defined by the
13
  * XXX The relative path to the default/stock (image) file is defined by the
14
- * <tt>const</tt> <tt>DEFAULT_AVATAR_RELATIVE_PATH</tt>. Unfortunately, the
14
+ * {@code const} {@code DEFAULT_AVATAR_RELATIVE_PATH}. Unfortunately, the
15
  * packager of React Native cannot deal with it early enough for the following
15
  * packager of React Native cannot deal with it early enough for the following
16
- * <tt>require</tt> to succeed at runtime. Anyway, be sure to synchronize the
16
+ * {@code require} to succeed at runtime. Anyway, be sure to synchronize the
17
  * relative path on Web and mobile for the purposes of consistency.
17
  * relative path on Web and mobile for the purposes of consistency.
18
  *
18
  *
19
  * @private
19
  * @private
146
     }
146
     }
147
 
147
 
148
     /**
148
     /**
149
-     * Notifies this <tt>Component</tt> that it will be unmounted and destroyed
149
+     * Notifies this {@code Component} that it will be unmounted and destroyed
150
      * and, most importantly, that it should no longer call
150
      * and, most importantly, that it should no longer call
151
-     * {@link #setState(Object)}. <tt>Avatar</tt> needs it because it downloads
151
+     * {@link #setState(Object)}. {@code Avatar} needs it because it downloads
152
      * images via {@link ImageCache} which will asynchronously notify about
152
      * images via {@link ImageCache} which will asynchronously notify about
153
      * success.
153
      * success.
154
      *
154
      *
163
      * Computes a hash over the URI and returns a HSL background color. We use
163
      * Computes a hash over the URI and returns a HSL background color. We use
164
      * 75% as lightness, for nice pastel style colors.
164
      * 75% as lightness, for nice pastel style colors.
165
      *
165
      *
166
-     * @param {Object} props - The read-only React <tt>Component</tt> props from
166
+     * @param {Object} props - The read-only React {@code Component} props from
167
      * which the background color is to be generated.
167
      * which the background color is to be generated.
168
      * @private
168
      * @private
169
      * @returns {string} - The HSL CSS property.
169
      * @returns {string} - The HSL CSS property.

+ 1
- 1
react/features/base/participants/constants.js 查看文件

5
  * XXX (1) Web/React utilizes relativity on the Jitsi Meet deployment.
5
  * XXX (1) Web/React utilizes relativity on the Jitsi Meet deployment.
6
  * (2) Mobile/React Native utilizes relativity on the local file system at build
6
  * (2) Mobile/React Native utilizes relativity on the local file system at build
7
  * time. Unfortunately, the packager of React Native cannot deal with the
7
  * time. Unfortunately, the packager of React Native cannot deal with the
8
- * <tt>const</tt> early enough for <tt>require</tt> to succeed at runtime.
8
+ * {@code const} early enough for {@code require} to succeed at runtime.
9
  * Anyway, be sure to synchronize the relative path on Web and mobile for the
9
  * Anyway, be sure to synchronize the relative path on Web and mobile for the
10
  * purposes of consistency.
10
  * purposes of consistency.
11
  *
11
  *

+ 2
- 2
react/features/base/participants/reducer.js 查看文件

25
  * @property {boolean} pinned - If true, participant is currently a
25
  * @property {boolean} pinned - If true, participant is currently a
26
  * "PINNED_ENDPOINT".
26
  * "PINNED_ENDPOINT".
27
  * @property {boolean} dominantSpeaker - If this participant is the dominant
27
  * @property {boolean} dominantSpeaker - If this participant is the dominant
28
- * speaker in the (associated) conference, <tt>true</tt>; otherwise,
29
- * <tt>false</tt>.
28
+ * speaker in the (associated) conference, {@code true}; otherwise,
29
+ * {@code false}.
30
  * @property {string} email - Participant email.
30
  * @property {string} email - Participant email.
31
  */
31
  */
32
 
32
 

+ 1
- 1
react/features/base/react/components/web/Watermarks.js 查看文件

8
 declare var interfaceConfig: Object;
8
 declare var interfaceConfig: Object;
9
 
9
 
10
 /**
10
 /**
11
- * The CSS style of the element with CSS class <tt>rightwatermark</tt>.
11
+ * The CSS style of the element with CSS class {@code rightwatermark}.
12
  *
12
  *
13
  * @private
13
  * @private
14
  */
14
  */

+ 27
- 27
react/features/base/redux/functions.js 查看文件

40
 
40
 
41
 /**
41
 /**
42
  * Sets a specific property of a specific state to a specific value. Prevents
42
  * Sets a specific property of a specific state to a specific value. Prevents
43
- * unnecessary state changes (when the specified <tt>value</tt> is equal to the
44
- * value of the specified <tt>property</tt> of the specified <tt>state</tt>).
43
+ * unnecessary state changes (when the specified {@code value} is equal to the
44
+ * value of the specified {@code property} of the specified {@code state}).
45
  *
45
  *
46
  * @param {Object} state - The (Redux) state from which a new state is to be
46
  * @param {Object} state - The (Redux) state from which a new state is to be
47
- * constructed by setting the specified <tt>property</tt> to the specified
48
- * <tt>value</tt>.
49
- * @param {string} property - The property of <tt>state</tt> which is to be
50
- * assigned the specified <tt>value</tt> (in the new state).
51
- * @param {*} value - The value to assign to the specified <tt>property</tt>.
52
- * @returns {Object} The specified <tt>state</tt> if the value of the specified
53
- * <tt>property</tt> equals the specified <tt>value/tt>; otherwise, a new state
54
- * constructed from the specified <tt>state</tt> by setting the specified
55
- * <tt>property</tt> to the specified <tt>value</tt>.
47
+ * constructed by setting the specified {@code property} to the specified
48
+ * {@code value}.
49
+ * @param {string} property - The property of {@code state} which is to be
50
+ * assigned the specified {@code value} (in the new state).
51
+ * @param {*} value - The value to assign to the specified {@code property}.
52
+ * @returns {Object} The specified {@code state} if the value of the specified
53
+ * {@code property} equals the specified <tt>value/tt>; otherwise, a new state
54
+ * constructed from the specified {@code state} by setting the specified
55
+ * {@code property} to the specified {@code value}.
56
  */
56
  */
57
 export function set(state: Object, property: string, value: any) {
57
 export function set(state: Object, property: string, value: any) {
58
     return _set(state, property, value, /* copyOnWrite */ true);
58
     return _set(state, property, value, /* copyOnWrite */ true);
62
 
62
 
63
 /**
63
 /**
64
  * Sets a specific property of a specific state to a specific value. Prevents
64
  * Sets a specific property of a specific state to a specific value. Prevents
65
- * unnecessary state changes (when the specified <tt>value</tt> is equal to the
66
- * value of the specified <tt>property</tt> of the specified <tt>state</tt>).
65
+ * unnecessary state changes (when the specified {@code value} is equal to the
66
+ * value of the specified {@code property} of the specified {@code state}).
67
  *
67
  *
68
  * @param {Object} state - The (Redux) state from which a state is to be
68
  * @param {Object} state - The (Redux) state from which a state is to be
69
- * constructed by setting the specified <tt>property</tt> to the specified
70
- * <tt>value</tt>.
71
- * @param {string} property - The property of <tt>state</tt> which is to be
72
- * assigned the specified <tt>value</tt>.
73
- * @param {*} value - The value to assign to the specified <tt>property</tt>.
74
- * @param {boolean} copyOnWrite - If the specified <tt>state</tt> is to not be
75
- * modified, <tt>true</tt>; otherwise, <tt>false</tt>.
76
- * @returns {Object} The specified <tt>state</tt> if the value of the specified
77
- * <tt>property</tt> equals the specified <tt>value/tt> or <tt>copyOnWrite</tt>
69
+ * constructed by setting the specified {@code property} to the specified
70
+ * {@code value}.
71
+ * @param {string} property - The property of {@code state} which is to be
72
+ * assigned the specified {@code value}.
73
+ * @param {*} value - The value to assign to the specified {@code property}.
74
+ * @param {boolean} copyOnWrite - If the specified {@code state} is to not be
75
+ * modified, {@code true}; otherwise, {@code false}.
76
+ * @returns {Object} The specified {@code state} if the value of the specified
77
+ * {@code property} equals the specified <tt>value/tt> or {@code copyOnWrite}
78
  * is truthy; otherwise, a new state constructed from the specified
78
  * is truthy; otherwise, a new state constructed from the specified
79
- * <tt>state</tt> by setting the specified <tt>property</tt> to the specified
80
- * <tt>value</tt>.
79
+ * {@code state} by setting the specified {@code property} to the specified
80
+ * {@code value}.
81
  */
81
  */
82
 function _set(
82
 function _set(
83
         state: Object,
83
         state: Object,
112
 /* eslint-enable max-params */
112
 /* eslint-enable max-params */
113
 
113
 
114
 /**
114
 /**
115
- * Returns redux state from the specified <tt>stateful</tt> which is presumed to
115
+ * Returns redux state from the specified {@code stateful} which is presumed to
116
  * be related to the redux state (e.g. the redux store, the redux
116
  * be related to the redux state (e.g. the redux store, the redux
117
- * <tt>getState</tt> function).
117
+ * {@code getState} function).
118
  *
118
  *
119
  * @param {Function|Object} stateful - The entity such as the redux store or the
119
  * @param {Function|Object} stateful - The entity such as the redux store or the
120
- * redux <tt>getState</tt> function from which the redux state is to be
120
+ * redux {@code getState} function from which the redux state is to be
121
  * returned.
121
  * returned.
122
  * @returns {Object} The redux state.
122
  * @returns {Object} The redux state.
123
  */
123
  */

+ 11
- 11
react/features/base/tracks/actions.js 查看文件

329
 }
329
 }
330
 
330
 
331
 /**
331
 /**
332
- * Finds the first <tt>JitsiLocalTrack</tt> in a specific array/list of
333
- * <tt>JitsiTrack</tt>s which is of a specific <tt>MEDIA_TYPE</tt>.
332
+ * Finds the first {@code JitsiLocalTrack} in a specific array/list of
333
+ * {@code JitsiTrack}s which is of a specific {@code MEDIA_TYPE}.
334
  *
334
  *
335
- * @param {JitsiTrack[]} tracks - The array/list of <tt>JitsiTrack</tt>s to look
335
+ * @param {JitsiTrack[]} tracks - The array/list of {@code JitsiTrack}s to look
336
  * through.
336
  * through.
337
- * @param {MEDIA_TYPE} mediaType - The <tt>MEDIA_TYPE</tt> of the first
338
- * <tt>JitsiLocalTrack</tt> to be returned.
337
+ * @param {MEDIA_TYPE} mediaType - The {@code MEDIA_TYPE} of the first
338
+ * {@code JitsiLocalTrack} to be returned.
339
  * @private
339
  * @private
340
- * @returns {JitsiLocalTrack} The first <tt>JitsiLocalTrack</tt>, if any, in the
341
- * specified <tt>tracks</tt> of the specified <tt>mediaType</tt>.
340
+ * @returns {JitsiLocalTrack} The first {@code JitsiLocalTrack}, if any, in the
341
+ * specified {@code tracks} of the specified {@code mediaType}.
342
  */
342
  */
343
 function _getLocalTrack(tracks, mediaType) {
343
 function _getLocalTrack(tracks, mediaType) {
344
     return tracks.find(track =>
344
     return tracks.find(track =>
384
 }
384
 }
385
 
385
 
386
 /**
386
 /**
387
- * Implements the <tt>Promise</tt> rejection handler of
388
- * <tt>createLocalTracksA</tt> and <tt>createLocalTracksF</tt>.
387
+ * Implements the {@code Promise} rejection handler of
388
+ * {@code createLocalTracksA} and {@code createLocalTracksF}.
389
  *
389
  *
390
- * @param {Object} reason - The <tt>Promise</tt> rejection reason.
391
- * @param {string} device - The device/<tt>MEDIA_TYPE</tt> associated with the
390
+ * @param {Object} reason - The {@code Promise} rejection reason.
391
+ * @param {string} device - The device/{@code MEDIA_TYPE} associated with the
392
  * rejection.
392
  * rejection.
393
  * @private
393
  * @private
394
  * @returns {Function}
394
  * @returns {Function}

+ 6
- 6
react/features/base/tracks/functions.js 查看文件

172
 }
172
 }
173
 
173
 
174
 /**
174
 /**
175
- * Mutes or unmutes a specific <tt>JitsiLocalTrack</tt>. If the muted state of
176
- * the specified <tt>track</tt> is already in accord with the specified
177
- * <tt>muted</tt> value, then does nothing.
175
+ * Mutes or unmutes a specific {@code JitsiLocalTrack}. If the muted state of
176
+ * the specified {@code track} is already in accord with the specified
177
+ * {@code muted} value, then does nothing.
178
  *
178
  *
179
- * @param {JitsiLocalTrack} track - The <tt>JitsiLocalTrack</tt> to mute or
179
+ * @param {JitsiLocalTrack} track - The {@code JitsiLocalTrack} to mute or
180
  * unmute.
180
  * unmute.
181
- * @param {boolean} muted - If the specified <tt>track</tt> is to be muted, then
182
- * <tt>true</tt>; otherwise, <tt>false</tt>.
181
+ * @param {boolean} muted - If the specified {@code track} is to be muted, then
182
+ * {@code true}; otherwise, {@code false}.
183
  * @returns {Promise}
183
  * @returns {Promise}
184
  */
184
  */
185
 export function setTrackMuted(track, muted) {
185
 export function setTrackMuted(track, muted) {

+ 6
- 6
react/features/base/tracks/middleware.js 查看文件

128
 });
128
 });
129
 
129
 
130
 /**
130
 /**
131
- * Gets the local track associated with a specific <tt>MEDIA_TYPE</tt> in a
131
+ * Gets the local track associated with a specific {@code MEDIA_TYPE} in a
132
  * specific redux store.
132
  * specific redux store.
133
  *
133
  *
134
  * @param {Store} store - The redux store from which the local track associated
134
  * @param {Store} store - The redux store from which the local track associated
135
- * with the specified <tt>mediaType</tt> is to be retrieved.
136
- * @param {MEDIA_TYPE} mediaType - The <tt>MEDIA_TYPE</tt> of the local track to
137
- * be retrieved from the specified <tt>store</tt>.
135
+ * with the specified {@code mediaType} is to be retrieved.
136
+ * @param {MEDIA_TYPE} mediaType - The {@code MEDIA_TYPE} of the local track to
137
+ * be retrieved from the specified {@code store}.
138
  * @private
138
  * @private
139
- * @returns {Track} The local <tt>Track</tt> associated with the specified
140
- * <tt>mediaType</tt> in the specified <tt>store</tt>.
139
+ * @returns {Track} The local {@code Track} associated with the specified
140
+ * {@code mediaType} in the specified {@code store}.
141
  */
141
  */
142
 function _getLocalTrack({ getState }, mediaType: MEDIA_TYPE) {
142
 function _getLocalTrack({ getState }, mediaType: MEDIA_TYPE) {
143
     return getLocalTrack(getState()['features/base/tracks'], mediaType);
143
     return getLocalTrack(getState()['features/base/tracks'], mediaType);

+ 1
- 1
react/features/base/util/loadScript.native.js 查看文件

1
 /**
1
 /**
2
  * Loads a script from a specific URL. React Native cannot load a JS
2
  * Loads a script from a specific URL. React Native cannot load a JS
3
  * file/resource/URL via a <script> HTML element, so the implementation
3
  * file/resource/URL via a <script> HTML element, so the implementation
4
- * fetches the specified <tt>url</tt> as plain text using {@link fetch()} and
4
+ * fetches the specified {@code url} as plain text using {@link fetch()} and
5
  * then evaluates the fetched string as JavaScript code (using {@link eval()}).
5
  * then evaluates the fetched string as JavaScript code (using {@link eval()}).
6
  *
6
  *
7
  * @param {string} url - The absolute URL from which the script is to be
7
  * @param {string} url - The absolute URL from which the script is to be

+ 8
- 8
react/features/conference/components/Conference.native.js 查看文件

61
 
61
 
62
         /**
62
         /**
63
          * Handles a hardware button press for back navigation. Leaves the
63
          * Handles a hardware button press for back navigation. Leaves the
64
-         * associated <tt>Conference</tt>.
64
+         * associated {@code Conference}.
65
          *
65
          *
66
          * @private
66
          * @private
67
          * @returns {boolean} As the associated conference is unconditionally
67
          * @returns {boolean} As the associated conference is unconditionally
68
-         * left and exiting the app while it renders a <tt>Conference</tt> is
69
-         * undesired, <tt>true</tt> is always returned.
68
+         * left and exiting the app while it renders a {@code Conference} is
69
+         * undesired, {@code true} is always returned.
70
          */
70
          */
71
         _onHardwareBackPress: PropTypes.func,
71
         _onHardwareBackPress: PropTypes.func,
72
 
72
 
253
      * Handles a hardware button press for back navigation.
253
      * Handles a hardware button press for back navigation.
254
      *
254
      *
255
      * @returns {boolean} If the hardware button press for back navigation was
255
      * @returns {boolean} If the hardware button press for back navigation was
256
-     * handled by this <tt>Conference</tt>, then <tt>true</tt>; otherwise,
257
-     * <tt>false</tt>.
256
+     * handled by this {@code Conference}, then {@code true}; otherwise,
257
+     * {@code false}.
258
      */
258
      */
259
     _onHardwareBackPress() {
259
     _onHardwareBackPress() {
260
         return this._backHandler && this.props._onHardwareBackPress();
260
         return this._backHandler && this.props._onHardwareBackPress();
314
 
314
 
315
         /**
315
         /**
316
          * Handles a hardware button press for back navigation. Leaves the
316
          * Handles a hardware button press for back navigation. Leaves the
317
-         * associated <tt>Conference</tt>.
317
+         * associated {@code Conference}.
318
          *
318
          *
319
          * @returns {boolean} As the associated conference is unconditionally
319
          * @returns {boolean} As the associated conference is unconditionally
320
-         * left and exiting the app while it renders a <tt>Conference</tt> is
321
-         * undesired, <tt>true</tt> is always returned.
320
+         * left and exiting the app while it renders a {@code Conference} is
321
+         * undesired, {@code true} is always returned.
322
          */
322
          */
323
         _onHardwareBackPress() {
323
         _onHardwareBackPress() {
324
             dispatch(appNavigate(undefined));
324
             dispatch(appNavigate(undefined));

+ 3
- 3
react/features/filmstrip/components/Filmstrip.native.js 查看文件

73
     }
73
     }
74
 
74
 
75
     /**
75
     /**
76
-     * Sorts a specific array of <tt>Participant</tt>s in display order.
76
+     * Sorts a specific array of {@code Participant}s in display order.
77
      *
77
      *
78
-     * @param {Participant[]} participants - The array of <tt>Participant</tt>s
78
+     * @param {Participant[]} participants - The array of {@code Participant}s
79
      * to sort in display order.
79
      * to sort in display order.
80
      * @private
80
      * @private
81
      * @returns {Participant[]} A new array containing the elements of the
81
      * @returns {Participant[]} A new array containing the elements of the
82
-     * specified <tt>participants</tt> array sorted in display order.
82
+     * specified {@code participants} array sorted in display order.
83
      */
83
      */
84
     _sort(participants) {
84
     _sort(participants) {
85
         // XXX Array.prototype.sort() is not appropriate because (1) it operates
85
         // XXX Array.prototype.sort() is not appropriate because (1) it operates

+ 2
- 2
react/features/large-video/actions.js 查看文件

107
 
107
 
108
 /**
108
 /**
109
  * Returns the identifier of the participant who is to be on the stage i.e.
109
  * Returns the identifier of the participant who is to be on the stage i.e.
110
- * should be displayed in <tt>LargeVideo</tt>.
110
+ * should be displayed in {@code LargeVideo}.
111
  *
111
  *
112
  * @param {Object} state - The Redux state from which the participant to be
112
  * @param {Object} state - The Redux state from which the participant to be
113
- * displayed in <tt>LargeVideo</tt> is to be elected.
113
+ * displayed in {@code LargeVideo} is to be elected.
114
  * @private
114
  * @private
115
  * @returns {(string|undefined)}
115
  * @returns {(string|undefined)}
116
  */
116
  */

+ 44
- 44
react/features/mobile/callkit/middleware.js 查看文件

68
 
68
 
69
 /**
69
 /**
70
  * Notifies the feature jwt that the action {@link APP_WILL_MOUNT} is being
70
  * Notifies the feature jwt that the action {@link APP_WILL_MOUNT} is being
71
- * dispatched within a specific redux <tt>store</tt>.
71
+ * dispatched within a specific redux {@code store}.
72
  *
72
  *
73
- * @param {Store} store - The redux store in which the specified <tt>action</tt>
73
+ * @param {Store} store - The redux store in which the specified {@code action}
74
  * is being dispatched.
74
  * is being dispatched.
75
  * @param {Dispatch} next - The redux dispatch function to dispatch the
75
  * @param {Dispatch} next - The redux dispatch function to dispatch the
76
- * specified <tt>action</tt> to the specified <tt>store</tt>.
77
- * @param {Action} action - The redux action <tt>APP_WILL_MOUNT</tt> which is
78
- * being dispatched in the specified <tt>store</tt>.
76
+ * specified {@code action} to the specified {@code store}.
77
+ * @param {Action} action - The redux action {@code APP_WILL_MOUNT} which is
78
+ * being dispatched in the specified {@code store}.
79
  * @private
79
  * @private
80
  * @returns {*}
80
  * @returns {*}
81
  */
81
  */
120
 
120
 
121
 /**
121
 /**
122
  * Notifies the feature jwt that the action {@link CONFERENCE_FAILED} is being
122
  * Notifies the feature jwt that the action {@link CONFERENCE_FAILED} is being
123
- * dispatched within a specific redux <tt>store</tt>.
123
+ * dispatched within a specific redux {@code store}.
124
  *
124
  *
125
- * @param {Store} store - The redux store in which the specified <tt>action</tt>
125
+ * @param {Store} store - The redux store in which the specified {@code action}
126
  * is being dispatched.
126
  * is being dispatched.
127
  * @param {Dispatch} next - The redux dispatch function to dispatch the
127
  * @param {Dispatch} next - The redux dispatch function to dispatch the
128
- * specified <tt>action</tt> to the specified <tt>store</tt>.
129
- * @param {Action} action - The redux action <tt>CONFERENCE_FAILED</tt> which is
130
- * being dispatched in the specified <tt>store</tt>.
128
+ * specified {@code action} to the specified {@code store}.
129
+ * @param {Action} action - The redux action {@code CONFERENCE_FAILED} which is
130
+ * being dispatched in the specified {@code store}.
131
  * @private
131
  * @private
132
  * @returns {*}
132
  * @returns {*}
133
  */
133
  */
145
 
145
 
146
 /**
146
 /**
147
  * Notifies the feature jwt that the action {@link CONFERENCE_JOINED} is being
147
  * Notifies the feature jwt that the action {@link CONFERENCE_JOINED} is being
148
- * dispatched within a specific redux <tt>store</tt>.
148
+ * dispatched within a specific redux {@code store}.
149
  *
149
  *
150
- * @param {Store} store - The redux store in which the specified <tt>action</tt>
150
+ * @param {Store} store - The redux store in which the specified {@code action}
151
  * is being dispatched.
151
  * is being dispatched.
152
  * @param {Dispatch} next - The redux dispatch function to dispatch the
152
  * @param {Dispatch} next - The redux dispatch function to dispatch the
153
- * specified <tt>action</tt> to the specified <tt>store</tt>.
154
- * @param {Action} action - The redux action <tt>CONFERENCE_JOINED</tt> which is
155
- * being dispatched in the specified <tt>store</tt>.
153
+ * specified {@code action} to the specified {@code store}.
154
+ * @param {Action} action - The redux action {@code CONFERENCE_JOINED} which is
155
+ * being dispatched in the specified {@code store}.
156
  * @private
156
  * @private
157
  * @returns {*}
157
  * @returns {*}
158
  */
158
  */
170
 
170
 
171
 /**
171
 /**
172
  * Notifies the feature jwt that the action {@link CONFERENCE_LEFT} is being
172
  * Notifies the feature jwt that the action {@link CONFERENCE_LEFT} is being
173
- * dispatched within a specific redux <tt>store</tt>.
173
+ * dispatched within a specific redux {@code store}.
174
  *
174
  *
175
- * @param {Store} store - The redux store in which the specified <tt>action</tt>
175
+ * @param {Store} store - The redux store in which the specified {@code action}
176
  * is being dispatched.
176
  * is being dispatched.
177
  * @param {Dispatch} next - The redux dispatch function to dispatch the
177
  * @param {Dispatch} next - The redux dispatch function to dispatch the
178
- * specified <tt>action</tt> to the specified <tt>store</tt>.
179
- * @param {Action} action - The redux action <tt>CONFERENCE_LEFT</tt> which is
180
- * being dispatched in the specified <tt>store</tt>.
178
+ * specified {@code action} to the specified {@code store}.
179
+ * @param {Action} action - The redux action {@code CONFERENCE_LEFT} which is
180
+ * being dispatched in the specified {@code store}.
181
  * @private
181
  * @private
182
  * @returns {*}
182
  * @returns {*}
183
  */
183
  */
195
 
195
 
196
 /**
196
 /**
197
  * Notifies the feature jwt that the action {@link CONFERENCE_WILL_JOIN} is
197
  * Notifies the feature jwt that the action {@link CONFERENCE_WILL_JOIN} is
198
- * being dispatched within a specific redux <tt>store</tt>.
198
+ * being dispatched within a specific redux {@code store}.
199
  *
199
  *
200
- * @param {Store} store - The redux store in which the specified <tt>action</tt>
200
+ * @param {Store} store - The redux store in which the specified {@code action}
201
  * is being dispatched.
201
  * is being dispatched.
202
  * @param {Dispatch} next - The redux dispatch function to dispatch the
202
  * @param {Dispatch} next - The redux dispatch function to dispatch the
203
- * specified <tt>action</tt> to the specified <tt>store</tt>.
204
- * @param {Action} action - The redux action <tt>CONFERENCE_WILL_JOIN</tt> which
205
- * is being dispatched in the specified <tt>store</tt>.
203
+ * specified {@code action} to the specified {@code store}.
204
+ * @param {Action} action - The redux action {@code CONFERENCE_WILL_JOIN} which
205
+ * is being dispatched in the specified {@code store}.
206
  * @private
206
  * @private
207
  * @returns {*}
207
  * @returns {*}
208
  */
208
  */
227
 }
227
 }
228
 
228
 
229
 /**
229
 /**
230
- * Handles CallKit's event <tt>performEndCallAction</tt>.
230
+ * Handles CallKit's event {@code performEndCallAction}.
231
  *
231
  *
232
  * @param {Object} event - The details of the CallKit event
232
  * @param {Object} event - The details of the CallKit event
233
- * <tt>performEndCallAction</tt>.
233
+ * {@code performEndCallAction}.
234
  * @returns {void}
234
  * @returns {void}
235
  */
235
  */
236
 function _onPerformEndCallAction({ callUUID }) {
236
 function _onPerformEndCallAction({ callUUID }) {
247
 }
247
 }
248
 
248
 
249
 /**
249
 /**
250
- * Handles CallKit's event <tt>performSetMutedCallAction</tt>.
250
+ * Handles CallKit's event {@code performSetMutedCallAction}.
251
  *
251
  *
252
  * @param {Object} event - The details of the CallKit event
252
  * @param {Object} event - The details of the CallKit event
253
- * <tt>performSetMutedCallAction</tt>.
253
+ * {@code performSetMutedCallAction}.
254
  * @returns {void}
254
  * @returns {void}
255
  */
255
  */
256
 function _onPerformSetMutedCallAction({ callUUID, muted: newValue }) {
256
 function _onPerformSetMutedCallAction({ callUUID, muted: newValue }) {
271
 
271
 
272
 /**
272
 /**
273
  * Notifies the feature jwt that the action {@link SET_AUDIO_MUTED} is being
273
  * Notifies the feature jwt that the action {@link SET_AUDIO_MUTED} is being
274
- * dispatched within a specific redux <tt>store</tt>.
274
+ * dispatched within a specific redux {@code store}.
275
  *
275
  *
276
- * @param {Store} store - The redux store in which the specified <tt>action</tt>
276
+ * @param {Store} store - The redux store in which the specified {@code action}
277
  * is being dispatched.
277
  * is being dispatched.
278
  * @param {Dispatch} next - The redux dispatch function to dispatch the
278
  * @param {Dispatch} next - The redux dispatch function to dispatch the
279
- * specified <tt>action</tt> to the specified <tt>store</tt>.
280
- * @param {Action} action - The redux action <tt>SET_AUDIO_MUTED</tt> which is
281
- * being dispatched in the specified <tt>store</tt>.
279
+ * specified {@code action} to the specified {@code store}.
280
+ * @param {Action} action - The redux action {@code SET_AUDIO_MUTED} which is
281
+ * being dispatched in the specified {@code store}.
282
  * @private
282
  * @private
283
  * @returns {*}
283
  * @returns {*}
284
  */
284
  */
296
 
296
 
297
 /**
297
 /**
298
  * Notifies the feature jwt that the action {@link _SET_CALLKIT_SUBSCRIPTIONS}
298
  * Notifies the feature jwt that the action {@link _SET_CALLKIT_SUBSCRIPTIONS}
299
- * is being dispatched within a specific redux <tt>store</tt>.
299
+ * is being dispatched within a specific redux {@code store}.
300
  *
300
  *
301
- * @param {Store} store - The redux store in which the specified <tt>action</tt>
301
+ * @param {Store} store - The redux store in which the specified {@code action}
302
  * is being dispatched.
302
  * is being dispatched.
303
  * @param {Dispatch} next - The redux dispatch function to dispatch the
303
  * @param {Dispatch} next - The redux dispatch function to dispatch the
304
- * specified <tt>action</tt> to the specified <tt>store</tt>.
305
- * @param {Action} action - The redux action <tt>_SET_CALLKIT_SUBSCRIPTIONS</tt>
306
- * which is being dispatched in the specified <tt>store</tt>.
304
+ * specified {@code action} to the specified {@code store}.
305
+ * @param {Action} action - The redux action {@code _SET_CALLKIT_SUBSCRIPTIONS}
306
+ * which is being dispatched in the specified {@code store}.
307
  * @private
307
  * @private
308
  * @returns {*}
308
  * @returns {*}
309
  */
309
  */
321
 
321
 
322
 /**
322
 /**
323
  * Notifies the feature jwt that the action {@link SET_VIDEO_MUTED} is being
323
  * Notifies the feature jwt that the action {@link SET_VIDEO_MUTED} is being
324
- * dispatched within a specific redux <tt>store</tt>.
324
+ * dispatched within a specific redux {@code store}.
325
  *
325
  *
326
- * @param {Store} store - The redux store in which the specified <tt>action</tt>
326
+ * @param {Store} store - The redux store in which the specified {@code action}
327
  * is being dispatched.
327
  * is being dispatched.
328
  * @param {Dispatch} next - The redux dispatch function to dispatch the
328
  * @param {Dispatch} next - The redux dispatch function to dispatch the
329
- * specified <tt>action</tt> to the specified <tt>store</tt>.
330
- * @param {Action} action - The redux action <tt>SET_VIDEO_MUTED</tt> which is
331
- * being dispatched in the specified <tt>store</tt>.
329
+ * specified {@code action} to the specified {@code store}.
330
+ * @param {Action} action - The redux action {@code SET_VIDEO_MUTED} which is
331
+ * being dispatched in the specified {@code store}.
332
  * @private
332
  * @private
333
  * @returns {*}
333
  * @returns {*}
334
  */
334
  */

+ 3
- 3
react/features/mobile/external-api/middleware.js 查看文件

58
 });
58
 });
59
 
59
 
60
 /**
60
 /**
61
- * Gets the description of a specific <tt>Symbol</tt>.
61
+ * Gets the description of a specific {@code Symbol}.
62
  *
62
  *
63
- * @param {Symbol} symbol - The <tt>Symbol</tt> to retrieve the description of.
63
+ * @param {Symbol} symbol - The {@code Symbol} to retrieve the description of.
64
  * @private
64
  * @private
65
- * @returns {string} The description of <tt>symbol</tt>.
65
+ * @returns {string} The description of {@code symbol}.
66
  */
66
  */
67
 function _getSymbolDescription(symbol: Symbol) {
67
 function _getSymbolDescription(symbol: Symbol) {
68
     let description = symbol.toString();
68
     let description = symbol.toString();

+ 7
- 7
react/features/mobile/image-cache/functions.js 查看文件

1
 import { ImageCache } from './';
1
 import { ImageCache } from './';
2
 
2
 
3
 /**
3
 /**
4
- * Notifies about the successful download of an <tt>Image</tt> source. The name
5
- * is inspired by <tt>Image</tt>. The downloaded <tt>Image</tt> source is not
4
+ * Notifies about the successful download of an {@code Image} source. The name
5
+ * is inspired by {@code Image}. The downloaded {@code Image} source is not
6
  * available because (1) I do not know how to get it from {@link ImageCache} and
6
  * available because (1) I do not know how to get it from {@link ImageCache} and
7
  * (2) we do not need it bellow. The function was explicitly introduced to cut
7
  * (2) we do not need it bellow. The function was explicitly introduced to cut
8
- * down on unnecessary <tt>ImageCache</tt> <tt>observer</tt> instances.
8
+ * down on unnecessary {@code ImageCache} {@code observer} instances.
9
  *
9
  *
10
  * @private
10
  * @private
11
  * @returns {void}
11
  * @returns {void}
17
 }
17
 }
18
 
18
 
19
 /**
19
 /**
20
- * Initiates the retrieval of a specific <tt>Image</tt> source (if it has not
20
+ * Initiates the retrieval of a specific {@code Image} source (if it has not
21
  * been initiated already). Due to limitations of {@link ImageCache}, the source
21
  * been initiated already). Due to limitations of {@link ImageCache}, the source
22
- * may have at most one <tt>uri</tt>. The name is inspired by <tt>Image</tt>.
22
+ * may have at most one {@code uri}. The name is inspired by {@code Image}.
23
  *
23
  *
24
- * @param {Object} source - The <tt>Image</tt> source with preferably exactly
25
- * one <tt>uri</tt>.
24
+ * @param {Object} source - The {@code Image} source with preferably exactly
25
+ * one {@code uri}.
26
  * @public
26
  * @public
27
  * @returns {void}
27
  * @returns {void}
28
  */
28
  */

+ 1
- 1
react/features/mobile/image-cache/middleware.js 查看文件

18
  * The indicator which determines whether avatar URLs are to be prefetched in
18
  * The indicator which determines whether avatar URLs are to be prefetched in
19
  * the middleware here. Unless/until the implementation starts observing the
19
  * the middleware here. Unless/until the implementation starts observing the
20
  * redux store instead of the respective redux actions, the value should very
20
  * redux store instead of the respective redux actions, the value should very
21
- * likely be <tt>false</tt> because the middleware here is pretty much the last
21
+ * likely be {@code false} because the middleware here is pretty much the last
22
  * to get a chance to figure out that an avatar URL may be used. Besides, it is
22
  * to get a chance to figure out that an avatar URL may be used. Besides, it is
23
  * somewhat uninformed to download just about anything that may eventually be
23
  * somewhat uninformed to download just about anything that may eventually be
24
  * used or not.
24
  * used or not.

+ 4
- 4
react/features/mobile/network-activity/components/NetworkActivityIndicator.js 查看文件

7
 import { LoadingIndicator } from '../../../base/react';
7
 import { LoadingIndicator } from '../../../base/react';
8
 
8
 
9
 /**
9
 /**
10
- * The React <tt>Component</tt> which renders a progress indicator when there
10
+ * The React {@code Component} which renders a progress indicator when there
11
  * are ongoing network requests.
11
  * are ongoing network requests.
12
  */
12
  */
13
 class NetworkActivityIndicator extends Component {
13
 class NetworkActivityIndicator extends Component {
14
     /**
14
     /**
15
-     * <tt>NetworkActivityIndicator</tt> React <tt>Component</tt>'s prop types.
15
+     * {@code NetworkActivityIndicator} React {@code Component}'s prop types.
16
      *
16
      *
17
      * @static
17
      * @static
18
      */
18
      */
38
 }
38
 }
39
 
39
 
40
 /**
40
 /**
41
- * Maps (parts of) the redux state to the React <tt>Component</tt> props of
42
- * <tt>NetworkActivityIndicator</tt>.
41
+ * Maps (parts of) the redux state to the React {@code Component} props of
42
+ * {@code NetworkActivityIndicator}.
43
  *
43
  *
44
  * @param {Object} state - The redux state.
44
  * @param {Object} state - The redux state.
45
  * @private
45
  * @private

+ 1
- 1
react/features/overlay/reducer.js 查看文件

117
  * @param {Action} action - The redux action to reduce.
117
  * @param {Action} action - The redux action to reduce.
118
  * @private
118
  * @private
119
  * @returns {Object} The new state of the feature overlay after reducing the
119
  * @returns {Object} The new state of the feature overlay after reducing the
120
- * specified <tt>action</tt> in the feature overlay.
120
+ * specified {@code action} in the feature overlay.
121
  */
121
  */
122
 function _connectionWillConnect(
122
 function _connectionWillConnect(
123
         state,
123
         state,

+ 2
- 2
react/features/toolbox/middleware.js 查看文件

60
  * @param {Store} store - The redux store.
60
  * @param {Store} store - The redux store.
61
  * @param {Function} next - The redux function to continue dispatching the
61
  * @param {Function} next - The redux function to continue dispatching the
62
  * specified {@code action} in the specified {@code store}.
62
  * specified {@code action} in the specified {@code store}.
63
- * @param {Object} action - <tt>SET_AUDIO_AVAILABLE</tt>,
64
- * <tt>SET_VIDEO_AVAILABLE</tt>, or <tt>TRACK_UPDATED</tt>.
63
+ * @param {Object} action - {@code SET_AUDIO_AVAILABLE},
64
+ * {@code SET_VIDEO_AVAILABLE}, or {@code TRACK_UPDATED}.
65
  * @returns {*}
65
  * @returns {*}
66
  */
66
  */
67
 function _setMediaAvailableOrMuted({ dispatch, getState }, next, action) {
67
 function _setMediaAvailableOrMuted({ dispatch, getState }, next, action) {

+ 6
- 6
react/features/welcome/components/BlankPage.native.js 查看文件

12
 import styles from './styles';
12
 import styles from './styles';
13
 
13
 
14
 /**
14
 /**
15
- * The React <tt>Component</tt> displayed by <tt>AbstractApp</tt> when it has no
16
- * <tt>Route</tt> to render. Renders a progress indicator when there are ongoing
15
+ * The React {@code Component} displayed by {@code AbstractApp} when it has no
16
+ * {@code Route} to render. Renders a progress indicator when there are ongoing
17
  * network requests.
17
  * network requests.
18
  */
18
  */
19
 class BlankPage extends Component {
19
 class BlankPage extends Component {
20
     /**
20
     /**
21
-     * <tt>BlankPage</tt> React <tt>Component</tt>'s prop types.
21
+     * {@code BlankPage} React {@code Component}'s prop types.
22
      *
22
      *
23
      * @static
23
      * @static
24
      */
24
      */
25
     static propTypes = {
25
     static propTypes = {
26
         /**
26
         /**
27
-         * The indicator which determines whether <tt>WelcomePage</tt> is (to
27
+         * The indicator which determines whether {@code WelcomePage} is (to
28
          * be) rendered.
28
          * be) rendered.
29
          *
29
          *
30
          * @private
30
          * @private
62
 }
62
 }
63
 
63
 
64
 /**
64
 /**
65
- * Maps (parts of) the redux state to the React <tt>Component</tt> props of
66
- * <tt>BlankPage</tt>.
65
+ * Maps (parts of) the redux state to the React {@code Component} props of
66
+ * {@code BlankPage}.
67
  *
67
  *
68
  * @param {Object} state - The redux state.
68
  * @param {Object} state - The redux state.
69
  * @private
69
  * @private

+ 1
- 1
react/features/welcome/components/LocalVideoTrackUnderlay.native.js 查看文件

18
     state: {
18
     state: {
19
 
19
 
20
         /**
20
         /**
21
-         * The style of <tt>LocalVideoTrackUnderlay</tt> which is a combination
21
+         * The style of {@code LocalVideoTrackUnderlay} which is a combination
22
          * of its default style and the consumer-specified style.
22
          * of its default style and the consumer-specified style.
23
          */
23
          */
24
         style: Object
24
         style: Object

+ 1
- 1
react/features/welcome/components/WelcomePage.web.js 查看文件

85
     }
85
     }
86
 
86
 
87
     /**
87
     /**
88
-     * Handles <tt>change</tt> event of the checkbox which allows specifying
88
+     * Handles {@code change} event of the checkbox which allows specifying
89
      * whether the WelcomePage is disabled.
89
      * whether the WelcomePage is disabled.
90
      *
90
      *
91
      * @param {Event} event - The (HTML) Event which details the change such as
91
      * @param {Event} event - The (HTML) Event which details the change such as

+ 8
- 8
react/features/welcome/components/styles.js 查看文件

11
 const TEXT_COLOR = ColorPalette.white;
11
 const TEXT_COLOR = ColorPalette.white;
12
 
12
 
13
 /**
13
 /**
14
- * The styles of the React <tt>Components</tt> of the feature welcome including
15
- * <tt>WelcomePage</tt> and <tt>BlankPage</tt>.
14
+ * The styles of the React {@code Components} of the feature welcome including
15
+ * {@code WelcomePage} and {@code BlankPage}.
16
  */
16
  */
17
 export default createStyleSheet({
17
 export default createStyleSheet({
18
     /**
18
     /**
19
-     * The style of the top-level container of <tt>BlankPage</tt>.
19
+     * The style of the top-level container of {@code BlankPage}.
20
      */
20
      */
21
     blankPage: {
21
     blankPage: {
22
     },
22
     },
66
     },
66
     },
67
 
67
 
68
     /**
68
     /**
69
-     * The style of the <tt>View</tt> displayed over the local video by
70
-     * <tt>LocalVideoTrackUnderlay</tt>. The latter is thought of as the
69
+     * The style of the {@code View} displayed over the local video by
70
+     * {@code LocalVideoTrackUnderlay}. The latter is thought of as the
71
      * background (content). The former is thought of as the foreground
71
      * background (content). The former is thought of as the foreground
72
      * (content).
72
      * (content).
73
      */
73
      */
84
     },
84
     },
85
 
85
 
86
     /**
86
     /**
87
-     * The style of the top-level container/<tt>View</tt> of
88
-     * <tt>LocalVideoTrackUnderlay</tt>.
87
+     * The style of the top-level container/{@code View} of
88
+     * {@code LocalVideoTrackUnderlay}.
89
      */
89
      */
90
     localVideoTrackUnderlay: fixAndroidViewClipping({
90
     localVideoTrackUnderlay: fixAndroidViewClipping({
91
         alignSelf: 'stretch',
91
         alignSelf: 'stretch',
129
     },
129
     },
130
 
130
 
131
     /**
131
     /**
132
-     * The style of the top-level container of <tt>WelcomePage</tt>.
132
+     * The style of the top-level container of {@code WelcomePage}.
133
      */
133
      */
134
     welcomePage: {
134
     welcomePage: {
135
         backgroundColor: ColorPalette.blue
135
         backgroundColor: ColorPalette.blue

+ 6
- 6
react/features/welcome/functions.js 查看文件

8
 export * from './roomnameGenerator';
8
 export * from './roomnameGenerator';
9
 
9
 
10
 /**
10
 /**
11
- * Determines whether the <tt>WelcomePage</tt> is enabled by the app itself
11
+ * Determines whether the {@code WelcomePage} is enabled by the app itself
12
  * (e.g. programmatically via the Jitsi Meet SDK for Android and iOS). Not to be
12
  * (e.g. programmatically via the Jitsi Meet SDK for Android and iOS). Not to be
13
  * confused with {@link isWelcomePageUserEnabled}.
13
  * confused with {@link isWelcomePageUserEnabled}.
14
  *
14
  *
15
  * @param {Object|Function} stateOrGetState - The redux state or
15
  * @param {Object|Function} stateOrGetState - The redux state or
16
  * {@link getState} function.
16
  * {@link getState} function.
17
- * @returns {boolean} If the <tt>WelcomePage</tt> is enabled by the app, then
18
- * <tt>true</tt>; otherwise, <tt>false</tt>.
17
+ * @returns {boolean} If the {@code WelcomePage} is enabled by the app, then
18
+ * {@code true}; otherwise, {@code false}.
19
  */
19
  */
20
 export function isWelcomePageAppEnabled(stateOrGetState: Object | Function) {
20
 export function isWelcomePageAppEnabled(stateOrGetState: Object | Function) {
21
     let b;
21
     let b;
39
 }
39
 }
40
 
40
 
41
 /**
41
 /**
42
- * Determines whether the <tt>WelcomePage</tt> is enabled by the user either
42
+ * Determines whether the {@code WelcomePage} is enabled by the user either
43
  * herself or through her deployment config(uration). Not to be confused with
43
  * herself or through her deployment config(uration). Not to be confused with
44
  * {@link isWelcomePageAppEnabled}.
44
  * {@link isWelcomePageAppEnabled}.
45
  *
45
  *
46
  * @param {Object|Function} stateOrGetState - The redux state or
46
  * @param {Object|Function} stateOrGetState - The redux state or
47
  * {@link getState} function.
47
  * {@link getState} function.
48
- * @returns {boolean} If the <tt>WelcomePage</tt> is enabled by the user, then
49
- * <tt>true</tt>; otherwise, <tt>false</tt>.
48
+ * @returns {boolean} If the {@code WelcomePage} is enabled by the user, then
49
+ * {@code true}; otherwise, {@code false}.
50
  */
50
  */
51
 export function isWelcomePageUserEnabled(stateOrGetState: Object | Function) {
51
 export function isWelcomePageUserEnabled(stateOrGetState: Object | Function) {
52
     return (
52
     return (

+ 2
- 2
react/features/welcome/route.js 查看文件

10
 } from './functions';
10
 } from './functions';
11
 
11
 
12
 /**
12
 /**
13
- * Register route for <tt>WelcomePage</tt>.
13
+ * Register route for {@code WelcomePage}.
14
  */
14
  */
15
 RouteRegistry.register({
15
 RouteRegistry.register({
16
     component: WelcomePage,
16
     component: WelcomePage,
19
 });
19
 });
20
 
20
 
21
 /**
21
 /**
22
- * Skips the <tt>WelcomePage</tt> if it is disabled (by the app or the user).
22
+ * Skips the {@code WelcomePage} if it is disabled (by the app or the user).
23
  *
23
  *
24
  * @param {Object} store - The redux store.
24
  * @param {Object} store - The redux store.
25
  * @param {Function} replace - The function to redirect to another path.
25
  * @param {Function} replace - The function to redirect to another path.

Loading…
取消
儲存