Lots of javadoc comments.

1 files changed, 24 insertions, 1 deletions

diff --git a/java/src/Ice/LoggerPlugin.java b/java/src/Ice/LoggerPlugin.java
index 3e0bbc6c94c..e9f3ddbc7d1 100644
--- a/java/src/Ice/LoggerPlugin.java
+++ b/java/src/Ice/LoggerPlugin.java
@@ -9,8 +9,22 @@
 
 package Ice;
 
+/**
+ * Class to support custom loggers. Applications using a custom logger
+ * instantiate a <code>LoggerPlugin</code> with a custom logger and
+ * return the instance from their <code>PluginFactory</code> implementation.
+ *
+ * @see PluginFactory
+ * @see Plugin
+ **/
 public class LoggerPlugin implements Ice.Plugin
 {
+    /**
+     * Installs a custom logger for a communicator.
+     *
+     * @param communicator The communicator using the custom logger.
+     * @param logger The custom logger for the communicator.
+     **/
     public 
     LoggerPlugin(Communicator communicator, Logger logger)
     {
@@ -32,14 +46,23 @@ public class LoggerPlugin implements Ice.Plugin
         instance.setLogger(logger);
     }
 
+    /**
+     * Called by the Ice run time during communicator initialization. The derived class
+     * can override this method to perform any initialization that might be required
+     * by a custom logger.
+     **/
     public void 
     initialize()
     {
     }
 
+    /**
+     * Called by the Ice run time when the communicator is destroyed. The derived class
+     * can override this method to perform any finalization that might be required
+     * by a custom logger.
+     **/
     public void
     destroy()
     {
     }
 }
-