Quellcode durchsuchen

Merge pull request #32 from jitsi/fix-doc-comments

Fixes doc(umentation) comments
dev1
damencho vor 9 Jahren
Ursprung
Commit
165be224c9
1 geänderte Dateien mit 9 neuen und 11 gelöschten Zeilen
  1. 9
    11
      JitsiConference.js

+ 9
- 11
JitsiConference.js Datei anzeigen

@@ -206,8 +206,8 @@ JitsiConference.prototype.addEventListener = JitsiConference.prototype.on;
206 206
 JitsiConference.prototype.removeEventListener = JitsiConference.prototype.off;
207 207
 
208 208
 /**
209
- * Receives notifications from another participants for commands / custom events
210
- * (send by sendPresenceCommand method).
209
+ * Receives notifications from other participants about commands / custom events
210
+ * (sent by sendCommand or sendCommandOnce methods).
211 211
  * @param command {String} the name of the command
212 212
  * @param handler {Function} handler for the command
213 213
  */
@@ -218,7 +218,7 @@ JitsiConference.prototype.removeEventListener = JitsiConference.prototype.off;
218 218
 
219 219
 /**
220 220
   * Removes command  listener
221
-  * @param command {String}  the name of the command
221
+  * @param command {String} the name of the command
222 222
   */
223 223
  JitsiConference.prototype.removeCommandListener = function (command) {
224 224
     if(this.room)
@@ -236,8 +236,8 @@ JitsiConference.prototype.sendTextMessage = function (message) {
236 236
 
237 237
 /**
238 238
  * Send presence command.
239
- * @param name the name of the command.
240
- * @param values Object with keys and values that will be send.
239
+ * @param name {String} the name of the command.
240
+ * @param values {Object} with keys and values that will be sent.
241 241
  **/
242 242
 JitsiConference.prototype.sendCommand = function (name, values) {
243 243
     if(this.room) {
@@ -248,8 +248,8 @@ JitsiConference.prototype.sendCommand = function (name, values) {
248 248
 
249 249
 /**
250 250
  * Send presence command one time.
251
- * @param name the name of the command.
252
- * @param values Object with keys and values that will be send.
251
+ * @param name {String} the name of the command.
252
+ * @param values {Object} with keys and values that will be sent.
253 253
  **/
254 254
 JitsiConference.prototype.sendCommandOnce = function (name, values) {
255 255
     this.sendCommand(name, values);
@@ -257,10 +257,8 @@ JitsiConference.prototype.sendCommandOnce = function (name, values) {
257 257
 };
258 258
 
259 259
 /**
260
- * Send presence command.
261
- * @param name the name of the command.
262
- * @param values Object with keys and values that will be send.
263
- * @param persistent if false the command will be sent only one time
260
+ * Removes presence command.
261
+ * @param name {String} the name of the command.
264 262
  **/
265 263
 JitsiConference.prototype.removeCommand = function (name) {
266 264
     if(this.room)

Laden…
Abbrechen
Speichern