From 30210ec562a49d1b397a19d8c64ed0e0fd80cc0e Mon Sep 17 00:00:00 2001
From: J08nY
Date: Sat, 3 Mar 2018 19:13:04 +0100
Subject: Add some docs and fix ECTesterReader --bit-size option.

---
 src/cz/crcs/ectester/common/output/TestWriter.java | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

(limited to 'src/cz/crcs/ectester/common/output/TestWriter.java')

diff --git a/src/cz/crcs/ectester/common/output/TestWriter.java b/src/cz/crcs/ectester/common/output/TestWriter.java
index 5fa7f67..7de23a5 100644
--- a/src/cz/crcs/ectester/common/output/TestWriter.java
+++ b/src/cz/crcs/ectester/common/output/TestWriter.java
@@ -8,7 +8,13 @@ import cz.crcs.ectester.common.test.TestSuite;
  */
 public interface TestWriter {
     /**
-     * @param suite
+     * Begin writing the <code>TestSuite suite</code>.
+     * This should reset all the internal state of the writer
+     * and prepare it to output tests from <code>suite</code>.
+     * It may also write any header part of the output of the
+     * writer but doesn't have to.
+     *
+     * @param suite The <code>TestSuite</code> to start writing.
      */
     void begin(TestSuite suite);
 
-- 
cgit v1.2.3-70-g09d2