瀏覽代碼

doc(XmppConnection): fill missing JS docs

master
paweldomas 5 年之前
父節點
當前提交
8c009ceeb8
共有 1 個文件被更改,包括 16 次插入16 次删除
  1. 16
    16
      modules/xmpp/XmppConnection.js

+ 16
- 16
modules/xmpp/XmppConnection.js 查看文件

@@ -9,7 +9,7 @@ import LastSuccessTracker from './StropheBoshLastSuccess';
9 9
 const logger = getLogger(__filename);
10 10
 
11 11
 /**
12
- * FIXME.
12
+ * The lib-jitsi-meet layer for {@link Strophe.Connection}.
13 13
  */
14 14
 export default class XmppConnection extends Listenable {
15 15
     /**
@@ -33,7 +33,7 @@ export default class XmppConnection extends Listenable {
33 33
     }
34 34
 
35 35
     /**
36
-     * FIXME.
36
+     * Initializes new connection instance.
37 37
      *
38 38
      * @param {Object} options
39 39
      * @param {String} options.serviceUrl - The BOSH or WebSocket service URL.
@@ -63,7 +63,7 @@ export default class XmppConnection extends Listenable {
63 63
     }
64 64
 
65 65
     /**
66
-     * FIXME.
66
+     * A getter for the connected state.
67 67
      *
68 68
      * @returns {boolean}
69 69
      */
@@ -72,7 +72,7 @@ export default class XmppConnection extends Listenable {
72 72
     }
73 73
 
74 74
     /**
75
-     * FIXME.
75
+     * Retrieves the feature discovery plugin instance.
76 76
      *
77 77
      * @returns {Strophe.Connection.disco}
78 78
      */
@@ -81,7 +81,7 @@ export default class XmppConnection extends Listenable {
81 81
     }
82 82
 
83 83
     /**
84
-     * FIXME.
84
+     * A getter for the disconnecting state.
85 85
      *
86 86
      * @returns {boolean}
87 87
      */
@@ -90,7 +90,7 @@ export default class XmppConnection extends Listenable {
90 90
     }
91 91
 
92 92
     /**
93
-     * FIXME.
93
+     * A getter for the domain.
94 94
      *
95 95
      * @returns {string|null}
96 96
      */
@@ -108,7 +108,7 @@ export default class XmppConnection extends Listenable {
108 108
     }
109 109
 
110 110
     /**
111
-     * FIXME.
111
+     * A getter for the JID.
112 112
      *
113 113
      * @returns {string|null}
114 114
      */
@@ -117,7 +117,7 @@ export default class XmppConnection extends Listenable {
117 117
     }
118 118
 
119 119
     /**
120
-     * FIXME.
120
+     * Returns headers for the last BOSH response received.
121 121
      *
122 122
      * @returns {string}
123 123
      */
@@ -126,7 +126,7 @@ export default class XmppConnection extends Listenable {
126 126
     }
127 127
 
128 128
     /**
129
-     * FIXME.
129
+     * A getter for the logger plugin instance.
130 130
      *
131 131
      * @returns {*}
132 132
      */
@@ -135,7 +135,7 @@ export default class XmppConnection extends Listenable {
135 135
     }
136 136
 
137 137
     /**
138
-     * FIXME.
138
+     * A getter for the connection options.
139 139
      *
140 140
      * @returns {*}
141 141
      */
@@ -144,7 +144,7 @@ export default class XmppConnection extends Listenable {
144 144
     }
145 145
 
146 146
     /**
147
-     * FIXME.
147
+     * A getter for the service URL.
148 148
      *
149 149
      * @returns {string}
150 150
      */
@@ -174,7 +174,7 @@ export default class XmppConnection extends Listenable {
174 174
     }
175 175
 
176 176
     /**
177
-     * FIXME.
177
+     * See {@link Strophe.Connection.addHandler}
178 178
      *
179 179
      * @returns {void}
180 180
      */
@@ -183,7 +183,7 @@ export default class XmppConnection extends Listenable {
183 183
     }
184 184
 
185 185
     /**
186
-     * FIXME.
186
+     * See {@link Strophe.Connection.attach}.
187 187
      *
188 188
      * @returns {void}
189 189
      */
@@ -224,7 +224,7 @@ export default class XmppConnection extends Listenable {
224 224
     }
225 225
 
226 226
     /**
227
-     * FIXME.
227
+     * The method is meant to be used for testing. It's a shortcut for closing the WebSocket.
228 228
      *
229 229
      * @returns {void}
230 230
      */
@@ -233,7 +233,7 @@ export default class XmppConnection extends Listenable {
233 233
     }
234 234
 
235 235
     /**
236
-     * FIXME.
236
+     * See {@link Strophe.Connection.disconnect}.
237 237
      *
238 238
      * @returns {void}
239 239
      */
@@ -244,7 +244,7 @@ export default class XmppConnection extends Listenable {
244 244
     }
245 245
 
246 246
     /**
247
-     * FIXME.
247
+     * See {@link Strophe.Connection.flush}.
248 248
      *
249 249
      * @returns {void}
250 250
      */

Loading…
取消
儲存