[Red5commits] [503] jbauch

[luke@codegent.com]

updated javadocs


Timestamp: 03/12/06 21:33:18 (2 hours ago) 
Change: 503 
Author: jbauch

Files (see diff or trac for details): 
java/server/branches/red5_refactor/src/org/red5/server/api/IAttributeStore.java
java/server/branches/red5_refactor/src/org/red5/server/api/IBroadcastStream.java
java/server/branches/red5_refactor/src/org/red5/server/api/IConnection.java
java/server/branches/red5_refactor/src/org/red5/server/api/IMapping.java
java/server/branches/red5_refactor/src/org/red5/server/api/IOnDemandStream.java
java/server/branches/red5_refactor/src/org/red5/server/api/IScope.java
java/server/branches/red5_refactor/src/org/red5/server/api/IScopeHandler.java
java/server/branches/red5_refactor/src/org/red5/server/api/ISharedObject.java
java/server/branches/red5_refactor/src/org/red5/server/api/IStream.java
java/server/branches/red5_refactor/src/org/red5/server/api/Red5.java


Trac: http://mirror1.cvsdude.com/trac/osflash/red5/changeset/503

Index: /java/server/branches/red5_refactor/src/org/red5/server/api/Red5.java
===================================================================
--- /java/server/branches/red5_refactor/src/org/red5/server/api/Red5.java (revision 499)
+++ /java/server/branches/red5_refactor/src/org/red5/server/api/Red5.java (revision 503)
@@ -23,5 +23,5 @@
 
 /**
- * Utility class for accessing red5 API objects
+ * Utility class for accessing red5 API objects.
  * 
  * This class uses a thread local, and will be setup by the service invoker
@@ -30,10 +30,10 @@
  * <p>
  * <code>
- * Connection conn = Red5.getConnectionLocal();
- * Red5 r5 = new Red5();
- * Scope scope = r5.getScope();
- * conn = r5.getConnection();
- * r5 = new Red5(conn);
- * Client client = r5.getClient();
+ * IConnection conn = Red5.getConnectionLocal();<br />
+ * Red5 r5 = new Red5();<br />
+ * IScope scope = r5.getScope();<br />
+ * conn = r5.getConnection();<br />
+ * r5 = new Red5(conn);<br />
+ * IClient client = r5.getClient();<br />
  * </code>
  * </p>
Index: /java/server/branches/red5_refactor/src/org/red5/server/api/IScopeHandler.java
===================================================================
--- /java/server/branches/red5_refactor/src/org/red5/server/api/IScopeHandler.java (revision 499)
+++ /java/server/branches/red5_refactor/src/org/red5/server/api/IScopeHandler.java (revision 503)
@@ -21,10 +21,14 @@
 
 /**
- * The Scope Handler Controls actions performed against a scope object, and also
- * is notified of all events Gives fine grained control over what actions can be
- * performed with the can* methods Allows for detailed reporting on what is
- * happening within the scope with the on* methods This is the core interface
- * users implement to create applications The thread local connection is always
- * available via the Red5 object within these methods
+ * The Scope Handler controls actions performed against a scope object, and also
+ * is notified of all events.
+ * 
+ * Gives fine grained control over what actions can be performed with the can*
+ * methods. Allows for detailed reporting on what is happening within the scope
+ * with the on* methods. This is the core interface users implement to create
+ * applications.
+ * 
+ * The thread local connection is always available via the Red5 object within
+ * these methods
  * 
  * @author The Red5 Project (red5 at osflash.org)
Index: /java/server/branches/red5_refactor/src/org/red5/server/api/IScope.java
===================================================================
--- /java/server/branches/red5_refactor/src/org/red5/server/api/IScope.java (revision 499)
+++ /java/server/branches/red5_refactor/src/org/red5/server/api/IScope.java (revision 503)
@@ -27,10 +27,13 @@
 
 /**
- * The Scope Object A statefull object shared between a group of clients
- * connected to the same context path. Scopes are arranged in a hierarchical
- * way, so its possible for a scope to have a parent. If a client is connect to
- * a scope then they are also connected to its parent scope. The scope object is
- * used to access resources, shared object, streams, etc. The following are all
- * names for scopes: application, room, place, lobby.
+ * The Scope Object.
+ * 
+ * A statefull object shared between a group of clients connected to the same
+ * context path. Scopes are arranged in a hierarchical way, so its possible for
+ * a scope to have a parent. If a client is connect to a scope then they are also
+ * connected to its parent scope. The scope object is used to access resources,
+ * shared object, streams, etc.
+ * 
+ * The following are all names for scopes: application, room, place, lobby.
  * 
  * @author The Red5 Project (red5 at osflash.org)
Index: /java/server/branches/red5_refactor/src/org/red5/server/api/IMapping.java
===================================================================
--- /java/server/branches/red5_refactor/src/org/red5/server/api/IMapping.java (revision 499)
+++ /java/server/branches/red5_refactor/src/org/red5/server/api/IMapping.java (revision 503)
@@ -21,5 +21,5 @@
 
 /**
- * Use to Map between names and objects
+ * Use to Map between names and objects.
  * 
  * Provides mapping for:
Index: /java/server/branches/red5_refactor/src/org/red5/server/api/IStream.java
===================================================================
--- /java/server/branches/red5_refactor/src/org/red5/server/api/IStream.java (revision 499)
+++ /java/server/branches/red5_refactor/src/org/red5/server/api/IStream.java (revision 503)
@@ -21,5 +21,5 @@
 
 /**
- * Base interface for stream objects
+ * Base interface for stream objects.
  * 
  * Provides all the common methods shared between OnDemandStream and
Index: /java/server/branches/red5_refactor/src/org/red5/server/api/ISharedObject.java
===================================================================
--- /java/server/branches/red5_refactor/src/org/red5/server/api/ISharedObject.java (revision 499)
+++ /java/server/branches/red5_refactor/src/org/red5/server/api/ISharedObject.java (revision 503)
@@ -105,5 +105,5 @@
 	 * Register a connection that should receive updates of the shared object.
 	 * 
-	 * @param client
+	 * @param connection
 	 *            connection to subscribe to this object
 	 */
