Skip to content

Commit 5e71272

Browse files
aoberoiaoberoi
committed
documentation generation tasks
1 parent accd818 commit 5e71272

31 files changed

+116
-97
lines changed

‎DEVELOPING.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,18 +28,27 @@ This project's tests are written as JUnit test cases. Common tasks:
2828

2929
### Generating Documentation
3030

31-
**TODO**
31+
This project's reference documentation is generated by Javadoc and resides in the `docs` directory of the project.
32+
Common tasks:
3233

33-
* Github Pages
34-
* docs directory
34+
* `gradle javadoc` - generate the reference documentation locally.
35+
* `gradle gh-pages` - update the hosted reference documentation on Github Pages (requires push privilege on `origin`
36+
git remote)
3537

3638
### Releasing
3739

3840
**TODO**
3941

40-
* Maven Central
41-
* Github Releases (jar files)
42-
* Github Pages upload should be a dependency
42+
* dependencies
43+
* build
44+
* test
45+
* version bumping (needs to be a valid version that isn't already used)
46+
* ossrh signing keys
47+
* automation
48+
* tagging
49+
* github pages uploading
50+
* maven central publishing
51+
* github release uploading
4352

4453
### IDE Integration
4554

‎build.gradle

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@ task javadocJar(type: Jar) {
1515
classifier = 'javadoc'
1616
from javadoc
1717
}
18+
javadoc {
19+
title = 'OpenTok 2.2 Java SDK'
20+
destinationDir = file('docs')
21+
exclude '**/util/**', '**/constants/**'
22+
options {
23+
locale 'en_US'
24+
setMemberLevel JavadocMemberLevel.PUBLIC
25+
}
26+
}
1827

1928
task sourcesJar(type: Jar) {
2029
classifier = 'sources'

‎docs/allclasses-frame.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Tue May 13 18:26:32 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_55) on Sat May 17 02:11:37 EDT 2014 -->
66
<title>All Classes (OpenTok 2.2 Java SDK)</title>
7-
<meta name="date" content="2014-05-13">
7+
<meta name="date" content="2014-05-17">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
</head>
1010
<body>

‎docs/allclasses-noframe.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Tue May 13 18:26:32 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_55) on Sat May 17 02:11:37 EDT 2014 -->
66
<title>All Classes (OpenTok 2.2 Java SDK)</title>
7-
<meta name="date" content="2014-05-13">
7+
<meta name="date" content="2014-05-17">
88
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
99
</head>
1010
<body>

‎docs/com/opentok/Archive.Status.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Tue May 13 18:26:32 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_55) on Sat May 17 02:11:37 EDT 2014 -->
66
<title>Archive.Status (OpenTok 2.2 Java SDK)</title>
7-
<meta name="date" content="2014-05-13">
7+
<meta name="date" content="2014-05-17">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>
@@ -155,7 +155,7 @@ <h3>Enum Constant Summary</h3>
155155
</tr>
156156
<tr class="rowColor">
157157
<td class="colOne"><code><strong><a href="../../com/opentok/Archive.Status.html#UPLOADED">UPLOADED</a></strong></code>
158-
<div class="block">The archive file is available at the target S3 bucket you at the
158+
<div class="block">The archive file is available at the target S3 bucket you set at the
159159
<a href="https://dashboard.tokbox.com">OpenTok dashboard</a>.</div>
160160
</td>
161161
</tr>
@@ -278,7 +278,7 @@ <h4>STOPPED</h4>
278278
<li class="blockList">
279279
<h4>UPLOADED</h4>
280280
<pre>public static final&nbsp;<a href="../../com/opentok/Archive.Status.html" title="enum in com.opentok">Archive.Status</a> UPLOADED</pre>
281-
<div class="block">The archive file is available at the target S3 bucket you at the
281+
<div class="block">The archive file is available at the target S3 bucket you set at the
282282
<a href="https://dashboard.tokbox.com">OpenTok dashboard</a>.</div>
283283
</li>
284284
</ul>

