[Red5commits] [1591] fixed a few javadoc warnings

[jbauch]

fixed a few javadoc warnings


Timestamp: 12/18/06 13:20:47 EST (1 month ago) 
Change: 1591 
Author: jbauch

Files (see diff or trac for details): 
java/server/trunk/src/org/red5/server/adapter/ApplicationAdapter.java
java/server/trunk/src/org/red5/server/api/cache/ICacheStore.java
java/server/trunk/src/org/red5/server/cache/EhCacheImpl.java
java/server/trunk/src/org/red5/server/cache/WhirlyCacheImpl.java
java/server/trunk/src/org/red5/server/script/jython/JythonScriptFactory.java


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

Index: /java/server/trunk/src/org/red5/server/adapter/ApplicationAdapter.java
===================================================================
--- /java/server/trunk/src/org/red5/server/adapter/ApplicationAdapter.java (revision 1590)
+++ /java/server/trunk/src/org/red5/server/adapter/ApplicationAdapter.java (revision 1591)
@@ -172,5 +172,5 @@
 	 * scope is room or app level scope, this method distinguishes it and acts
 	 * accordingly. You override
-	 * {@link ApplicationAdapter#appConnect(IConnection, Object[]))} or
+	 * {@link ApplicationAdapter#appConnect(IConnection, Object[])} or
 	 * {@link ApplicationAdapter#roomConnect(IConnection, Object[])}} in your
 	 * application to make it act the way you want.
@@ -236,8 +236,4 @@
 	 * @param scope
 	 *            Scope
-	 * @param params
-	 *            List of params passed to connection handler
-	 * @return <code>true</code> if disconnect is successful,
-	 *         <code>false</code> otherwise
 	 */
 	@Override
@@ -256,5 +252,5 @@
 	 * level scope and stops room handling if given scope has lower scope
 	 * level). This method calls {@link ApplicationAdapter#appStop(IScope)} or
-	 * {@link ApplicationAdapter#roomStop(IScope))} handlers respectively.
+	 * {@link ApplicationAdapter#roomStop(IScope)} handlers respectively.
 	 * 
 	 * @param scope
@@ -275,5 +271,5 @@
 	 * applied to both application scope and scopes of lower level. This method
 	 * calls {@link ApplicationAdapter#appJoin(IClient, IScope)} or
-	 * {@link ApplicationAdapter#roomJoin(IClient, IScope))} handlers
+	 * {@link ApplicationAdapter#roomJoin(IClient, IScope)} handlers
 	 * respectively.
 	 * 
@@ -326,9 +322,8 @@
 	 * make it act the way you want.
 	 * 
-	 * @param scope
-	 *            Scope object
+     * @param app
+	 *            Application scope object
 	 * @return <code>true</code> if scope can be started, <code>false</code>
 	 *         otherwise
-     * @param app
 	 */
 	public boolean appStart(IScope app) {
@@ -526,8 +521,7 @@
 	 * Handler method. Called every time client leaves room scope.
 	 * 
-	 * @param conn
-	 *            Disconnected connection object
+	 * @param client
+	 *            Disconnected client object
      * @param room
-     * @param client
 	 */
 	public void roomLeave(IClient client, IScope room) {
Index: /java/server/trunk/src/org/red5/server/cache/EhCacheImpl.java
===================================================================
--- /java/server/trunk/src/org/red5/server/cache/EhCacheImpl.java (revision 1555)
+++ /java/server/trunk/src/org/red5/server/cache/EhCacheImpl.java (revision 1591)
@@ -45,5 +45,5 @@
  * Provides an implementation of an object cache using EhCache.
  * 
- * @see http://ehcache.sourceforge.net/
+ * @see <a href="http://ehcache.sourceforge.net/">ehcache homepage</a>
  * 
  * @author The Red5 Project (red5 at osflash.org)
Index: /java/server/trunk/src/org/red5/server/cache/WhirlyCacheImpl.java
===================================================================
--- /java/server/trunk/src/org/red5/server/cache/WhirlyCacheImpl.java (revision 1555)
+++ /java/server/trunk/src/org/red5/server/cache/WhirlyCacheImpl.java (revision 1591)
@@ -39,5 +39,5 @@
  * Provides an implementation of an object cache using whirlycache.
  * 
- * @see https://whirlycache.dev.java.net/
+ * @see <a href="https://whirlycache.dev.java.net/">whirlycache homepage</a>
  * 
  * @author The Red5 Project (red5 at osflash.org)
Index: /java/server/trunk/src/org/red5/server/script/jython/JythonScriptFactory.java
===================================================================
--- /java/server/trunk/src/org/red5/server/script/jython/JythonScriptFactory.java (revision 1519)
+++ /java/server/trunk/src/org/red5/server/script/jython/JythonScriptFactory.java (revision 1591)
@@ -18,5 +18,5 @@
  * 
  * @author Yan Weng
- * @see http://yanweng.blogspot.com/2006/02/prototype-of-jython-scriptfactory-for.html
+ * @see <a href="http://yanweng.blogspot.com/2006/02/prototype-of-jython-scriptfactory-for.html">A prototype of Jython ScriptFactory for Spring Framework</a>
  */
 public class JythonScriptFactory implements ScriptFactory {
Index: /java/server/trunk/src/org/red5/server/api/cache/ICacheStore.java
===================================================================
--- /java/server/trunk/src/org/red5/server/api/cache/ICacheStore.java (revision 1590)
+++ /java/server/trunk/src/org/red5/server/api/cache/ICacheStore.java (revision 1591)
@@ -29,8 +29,8 @@
  * <p>
  * 
- * @see http://www-128.ibm.com/developerworks/java/library/j-jtp01246.html
- * @see http://java.sun.com/developer/technicalArticles/ALT/RefObj/
- * @see http://www.onjava.com/pub/a/onjava/2002/10/02/javanio.html?page=3
- * @see http://csci.csusb.edu/turner/archive/courses/aiit2004/proxy_cache_solution.html
+ * @see <a href="http://www-128.ibm.com/developerworks/java/library/j-jtp01246.html">Soft references provide for quick-and-dirty caching</a>
+ * @see <a href="http://java.sun.com/developer/technicalArticles/ALT/RefObj/">Reference Objects and Garbage Collection</a>
+ * @see <a href="http://www.onjava.com/pub/a/onjava/2002/10/02/javanio.html?page=3">Top Ten New Things You Can Do with NIO</a>
+ * @see <a href="http://csci.csusb.edu/turner/archive/courses/aiit2004/proxy_cache_solution.html">http://csci.csusb.edu/turner/archive/courses/aiit2004/proxy_cache_solution.html</a>
  *      </p>
  * 


Note:
Diffs are chopped if more than 25k.
This is to get past the limit on the mailing list.