@@ -113,5 +113,5 @@
 	 * Unregister a connection from this shared object.
 	 * 
-	 * @param client
+	 * @param connection
 	 *            the connection to unsubscribe from this object
 	 */
Index: /java/server/branches/red5_refactor/src/org/red5/server/api/IBroadcastStream.java
===================================================================
--- /java/server/branches/red5_refactor/src/org/red5/server/api/IBroadcastStream.java (revision 499)
+++ /java/server/branches/red5_refactor/src/org/red5/server/api/IBroadcastStream.java (revision 503)
@@ -21,5 +21,5 @@
 
 /**
- * Extends stream to add methods for broadcast streaming
+ * Extends stream to add methods for broadcast streaming.
  * 
  * TODO: What should be pass to the methods?
Index: /java/server/branches/red5_refactor/src/org/red5/server/api/IConnection.java
===================================================================
--- /java/server/branches/red5_refactor/src/org/red5/server/api/IConnection.java (revision 499)
+++ /java/server/branches/red5_refactor/src/org/red5/server/api/IConnection.java (revision 503)
@@ -24,5 +24,5 @@
 
 /**
- * The connection object
+ * The connection object.
  * 
  * Each connection has an associated client and scope. Connections may be
Index: /java/server/branches/red5_refactor/src/org/red5/server/api/IAttributeStore.java
===================================================================
--- /java/server/branches/red5_refactor/src/org/red5/server/api/IAttributeStore.java (revision 498)
+++ /java/server/branches/red5_refactor/src/org/red5/server/api/IAttributeStore.java (revision 503)
@@ -28,5 +28,5 @@
 
 /**
- * Base Interface for all API objects with attributes
+ * Base interface for all API objects with attributes
  * 
  * @author The Red5 Project (red5 at osflash.org)
Index: /java/server/branches/red5_refactor/src/org/red5/server/api/IOnDemandStream.java
===================================================================
--- /java/server/branches/red5_refactor/src/org/red5/server/api/IOnDemandStream.java (revision 499)
+++ /java/server/branches/red5_refactor/src/org/red5/server/api/IOnDemandStream.java (revision 503)
@@ -21,5 +21,5 @@
 
 /**
- * Extends stream to add methods for on demand access
+ * Extends stream to add methods for on demand access.
  * 
  * @author The Red5 Project (red5 at osflash.org)