Clean-up, docs

[cql-java-moved-to-github.git] / src / test / java / org / z3950 / zing / cql / CQLParserTest.java

diff --git a/src/test/java/org/z3950/zing/cql/CQLParserTest.java b/src/test/java/org/z3950/zing/cql/CQLParserTest.java
index 7e258e0..61b112b 100644 (file)
--- a/src/test/java/org/z3950/zing/cql/CQLParserTest.java
+++ b/src/test/java/org/z3950/zing/cql/CQLParserTest.java
@@ -103,6 +103,19 @@ public class CQLParserTest {
     }
   }
   
+  /**
+   * Test the integrity of the parser as follows:
+   * - Generate a random tree with CQLGenerator
+   * - Serialize it
+   * - Canonicalise it by running through the parser
+   * - Compare the before-and-after versions.
+   * Since the CQLGenerator output is in canonical form anyway, the
+   * before-and-after versions should be identical.  This process exercises
+   * the comprehensiveness and bullet-proofing of the parser, as well as
+   * the accuracy of the rendering.
+   * @throws IOException
+   * @throws MissingParameterException 
+   */
   @Test
   public void testRandomQueries() throws IOException, MissingParameterException {
     out.println("Testing the parser using 100 randomly generated queries...");
@@ -128,7 +141,6 @@ public class CQLParserTest {
     }
   }
   
-  
   //helper methods follow
   //TODO move to masterkey-common