svn commit: r583801 - /maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/module/AbstractIdentityTest.java

[ltheussl]

Author: ltheussl
Date: Thu Oct 11 05:30:33 2007
New Revision: 583801

URL: http://svn.apache.org/viewvc?rev=583801&view=rev
Log:
Minor tweaks, javadocs.

Modified:
    
maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/module/AbstractIdentityTest.java

Modified: 
maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/module/AbstractIdentityTest.java
URL: 
http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/module/AbstractIdentityTest.java?rev=583801&r1=583800&r2=583801&view=diff
==============================================================================
--- 
maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/module/AbstractIdentityTest.java
 (original)
+++ 
maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/module/AbstractIdentityTest.java
 Thu Oct 11 05:30:33 2007
@@ -50,7 +50,7 @@
 
     /**
      * Create a new instance of the parser to test.
-     * 
+     *
      * @return the parser to test.
      */
     protected abstract Parser createParser();
@@ -67,9 +67,11 @@
      * Pipes a full model generated by [EMAIL PROTECTED] SinkTestDocument} 
through
      * a Sink (generated by [EMAIL PROTECTED] #createSink(Writer)}) and a 
Parser
      * (generated by [EMAIL PROTECTED] #createParser()}) and checks if the 
result
-     * is the same as the original model. Currently, this doesn't actually
-     * assert anything, but the two generated output files, expected.txt
-     * and actual.txt can be compared for differences.
+     * is the same as the original model. By default, this doesn't actually
+     * assert anything (use [EMAIL PROTECTED] #assertIdentity(boolean)} in the 
setUp()
+     * of an implementation to switch on the test), but the two generated
+     * output files, expected.txt and actual.txt, can be compared for 
differences.
+     *
      * @throws IOException if there's a problem reading/writing a test file.
      * @throws ParseException if a model cannot be parsed.
      */
@@ -90,7 +92,7 @@
             String expected = writer.toString();
 
             // write to file for comparison
-            fileWriter = getTestWriter( "expected", "txt" );
+            fileWriter = getTestWriter( "expected" );
             fileWriter.write( expected );
             fileWriter.flush();
 
@@ -105,7 +107,7 @@
             String actual = writer.toString();
 
             // write to file for comparison
-            fileWriter = getTestWriter( "actual", "txt" );
+            fileWriter = getTestWriter( "actual" );
             fileWriter.write( actual );
             fileWriter.flush();
 
@@ -146,13 +148,14 @@
     }
 
     /**
-     * Not used here, just required by AbstractModuleTest.
+     * The output files generated by this class are text files,
+     * independend of the kind of module being tested.
      *
-     * @return An empty String.
+     * @return The String "txt".
      */
     protected String outputExtension()
     {
-        return "";
+        return "txt";
     }
 
     /**