Skip to content

Commit 7c1b262

Browse files
committed
Some docs edits to clean up phpdoc output
1 parent b7ff026 commit 7c1b262

File tree

7 files changed

+46
-25
lines changed

7 files changed

+46
-25
lines changed

src/OpenTok/Archive.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ public function toJson()
218218

219219
/**
220220
* Adds a stream to a currently running archive that was started with the
221-
* the <code>streamMode</code> set to <code>StreamMode.Manual</code>. You can call the method
221+
* the streamMode set to StreamMode.Manual. You can call the method
222222
* repeatedly with the same stream ID, to toggle the stream's audio or video in the archive.
223223
*
224224
* @param String $streamId The stream ID.
@@ -253,7 +253,7 @@ public function addStreamToArchive(string $streamId, bool $hasAudio, bool $hasVi
253253

254254
/**
255255
* Removes a stream from a currently running archive that was started with the
256-
* the <code>streamMode</code> set to <code>StreamMode.Manual</code>.
256+
* the streamMode set to StreamMode.Manual.
257257
*
258258
* @param String $streamId The stream ID.
259259
*

src/OpenTok/ArchiveList.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,8 @@ public function totalCount()
6767

6868
/**
6969
* Returns an array of Archive objects.
70+
*
71+
* @return Archive[]
7072
*/
7173
public function getItems()
7274
{

src/OpenTok/Broadcast.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ public function updateLayout($layout)
165165

166166
/**
167167
* Adds a stream to a currently running broadcast that was started with the
168-
* the <code>streamMode</code> set to <code>StreamMode.Manual</code>. You can call the method
168+
* the streamMode set to StreamMode.Manual. You can call the method
169169
* repeatedly with the same stream ID, to toggle the stream's audio or video in the broadcast.
170170
*
171171
* @param String $streamId The stream ID.
@@ -200,7 +200,7 @@ public function addStreamToBroadcast(string $streamId, bool $hasAudio, bool $has
200200

201201
/**
202202
* Removes a stream from a currently running broadcast that was started with the
203-
* the <code>streamMode</code> set to <code>StreamMode.Manual</code>.
203+
* the streamMode set to StreamMode.Manual.
204204
*
205205
* @param String $streamId The stream ID.
206206
*

src/OpenTok/OpenTok.php

Lines changed: 27 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,9 @@ public function __construct($apiKey, $apiSecret, $options = array())
6161
}
6262

6363
/**
64-
* Creates a token for connecting to an OpenTok session. In order to authenticate a user
64+
* Creates a token for connecting to an OpenTok session.
65+
*
66+
* In order to authenticate a user
6567
* connecting to an OpenTok session, the client passes a token when connecting to the session.
6668
* <p>
6769
* For testing, you generate tokens or by logging in to your
@@ -415,7 +417,9 @@ public function deleteArchive($archiveId)
415417
}
416418

417419
/**
418-
* Returns an ArchiveList. The <code>items()</code> method of this object returns a list of
420+
* Returns a list of archives for a session.
421+
*
422+
* The <code>items()</code> method of this object returns a list of
419423
* archives that are completed and in-progress, for your API key.
420424
*
421425
* @param integer $offset Optional. The index offset of the first archive. 0 is offset of the
@@ -453,7 +457,9 @@ public function setArchiveLayout(string $archiveId, Layout $layoutType): void
453457
}
454458

455459
/**
456-
* Sets the layout class list for streams in a session. Layout classes are used in
460+
* Sets the layout class list for streams in a session.
461+
*
462+
* Layout classes are used in
457463
* the layout for composed archives and live streaming broadcasts. For more information, see
458464
* <a href="https://tokbox.com/developer/guides/archiving/layout-control.html">Customizing
459465
* the video layout for composed archives</a> and
@@ -496,7 +502,9 @@ public function forceDisconnect($sessionId, $connectionId)
496502
* Force the publisher of a specific stream to mute its published audio.
497503
*
498504
* <p>
499-
* Also see the <a href="#method_forceMuteAll">OpenTok->forceMuteAll()</a> method.
505+
* Also see the
506+
* <a href="classes/OpenTok-OpenTok.html#method_forceMuteAll">OpenTok->forceMuteAll()</a>
507+
* method.
500508
*
501509
* @param string $sessionId The OpenTok session ID containing the stream.
502510
*
@@ -525,10 +533,12 @@ public function forceMuteStream(string $sessionId, string $streamId): bool
525533
* <p>
526534
* In addition to existing streams, any streams that are published after the call to
527535
* this method are published with audio muted. You can remove the mute state of a session
528-
* by calling the <a href="#method_disableForceMute">OpenTok->disableForceMute()</a> method.
529-
*
536+
* <a href="classes/OpenTok-OpenTok.html#method_disableForceMute">OpenTok->disableForceMute()</a>
537+
* method.
530538
* <p>
531-
* Also see the <a href="#method_forceMuteStream">OpenTok->forceMuteStream()</a> method.
539+
* Also see the
540+
* <a href="classes/OpenTok-OpenTok.html#method_forceMuteStream">OpenTok->forceMuteStream()</a>
541+
* method.
532542
*
533543
* @param string $sessionId The OpenTok session ID.
534544
*
@@ -564,7 +574,8 @@ public function forceMuteAll(string $sessionId, array $options): bool
564574
* published to the session will no longer have audio muted.
565575
*
566576
* <p>
567-
* After you call the <a href="#method_forceMuteAll">OpenTok->forceMuteAll()</a> method,
577+
* After you call the
578+
* <a href="classes/OpenTok-OpenTok.html#method_forceMuteAll">OpenTok->forceMuteAll()</a> method
568579
* any streams published after the call are published with audio muted. Call the
569580
* <c>disableForceMute()</c> method to remove the mute state of a session, so that
570581
* new published streams are not automatically muted.
@@ -714,7 +725,9 @@ public function updateBroadcastLayout(string $broadcastId, Layout $layout): void
714725
}
715726

716727
/**
717-
* Sets the layout class list for a stream. Layout classes are used in
728+
* Sets the layout class list for a stream.
729+
*
730+
* Layout classes are used in
718731
* the layout for composed archives and live streaming broadcasts.
719732
* <p>
720733
* For more information, see
@@ -725,14 +738,9 @@ public function updateBroadcastLayout(string $broadcastId, Layout $layout): void
725738
*
726739
* <p>
727740
* You can set the initial layout class list for streams published by a client when you generate
728-
* the token used by the client to connect to the session. See the OpenTok::generateToken()
729-
* {@link https://example.com/my/bar} floor
730-
* ({@see OpenTok::generateToken OpenTok->generateToken()}) sdfdf
741+
* the token used by the client to connect to the session. See the
731742
* <a href="classes/OpenTok-OpenTok.html#method_generateToken">OpenTok::generateToken()</a>
732743
* method.
733-
* <a href="#method_generateToken">OpenTok::generateToken()</a>
734-
* method.
735-
* @see OpenTok::generateToken()
736744
*
737745
* @param string $sessionId The session ID of the session the stream belongs to.
738746
*
@@ -819,8 +827,8 @@ public function listStreams($sessionId)
819827
* @param string $token The OpenTok token to be used for the participant being called.
820828
* You can add token data to identify that the participant is on a SIP endpoint or for
821829
* other identifying data, such as phone numbers. Generate a token using the
822-
* <a href="#method_generateToken">OpenTok->generateToken()</a> or
823-
* <a href="OpenTok.Session.html#method_generateToken">Session->generateToken()</a>
830+
* <a href="classes/OpenTok-OpenTok.html#method_generateToken">OpenTok::generateToken()</a> or
831+
* <a href="classes/OpenTok-Session.html#method_generateToken">Session::generateToken()</a>
824832
* method.
825833
*
826834
* @param string $sipUri The SIP URI to be used as destination of the SIP Call initiated from
@@ -876,7 +884,8 @@ public function listStreams($sessionId)
876884
* @return SipCall An object contains the OpenTok connection ID and stream ID
877885
* for the SIP call's connection in the OpenTok session. You can use the connection ID
878886
* to terminate the SIP call, using the
879-
* <a href="#method_forceDisconnect">OpenTok->forceDisconnect()</a> method.
887+
* <a href="classes/OpenTok-OpenTok.html#method_forceDisconnect">OpenTok::method_forceDisconnect()</a>
888+
* method.
880889
*/
881890
public function dial($sessionId, $token, $sipUri, $options = [])
882891
{

src/OpenTok/Role.php

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,9 @@ abstract class Role extends BasicEnum
2222
/**
2323
* In addition to the privileges granted to a publisher, a moderator can perform
2424
* moderation functions, such as forcing clients to disconnect, to stop publishing streams,
25-
* or to mute audio in published streams. See the
25+
* or to mute audio in published streams.
26+
*
27+
* See the
2628
* <a href="https://tokbox.com/developer/guides/moderation/">Moderation developer guide</a>.
2729
*/
2830
const MODERATOR = 'moderator';

src/OpenTok/Session.php

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,8 @@ public function __construct($opentok, $sessionId, $properties = array())
5858

5959
/**
6060
* Returns the session ID, which uniquely identifies the session.
61+
*
62+
* @return string
6163
*/
6264
public function getSessionId()
6365
{
@@ -68,6 +70,8 @@ public function getSessionId()
6870
* Returns the location hint IP address.
6971
*
7072
* See <a href="OpenTok.OpenTok.html#method_createSession">OpenTok->createSession()</a>.
73+
*
74+
* @return string
7175
*/
7276
public function getLocation()
7377
{
@@ -80,7 +84,9 @@ public function getLocation()
8084
* OpenTok Media Router.
8185
*
8286
* See <a href="OpenTok.OpenTok.html#method_createSession">OpenTok->createSession()</a>
83-
* and <a href="OpenTok.MediaMode.html">ArchiveMode</a>.
87+
* and <a href="OpenTok.MediaMode.html">MediaMode</a>.
88+
*
89+
* @return MediaMode
8490
*/
8591
public function getMediaMode()
8692
{
@@ -93,6 +99,8 @@ public function getMediaMode()
9399
*
94100
* See <a href="OpenTok.OpenTok.html#method_createSession">OpenTok->createSession()</a>
95101
* and <a href="OpenTok.ArchiveMode.html">ArchiveMode</a>.
102+
*
103+
* @return ArchiveMode
96104
*/
97105
public function getArchiveMode()
98106
{

src/OpenTok/StreamList.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public function totalCount()
3333
/**
3434
* Returns an array of Stream objects.
3535
*
36-
* @return array
36+
* @return Stream[]
3737
*/
3838
public function getItems()
3939
{

0 commit comments

Comments
 (0)