From f35e380f9759a5f2654abfb3705caa848f2008fe Mon Sep 17 00:00:00 2001
From: pabloFuente <pablofuenteperez@gmail.com>
Date: Wed, 19 Feb 2020 12:09:46 +0100
Subject: [PATCH] openvidu-browser: better docs for events

---
 .../src/OpenViduInternal/Events/ConnectionEvent.ts            | 4 ++--
 .../src/OpenViduInternal/Events/PublisherSpeakingEvent.ts     | 4 ++--
 .../src/OpenViduInternal/Events/RecordingEvent.ts             | 4 ++--
 .../src/OpenViduInternal/Events/SessionDisconnectedEvent.ts   | 2 +-
 openvidu-browser/src/OpenViduInternal/Events/SignalEvent.ts   | 4 ++--
 openvidu-browser/src/OpenViduInternal/Events/StreamEvent.ts   | 4 ++--
 6 files changed, 11 insertions(+), 11 deletions(-)

diff --git a/openvidu-browser/src/OpenViduInternal/Events/ConnectionEvent.ts b/openvidu-browser/src/OpenViduInternal/Events/ConnectionEvent.ts
index b9ef1b2d..60609a26 100644
--- a/openvidu-browser/src/OpenViduInternal/Events/ConnectionEvent.ts
+++ b/openvidu-browser/src/OpenViduInternal/Events/ConnectionEvent.ts
@@ -22,8 +22,8 @@ import { Session } from '../../OpenVidu/Session';
 
 /**
  * Defines the following events:
- * - `connectionCreated`: dispatched by [[Session]]
- * - `connectionDestroyed`: dispatched by [[Session]]
+ * - `connectionCreated`: dispatched by [[Session]] after a new user has connected to the session
+ * - `connectionDestroyed`: dispatched by [[Session]] after a new user has left the session
  */
 export class ConnectionEvent extends Event {
 
diff --git a/openvidu-browser/src/OpenViduInternal/Events/PublisherSpeakingEvent.ts b/openvidu-browser/src/OpenViduInternal/Events/PublisherSpeakingEvent.ts
index 0d111adb..3507528b 100644
--- a/openvidu-browser/src/OpenViduInternal/Events/PublisherSpeakingEvent.ts
+++ b/openvidu-browser/src/OpenViduInternal/Events/PublisherSpeakingEvent.ts
@@ -22,8 +22,8 @@ import { Session } from '../..';
 
 /**
  * Defines the following events:
- * - `publisherStartSpeaking`: dispatched by [[Session]]
- * - `publisherStopSpeaking`: dispatched by [[Session]]
+ * - `publisherStartSpeaking`: dispatched by [[Session]] when a remote user has started speaking
+ * - `publisherStopSpeaking`: dispatched by [[Session]] when a remote user has stopped speaking
  *
  * More information:
  * - This events will only be triggered for **remote streams that have audio tracks** ([[Stream.hasAudio]] must be true)
diff --git a/openvidu-browser/src/OpenViduInternal/Events/RecordingEvent.ts b/openvidu-browser/src/OpenViduInternal/Events/RecordingEvent.ts
index 60c89866..bb7bce25 100644
--- a/openvidu-browser/src/OpenViduInternal/Events/RecordingEvent.ts
+++ b/openvidu-browser/src/OpenViduInternal/Events/RecordingEvent.ts
@@ -21,8 +21,8 @@ import { Session } from '../../OpenVidu/Session';
 
 /**
  * Defines the following events:
- * - `recordingStarted`: dispatched by [[Session]]
- * - `recordingStopped`: dispatched by [[Session]]
+ * - `recordingStarted`: dispatched by [[Session]] after the session has started being recorded
+ * - `recordingStopped`: dispatched by [[Session]] after the session has stopped being recorded
  */
 export class RecordingEvent extends Event {
 
diff --git a/openvidu-browser/src/OpenViduInternal/Events/SessionDisconnectedEvent.ts b/openvidu-browser/src/OpenViduInternal/Events/SessionDisconnectedEvent.ts
index 903cd63a..935168c9 100644
--- a/openvidu-browser/src/OpenViduInternal/Events/SessionDisconnectedEvent.ts
+++ b/openvidu-browser/src/OpenViduInternal/Events/SessionDisconnectedEvent.ts
@@ -20,7 +20,7 @@ import { Session } from '../../OpenVidu/Session';
 
 
 /**
- * Defines event `sessionDisconnected` dispatched by [[Session]]
+ * Defines event `sessionDisconnected` dispatched by [[Session]] after the local user has left the session. This is the local version of the `connectionDestroyed` event, which is only dispatched by remote users
  */
 export class SessionDisconnectedEvent extends Event {
 
diff --git a/openvidu-browser/src/OpenViduInternal/Events/SignalEvent.ts b/openvidu-browser/src/OpenViduInternal/Events/SignalEvent.ts
index 9bcc5424..cae5675b 100644
--- a/openvidu-browser/src/OpenViduInternal/Events/SignalEvent.ts
+++ b/openvidu-browser/src/OpenViduInternal/Events/SignalEvent.ts
@@ -22,8 +22,8 @@ import { Session } from '../../OpenVidu/Session';
 
 /**
  * Defines the following events:
- * - `signal`: dispatched by [[Session]]
- * - `signal:TYPE`: dispatched by [[Session]]
+ * - `signal`: dispatched by [[Session]] when a signal is received
+ * - `signal:TYPE`: dispatched by [[Session]] when a signal of type TYPE is received
  */
 export class SignalEvent extends Event {
 
diff --git a/openvidu-browser/src/OpenViduInternal/Events/StreamEvent.ts b/openvidu-browser/src/OpenViduInternal/Events/StreamEvent.ts
index c5bb06f8..d04c556e 100644
--- a/openvidu-browser/src/OpenViduInternal/Events/StreamEvent.ts
+++ b/openvidu-browser/src/OpenViduInternal/Events/StreamEvent.ts
@@ -23,8 +23,8 @@ import { Stream } from '../../OpenVidu/Stream';
 
 /**
  * Defines the following events:
- * - `streamCreated`: dispatched by [[Session]] and [[Publisher]]
- * - `streamDestroyed`: dispatched by [[Session]] and [[Publisher]]
+ * - `streamCreated`: dispatched by [[Session]] and [[Publisher]] after some user has started publishing to the session
+ * - `streamDestroyed`: dispatched by [[Session]] and [[Publisher]] after some user has stopped publishing to the session
  */
 export class StreamEvent extends Event {