Javadoc

src/main/java/org/jboss/netty/container/guice/AbstractChannelFactoryProvider.java

@@ -29,6 +29,8 @@ import org.jboss.netty.channel.ChannelFactory;
 import com.google.inject.Provider;
 
 /**
+ * A skeletal {@link Provider} implementation for a {@link ChannelFactory}.
+ *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)
  * @version $Rev$, $Date$

src/main/java/org/jboss/netty/container/guice/ChannelFactoryResource.java

@@ -28,9 +28,14 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.jboss.netty.channel.ChannelFactory;
+
 import com.google.inject.BindingAnnotation;
 
 /**
+ * A parameter or a field annotated with this annotation will be injected with
+ * the resource required to run a {@link ChannelFactory}.
+ *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)
  * @version $Rev$, $Date$

src/main/java/org/jboss/netty/container/guice/NettyModule.java

@@ -26,6 +26,7 @@ import java.util.concurrent.Executor;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 
+import org.jboss.netty.channel.ChannelFactory;
 import org.jboss.netty.channel.local.DefaultLocalClientChannelFactory;
 import org.jboss.netty.channel.local.DefaultLocalServerChannelFactory;
 import org.jboss.netty.channel.local.LocalClientChannelFactory;
@@ -43,9 +44,13 @@ import org.jboss.netty.util.internal.ExecutorUtil;
 import org.jboss.netty.util.internal.UnterminatableExecutor;
 
 import com.google.inject.AbstractModule;
+import com.google.inject.Module;
 import com.google.inject.Scopes;
 
 /**
+ * A Guice {@link Module} that defines the bindings for all known
+ * {@link ChannelFactory}.
+ *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)
  * @version $Rev$, $Date$
@@ -54,6 +59,9 @@ public class NettyModule extends AbstractModule {
 
     private final ExecutorService executor = Executors.newCachedThreadPool();
 
+    /**
+     * Releases all resources created by this module.
+     */
     public void destroy() {
         ExecutorUtil.terminate(executor);
     }

src/main/java/org/jboss/netty/container/guice/NioClientSocketChannelFactoryProvider.java

@@ -27,8 +27,11 @@ import java.util.concurrent.Executor;
 import org.jboss.netty.channel.socket.nio.NioClientSocketChannelFactory;
 
 import com.google.inject.Inject;
+import com.google.inject.Provider;
 
 /**
+ * A {@link Provider} that creates a new {@link NioClientSocketChannelFactory}.
+ *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)
  * @version $Rev$, $Date$

src/main/java/org/jboss/netty/container/guice/NioDatagramChannelFactoryProvider.java

@@ -27,8 +27,11 @@ import java.util.concurrent.Executor;
 import org.jboss.netty.channel.socket.nio.NioDatagramChannelFactory;
 
 import com.google.inject.Inject;
+import com.google.inject.Provider;
 
 /**
+ * A {@link Provider} that creates a new {@link NioDatagramChannelFactory}.
+ *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)
  * @version $Rev$, $Date$

src/main/java/org/jboss/netty/container/guice/NioServerSocketChannelFactoryProvider.java

@@ -27,8 +27,11 @@ import java.util.concurrent.Executor;
 import org.jboss.netty.channel.socket.nio.NioServerSocketChannelFactory;
 
 import com.google.inject.Inject;
+import com.google.inject.Provider;
 
 /**
+ * A {@link Provider} that creates a new {@link NioServerSocketChannelFactory}.
+ *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)
  * @version $Rev$, $Date$

src/main/java/org/jboss/netty/container/guice/OioClientSocketChannelFactoryProvider.java

@@ -27,8 +27,11 @@ import java.util.concurrent.Executor;
 import org.jboss.netty.channel.socket.oio.OioClientSocketChannelFactory;
 
 import com.google.inject.Inject;
+import com.google.inject.Provider;
 
 /**
+ * A {@link Provider} that creates a new {@link OioClientSocketChannelFactory}.
+ *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)
  * @version $Rev$, $Date$

src/main/java/org/jboss/netty/container/guice/OioDatagramChannelFactoryProvider.java

@@ -27,8 +27,11 @@ import java.util.concurrent.Executor;
 import org.jboss.netty.channel.socket.oio.OioDatagramChannelFactory;
 
 import com.google.inject.Inject;
+import com.google.inject.Provider;
 
 /**
+ * A {@link Provider} that creates a new {@link OioDatagramChannelFactory}.
+ *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)
  * @version $Rev$, $Date$

src/main/java/org/jboss/netty/container/guice/OioServerSocketChannelFactoryProvider.java

@@ -27,8 +27,11 @@ import java.util.concurrent.Executor;
 import org.jboss.netty.channel.socket.oio.OioServerSocketChannelFactory;
 
 import com.google.inject.Inject;
+import com.google.inject.Provider;
 
 /**
+ * A {@link Provider} that creates a new {@link OioServerSocketChannelFactory}.
+ *
  * @author The Netty Project (netty-dev@lists.jboss.org)
  * @author Trustin Lee (tlee@redhat.com)
  * @version $Rev$, $Date$