svn commit: r707980 - /maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/AbstractModuleTest.java

[vs...@apache.org]

Author: vsiveton
Date: Sun Oct 26 05:29:41 2008
New Revision: 707980

URL: http://svn.apache.org/viewvc?rev=707980&view=rev
Log:
o improved javadoc

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

Modified: maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/AbstractModuleTest.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/AbstractModuleTest.java?rev=707980&r1=707979&r2=707980&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/AbstractModuleTest.java (original)
+++ maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/AbstractModuleTest.java Sun Oct 26 05:29:41 2008
@@ -42,8 +42,12 @@
     implements Markup
 {
     /**
-     * Set the system property <code>line.separator</code> to <code>\n</code> (Unix) to prevent
-     * failure on windows.
+     * Set the system properties:
+     * <ul>
+     * <li><code>line.separator</code> to <code>\n</code> (Unix) to prevent
+     * failure on windows.</li>
+     * <li><code>file.encoding</code> to <code>UTF-8</code>.</li>
+     * </ul>
      */
     static
     {
@@ -64,6 +68,7 @@
      * @param extension The file extension of the file to write.
      * @return A FileWriter.
      * @throws IOException If the FileWriter could not be generated.
+     * @see WriterFactory#newWriter(File, String)
      */
     protected Writer getTestWriter( String baseName, String extension )
         throws IOException
@@ -102,6 +107,7 @@
      * @param extension The file extension of the file to write.
      * @return An XML FileWriter.
      * @throws IOException If the FileWriter could not be generated.
+     * @see WriterFactory#newXmlWriter(File)
      */
     protected Writer getXmlTestWriter( String baseName, String extension )
         throws IOException
@@ -161,6 +167,7 @@
      *
      * @param baseName The name of the resource file to read.
      * @return An InputStreamReader.
+     * @see #getTestReader(String, String)
      */
     protected Reader getTestReader( String baseName )
     {
@@ -211,5 +218,4 @@
      * @return The test output directory, relative to outputBaseDir().
      */
     protected abstract String getOutputDir();
-
 }