aboutsummaryrefslogtreecommitdiff
path: root/src/cz/crcs/ectester/common/output/TestWriter.java
diff options
context:
space:
mode:
authorJ08nY2018-03-03 19:13:04 +0100
committerJ08nY2018-03-03 19:13:04 +0100
commit30210ec562a49d1b397a19d8c64ed0e0fd80cc0e (patch)
tree9d9d5be4c7ff2dd7023d6933039eafa2402adfbf /src/cz/crcs/ectester/common/output/TestWriter.java
parent6e93b823e5a3aaab738af143d9c1ed07d8c56fcd (diff)
downloadECTester-30210ec562a49d1b397a19d8c64ed0e0fd80cc0e.tar.gz
ECTester-30210ec562a49d1b397a19d8c64ed0e0fd80cc0e.tar.zst
ECTester-30210ec562a49d1b397a19d8c64ed0e0fd80cc0e.zip
Add some docs and fix ECTesterReader --bit-size option.
Diffstat (limited to '')
-rw-r--r--src/cz/crcs/ectester/common/output/TestWriter.java8
1 files changed, 7 insertions, 1 deletions
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);