소스 검색

Fixes doc(umentation) comments (e.g. the mention of the method sendPresenceCommand with does not exist).

dev1
Lyubomir Marinov 9 년 전
부모
커밋
643b3fa8ae
1개의 변경된 파일9개의 추가작업 그리고 11개의 파일을 삭제
  1. 9
    11
      JitsiConference.js

+ 9
- 11
JitsiConference.js 파일 보기

206
 JitsiConference.prototype.removeEventListener = JitsiConference.prototype.off;
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
  * @param command {String} the name of the command
211
  * @param command {String} the name of the command
212
  * @param handler {Function} handler for the command
212
  * @param handler {Function} handler for the command
213
  */
213
  */
218
 
218
 
219
 /**
219
 /**
220
   * Removes command  listener
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
  JitsiConference.prototype.removeCommandListener = function (command) {
223
  JitsiConference.prototype.removeCommandListener = function (command) {
224
     if(this.room)
224
     if(this.room)
236
 
236
 
237
 /**
237
 /**
238
  * Send presence command.
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
 JitsiConference.prototype.sendCommand = function (name, values) {
242
 JitsiConference.prototype.sendCommand = function (name, values) {
243
     if(this.room) {
243
     if(this.room) {
248
 
248
 
249
 /**
249
 /**
250
  * Send presence command one time.
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
 JitsiConference.prototype.sendCommandOnce = function (name, values) {
254
 JitsiConference.prototype.sendCommandOnce = function (name, values) {
255
     this.sendCommand(name, values);
255
     this.sendCommand(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
 JitsiConference.prototype.removeCommand = function (name) {
263
 JitsiConference.prototype.removeCommand = function (name) {
266
     if(this.room)
264
     if(this.room)

Loading…
취소
저장