Changeset 870 for trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitor.java

Timestamp:

10/12/12 14:04:09 (12 years ago)

Author:

pharms

Message:

• added some comments

File:

• trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitor.java (modified) (2 diffs)

trunk/autoquest-htmlmonitor/src/main/java/de/ugoe/cs/autoquest/htmlmonitor/HtmlMonitor.java

@@ -5 +5 @@
 /**
  * <p>
- * TODO comment
+ * The HTML monitor starts a web server ({@link HtmlMonitorServer}) that receives log messages
+ * of the HTML monitor java script. These messages are logged using the
+ * {@link HtmlMonitorLogManager}. The class assures that on shutdown e.g. caused by CTRL-C the
+ * server and the log manager are stopped correctly.
  * </p>
  * 
@@ -12 +15 @@
 public class HtmlMonitor implements HtmlMonitorComponent {
 
-    /** */
+    /**
+     * the port on which the webserver shall listen. Defaults to 8090.
+     */
     private int port = 8090;
     
-    /** */
+    /**
+     * the web server receiving the log messages
+     */
     private HtmlMonitorServer server;
     
-    /** */
+    /**
+     * the directory into which the log files shall be written
+     */
     private String logFileBaseDir;
 
-    /** */
+    /**
+     * the log manager being responsible for performing the logging
+     */
     private HtmlMonitorLogManager logManager;
 
-    /** */
+    /**
+     * the thread needed to handle CTRL-C events
+     */
     private Thread shutdownHook;
 
     /**
      * <p>
-     * TODO: comment
+     * initializes the monitor with the command line arguments. Those may be the log directory
+     * as first argument and the port to listen on as second
      * </p>
      *
-     * @param logFileBaseDir
+     * @param commandLineArguments the command line arguments when starting the monitor using
+     *                             the {@link Runner}
      */
-    HtmlMonitor(String[] commandLineArguments) {
+    public HtmlMonitor(String[] commandLineArguments) {
         if (commandLineArguments.length > 0) {
             this.logFileBaseDir = commandLineArguments[0];