Skip to content

Commit 8bb8a99

Browse files
committed
Docs edits. .yardopts contains the Yard docs compile options.
1 parent 2dcff7f commit 8bb8a99

File tree

5 files changed

+13
-136
lines changed

5 files changed

+13
-136
lines changed

.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,13 @@ Gemfile.lock
77
InstalledFiles
88
_yardoc
99
coverage
10-
doc/
10+
1111
lib/bundler/man
1212
pkg
1313
rdoc
1414
spec/reports
1515
test/tmp
1616
test/version_tmp
1717
tmp
18+
19+
.DS_Store

.yardopts

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
'lib/**/*.rb' --no-private --readme doc/README.md

README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ $ gem install opentok -v 2.2.0pre
4242
## Initializing
4343

4444
Load the gem at the top of any file where it will be used. Then initialize an `OpenTok::OpenTok`
45-
object with your own API Key and API Secret.
45+
object with your OpenTok API key and API secret.
4646

4747
```ruby
4848
require "opentok"
@@ -52,7 +52,7 @@ opentok = OpenTok::OpenTok.new api_key, api_secret
5252

5353
## Creating Sessions
5454

55-
To create an OpenTok Session, use the `opentok.create_session(properties)` method. The
55+
To create an OpenTok Session, use the `OpenTok.create_session(properties)` method. The
5656
`properties` parameter is an optional Hash used to specify whether you are creating a p2p Session
5757
and specifying a location hint. The `session_id` method of the returned `OpenTok::Session`
5858
instance is useful to get a sessionId that can be saved to a persistent store (e.g. database).
@@ -80,6 +80,7 @@ the Token.
8080
```ruby
8181
# Generate a Token from just a session_id (fetched from a database)
8282
token = opentok.generate_token session_id
83+
8384
# Generate a Token by calling the method on the Session (returned from createSession)
8485
token = session.generate_token
8586

@@ -148,7 +149,8 @@ $total = archive_list.total
148149

149150
# Documentation
150151

151-
**TODO**: Reference documentation is available at <http://opentok.github.io/opentok-ruby-sdk/>
152+
Reference documentation is available at <http://www.tokbox.com//opentok/libraries/server/ruby/reference/index.html> and in the
153+
doc directory of the SDK.
152154

153155
# Requirements
154156

@@ -161,7 +163,7 @@ The OpenTok Ruby SDK requires Ruby 1.9.3 or greater.
161163
**TODO**: See the [Releases](https://github.com/opentok/opentok-ruby-sdk/releases) page for details
162164
about each release.
163165

164-
## Important changes in v2.0
166+
## Important changes in v2.2
165167

166168
This version of the SDK includes support for working with OpenTok 2.0 archives. (This API does not
167169
work with OpenTok 1.0 archives.)

doc/reference.md

-127
This file was deleted.

lib/opentok/opentok.rb

+3-4
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,9 @@ def initialize(api_key, api_secret , api_url = ::OpenTok::API_URL)
6262
# http://www.tokbox.com/opentok/api/#session_id_production) or the OpenTok dashboard
6363
# (see https://dashboard.tokbox.com/projects).
6464
#
65-
# @param [Hash] options (Optional) This hash defines options for the session. It includes
66-
# the following keys (each of which is optional):
65+
# @param [Hash] opts (Optional) This hash defines options for the session.
6766
#
68-
# * :p2p (Boolean) -- The session's streams will be transmitted directly between
67+
# @option opts [Boolean] :p2p The session's streams will be transmitted directly between
6968
# peers (true) or using the OpenTok Media Router (false). By default, sessions use
7069
# the OpenTok Media Router.
7170
#
@@ -84,7 +83,7 @@ def initialize(api_key, api_secret , api_url = ::OpenTok::API_URL)
8483
# peer-to-peer session uses the OpenTok TURN server to relay streams. For information on
8584
# pricing, see the OpenTok pricing page (http://www.tokbox.com/pricing).
8685
#
87-
# * :location (String) -- An IP address that the OpenTok servers will use to
86+
# @option opts [String] :location An IP address that the OpenTok servers will use to
8887
# situate the session in its global network. If you do not set a location hint,
8988
# the OpenTok servers will be based on the first client connecting to the session.
9089
#

0 commit comments

Comments
 (0)