‎docs/com/opentok/Archive.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Tue May 13 18:26:32 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_55) on Sat May 17 02:11:37 EDT 2014 -->
66
<title>Archive (OpenTok 2.2 Java SDK)</title>
7-
<meta name="date" content="2014-05-13">
7+
<meta name="date" content="2014-05-17">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>

‎docs/com/opentok/OpenTok.html

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Tue May 13 18:26:32 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_55) on Sat May 17 02:11:37 EDT 2014 -->
66
<title>OpenTok (OpenTok 2.2 Java SDK)</title>
7-
<meta name="date" content="2014-05-13">
7+
<meta name="date" content="2014-05-17">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>
@@ -97,11 +97,11 @@ <h2 title="Class OpenTok" class="title">Class OpenTok</h2>
9797
<br>
9898
<pre>public class <span class="strong">OpenTok</span>
9999
extends java.lang.Object</pre>
100-
<div class="block">Contains methods for creating OpenTok sessions and generating tokens.
100+
<div class="block">Contains methods for creating OpenTok sessions, generating tokens, and working with archives.
101101
<p>
102-
To create a new OpenTokSDK object, call the OpenTokSDK constructor with your OpenTok API key
102+
To create a new OpenTok object, call the OpenTok constructor with your OpenTok API key
103103
and the API secret from <a href="https://dashboard.tokbox.com">the OpenTok dashboard</a>. Do not publicly share
104-
your API secret. You will use it with the OpenTokSDK constructor (only on your web
104+
your API secret. You will use it with the OpenTok constructor (only on your web
105105
server) to create OpenTok sessions.
106106
<p>
107107
Be sure to include the entire OpenTok server SDK on your web server.</div>
@@ -125,7 +125,7 @@ <h3>Constructor Summary</h3>
125125
<tr class="altColor">
126126
<td class="colOne"><code><strong><a href="../../com/opentok/OpenTok.html#OpenTok(int, java.lang.String)">OpenTok</a></strong>(int&nbsp;apiKey,
127127
java.lang.String&nbsp;apiSecret)</code>
128-
<div class="block">Creates an OpenTokSDK object.</div>
128+
<div class="block">Creates an OpenTok object.</div>
129129
</td>
130130
</tr>
131131
<tr class="rowColor">
@@ -247,7 +247,7 @@ <h3>Constructor Detail</h3>
247247
<h4>OpenTok</h4>
248248
<pre>public&nbsp;OpenTok(int&nbsp;apiKey,
249249
java.lang.String&nbsp;apiSecret)</pre>
250-
<div class="block">Creates an OpenTokSDK object.</div>
250+
<div class="block">Creates an OpenTok object.</div>
251251
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>apiKey</code> - Your OpenTok API key. (See the <a href="https://dashboard.tokbox.com">OpenTok
252252
dashboard</a> page.)</dd><dd><code>apiSecret</code> - Your OpenTok API secret. (See the <a href="https://dashboard.tokbox.com">OpenTok dashboard</a>
253253
page)</dd></dl>
@@ -295,7 +295,7 @@ <h4>generateToken</h4>
295295
public static void main(String argv[]) throws OpenTokException {
296296
int API_KEY = 0; // Replace with your OpenTok API key (see http://dashboard.tokbox.com).
297297
String API_SECRET = ""; // Replace with your OpenTok API secret.
298-
OpenTokSDK sdk = new OpenTokSDK(API_KEY, API_SECRET);
298+
OpenTok sdk = new OpenTok(API_KEY, API_SECRET);
299299

300300
//Generate a basic session. Or you could use an existing session ID.
301301
String sessionId = System.out.println(sdk.createSession());
@@ -350,13 +350,13 @@ <h4>generateToken</h4>
350350
The following example shows how to generate a token that has the default settings:
351351
<p>
352352
<pre>
353-
import com.opentok.OpenTokSDK;
353+
import com.opentok.OpenTok;
354354

355355
class Test {
356356
public static void main(String argv[]) throws OpenTokException {
357357
int API_KEY = 0; // Replace with your OpenTok API key (see http://dashboard.tokbox.com).
358358
String API_SECRET = ""; // Replace with your OpenTok API secret.
359-
OpenTokSDK sdk = new OpenTokSDK(API_KEY, API_SECRET);
359+
OpenTok sdk = new OpenTok(API_KEY, API_SECRET);
360360

361361
//Generate a basic session. Or you could use an existing session ID.
362362
String sessionId = System.out.println(sdk.createSession().getSessionId());
@@ -383,7 +383,7 @@ <h4>createSession</h4>
383383
<div class="block">Creates a new OpenTok session and returns the session ID, which uniquely identifies
384384
the session.
385385
<p>
386-
For example, when using the OpenTok JavaScript library, use the session ID when calling the
386+
For example, when using the OpenTok.js library, use the session ID when calling the
387387
<a href="http://tokbox.com/opentok/libraries/client/js/reference/OT.html#initSession">
388388
OT.initSession()</a> method (to initialize an OpenTok session).
389389
<p>
@@ -399,15 +399,15 @@ <h4>createSession</h4>
399399
The following code creates a peer-to-peer session:
400400

401401
<pre>
402-
import com.opentok.OpenTokSDK;
402+
import com.opentok.OpenTok;
403403
import com.opentok.Session;
404404
import com.opentok.SessionProperties;
405405

406406
class Test {
407407
public static void main(String argv[]) throws OpenTokException {
408408
int API_KEY = 0; // Replace with your OpenTok API key.
409409
String API_SECRET = ""; // Replace with your OpenTok API secret.
410-
OpenTokSDK sdk = new OpenTokSDK(API_KEY, API_SECRET);
410+
OpenTok sdk = new OpenTok(API_KEY, API_SECRET);
411411

412412
SessionProperties sp = new SessionProperties().Builder().p2p(true).build();
413413

@@ -428,9 +428,8 @@ <h4>createSession</h4>
428428

429429
<li>A location hint for the location of the OpenTok server to use for the session.</li>
430430
</ul></dd>
431-
<dt><span class="strong">Returns:</span></dt><dd>A session ID for the new session. For example, when using the OpenTok JavaScript library, use this session ID
432-
in JavaScript on the page that you serve to the client. The JavaScript will use this value when calling the
433-
<code>connect()</code> method of the Session object (to connect a user to an OpenTok session).</dd>
431+
<dt><span class="strong">Returns:</span></dt><dd>A session ID for the new session. For example, when using the OpenTok.js library, use
432+
this session ID when calling the <code>OT.initSession()</code> method.</dd>
434433
<dt><span class="strong">Throws:</span></dt>
435434
<dd><code><a href="../../com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception">OpenTokException</a></code></dd></dl>
436435
</li>
@@ -455,14 +454,14 @@ <h4>createSession</h4>
455454
The following example creates a session that uses the default settings:
456455

457456
<pre>
458-
import com.opentok.OpenTokSDK;
457+
import com.opentok.OpenTok;
459458
import com.opentok.SessionProperties;
460459

461460
class Test {
462461
public static void main(String argv[]) throws OpenTokException {
463462
int API_KEY = 0; // Replace with your OpenTok API key.
464463
String API_SECRET = ""; // Replace with your OpenTok API secret.
465-
OpenTokSDK sdk = new OpenTokSDK(API_KEY, API_SECRET);
464+
OpenTok sdk = new OpenTok(API_KEY, API_SECRET);
466465

467466
String sessionId = sdk.createSession();
468467
System.out.println(sessionId);
@@ -516,8 +515,10 @@ <h4>listArchives</h4>
516515
throws <a href="../../com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception">OpenTokException</a></pre>
517516
<div class="block">Returns a List of <a href="../../com/opentok/Archive.html" title="class in com.opentok"><code>Archive</code></a> objects, representing archives that are both
518517
both completed and in-progress, for your API key.</div>
519-
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>offset</code> - The index offset of the first archive. 0 is offset of the most recently STARTED archive.
520-
1 is the offset of the archive that STARTED prior to the most recent archive.</dd><dd><code>count</code> - The number of archives to be returned. The maximum number of archives returned is 1000.</dd>
518+
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>offset</code> - The index offset of the first archive. 0 is offset of the most recently started
519+
archive.
520+
1 is the offset of the archive that started prior to the most recent archive.</dd><dd><code>count</code> - The number of archives to be returned. The maximum number of archives returned
521+
is 1000.</dd>
521522
<dt><span class="strong">Returns:</span></dt><dd>A List of <a href="../../com/opentok/Archive.html" title="class in com.opentok"><code>Archive</code></a> objects.</dd>
522523
<dt><span class="strong">Throws:</span></dt>
523524
<dd><code><a href="../../com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception">OpenTokException</a></code></dd></dl>
@@ -574,9 +575,9 @@ <h4>deleteArchive</h4>
574575
throws <a href="../../com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception">OpenTokException</a></pre>
575576
<div class="block">Deletes an OpenTok archive.
576577
<p>
577-
You can only delete an archive which has a status of "AVAILABLE" or "UPLOADED". Deleting an archive
578-
removes its record from the list of archives. For an "AVAILABLE" archive, it also removes the archive
579-
file, making it unavailable for download.</div>
578+
You can only delete an archive which has a status of "available" or "uploaded". Deleting an
579+
archive removes its record from the list of archives. For an "available" archive, it also
580+
removes the archive file, making it unavailable for download.</div>
580581
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>archiveId</code> - The archive ID of the archive you want to delete.</dd>
581582
<dt><span class="strong">Throws:</span></dt>
582583
<dd><code><a href="../../com/opentok/exception/OpenTokException.html" title="class in com.opentok.exception">OpenTokException</a></code></dd></dl>

‎docs/com/opentok/Role.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Tue May 13 18:26:32 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_55) on Sat May 17 02:11:37 EDT 2014 -->
66
<title>Role (OpenTok 2.2 Java SDK)</title>
7-
<meta name="date" content="2014-05-13">
7+
<meta name="date" content="2014-05-17">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>
@@ -220,7 +220,7 @@ <h4>SUBSCRIBER</h4>
220220
<h4>PUBLISHER</h4>
221221
<pre>public static final&nbsp;<a href="../../com/opentok/Role.html" title="enum in com.opentok">Role</a> PUBLISHER</pre>
222222
<div class="block">A publisher can publish streams, subscribe to streams, and signal. (This is the default
223-
value if you do not set a roll by calling the <a href="../../com/opentok/TokenOptions.Builder.html#role(com.opentok.Role)"><code>TokenOptions.Builder.role(Role role)</code></a>
223+
value if you do not set a role by calling the <a href="../../com/opentok/TokenOptions.Builder.html#role(com.opentok.Role)"><code>TokenOptions.Builder.role(Role role)</code></a>
224224
method.</div>
225225
</li>
226226
</ul>

‎docs/com/opentok/Session.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Tue May 13 18:26:32 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_55) on Sat May 17 02:11:37 EDT 2014 -->
66
<title>Session (OpenTok 2.2 Java SDK)</title>
7-
<meta name="date" content="2014-05-13">
7+
<meta name="date" content="2014-05-17">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>

‎docs/com/opentok/SessionProperties.Builder.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (version 1.7.0_40) on Tue May 13 18:26:32 PDT 2014 -->
5+
<!-- Generated by javadoc (version 1.7.0_55) on Sat May 17 02:11:37 EDT 2014 -->
66
<title>SessionProperties.Builder (OpenTok 2.2 Java SDK)</title>
7-
<meta name="date" content="2014-05-13">
7+
<meta name="date" content="2014-05-17">
88
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
99
</head>
1010
<body>

0 commit comments

Comments
 (0)