[Red5commits] [1598] Tomcat loader documented

[mklishin]

Tomcat loader documented


Timestamp: 12/23/06 09:13:33 EST (1 month ago) 
Change: 1598 
Author: mklishin

Files (see diff or trac for details): 
java/server/trunk/src/org/red5/server/TomcatLoader.java


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

Index: /java/server/trunk/src/org/red5/server/TomcatLoader.java
===================================================================
--- /java/server/trunk/src/org/red5/server/TomcatLoader.java (revision 1590)
+++ /java/server/trunk/src/org/red5/server/TomcatLoader.java (revision 1598)
@@ -20,14 +20,5 @@
  */
 
-import java.io.File;
-import java.io.FilenameFilter;
-import java.util.List;
-import java.util.Map;
-
-import org.apache.catalina.Container;
-import org.apache.catalina.Engine;
-import org.apache.catalina.Host;
-import org.apache.catalina.Realm;
-import org.apache.catalina.Valve;
+import org.apache.catalina.*;
 import org.apache.catalina.connector.Connector;
 import org.apache.catalina.core.StandardHost;
@@ -38,4 +29,12 @@
 import org.springframework.context.ApplicationContextAware;
 
+import java.io.File;
+import java.io.FilenameFilter;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Red5 loader for Tomcat
+ */
 public class TomcatLoader implements ApplicationContextAware {
 	// Initialize Logging
@@ -189,6 +188,6 @@
 
     /**
-     *
-     * @return
+     * Return Tomcat engine
+     * @return          Tomcat engine
      */
 	public Engine getEngine() {
@@ -197,6 +196,6 @@
 
     /**
-     *
-     * @param engine
+     * Set Tomcat engine implementation
+     * @param engine    Tomcat engine
      */
 	public void setEngine(Engine engine) {
@@ -206,6 +205,6 @@
 
     /**
-     *
-     * @return
+     * Get base host
+     * @return      Base host
      */
 	public Host getBaseHost() {
@@ -214,6 +213,6 @@
 
     /**
-     *
-     * @param baseHost
+     * Set base host
+     * @param baseHost          Base host
      */
 	public void setBaseHost(Host baseHost) {
@@ -222,11 +221,16 @@
 	}
 
-	public Embedded getEmbedded() {
+	/**
+     * Getter for embedded object
+     *
+     * @return  Embedded object
+     */
+    public Embedded getEmbedded() {
 		return embedded;
 	}
 
     /**
-     *
-     * @param embedded
+     * Setter for embedded object
+     * @param embedded   Embedded object
      */
 	public void setEmbedded(Embedded embedded) {
@@ -236,6 +240,6 @@
 
     /**
-     *
-     * @return
+     * Return connector
+     * @return         Connector
      */
 	public Connector getConnector() {
@@ -244,6 +248,6 @@
 
     /**
-     *
-     * @param connector
+     * Set connector
+     * @param connector    Connector
      */
 	public void setConnector(Connector connector) {
@@ -255,5 +259,5 @@
 	 * Set additional connectors
 	 * 
-	 * @param connectors
+	 * @param connectors         Additional connectors
 	 */
 	public void setConnectors(List<Connector> connectors) {


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