Changeset 1276 for trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/commands/CMDcompressHTMLLogFiles.java

Timestamp:

07/26/13 09:20:36 (11 years ago)

Author:

pharms

Message:

• added some Java Docs

File:

• trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/commands/CMDcompressHTMLLogFiles.java (modified) (4 diffs)

trunk/autoquest-plugin-html/src/main/java/de/ugoe/cs/autoquest/plugin/html/commands/CMDcompressHTMLLogFiles.java

@@ -25 +25 @@
 /**
  * <p>
- * TODO comment
+ * This command performs a compression of HTML log files. It traverse a directory structure. All
+ * files in the same directory are treated as HTML log files. They are parsed and all GUI elements
+ * and events contained in them are dumped into a new log file. No GUI element is dumped more than
+ * once. Through this, several log files containing duplicates of GUI elements are condensed to 
+ * only one. The events are put at the end of the new log file and are sorted based on their time
+ * stamp. 
  * </p>
  * 
@@ -33 +38 @@
 public class CMDcompressHTMLLogFiles implements Command {
 
-    /*
-     * (non-Javadoc)
-     * 
+    /* (non-Javadoc)
      * @see de.ugoe.cs.util.console.Command#run(java.util.List)
      */
@@ -60 +63 @@
 
     /**
+     * <p>
+     * convenience method for recursively calling the {@link HTMLLogCompressor} for each directory
+     * </p>
      * 
+     * @param the directory to be traversed
      */
     private void compressDirectory(File directory) {
@@ -81 +88 @@
     }
 
-    /*
-     * (non-Javadoc)
-     * 
+    /* (non-Javadoc)
      * @see de.ugoe.cs.util.console.Command#help()
      */