1.1 --- a/rt/vmtest/src/main/java/org/apidesign/bck2brwsr/vmtest/VMTest.java Tue Feb 26 16:54:16 2013 +0100
1.2 +++ b/rt/vmtest/src/main/java/org/apidesign/bck2brwsr/vmtest/VMTest.java Thu Feb 28 21:35:55 2013 +0100
1.3 @@ -17,22 +17,35 @@
1.4 */
1.5 package org.apidesign.bck2brwsr.vmtest;
1.6
1.7 +import org.apidesign.bck2brwsr.launcher.Launcher;
1.8 import org.apidesign.bck2brwsr.vmtest.impl.CompareCase;
1.9 import org.testng.annotations.Factory;
1.10
1.11 -/** A TestNG {@link Factory} that seeks for {@link Compare} annotations
1.12 - * in provided class and builds set of tests that compare the computations
1.13 - * in real as well as JavaScript virtual machines. Use as:<pre>
1.14 +/** A TestNG {@link Factory} that seeks for {@link Compare} and {@link BrwsrTest} annotations
1.15 + * in provided class and builds set of tests that verify the functionality of <b>Bck2Brwsr</b>
1.16 + * based system. Use as:
1.17 + * <pre>
1.18 * {@code @}{@link Factory} public static create() {
1.19 - * return @{link VMTest}.{@link #create(YourClass.class);
1.20 + * return @{link VMTest}.{@link #create(java.lang.Class) create}(YourClass.class);
1.21 * }</pre>
1.22 - *
1.23 + * where <code>YourClass</code> contains methods annotated with
1.24 + * {@link Compare} and {@link BrwsrTest} annotations.
1.25 + *
1.26 * @author Jaroslav Tulach <jtulach@netbeans.org>
1.27 */
1.28 public final class VMTest {
1.29 - /** Inspects <code>clazz</code> and for each {@lik Compare} method creates
1.30 - * instances of tests. Each instance runs the test in different virtual
1.31 + private VMTest() {
1.32 + }
1.33 +
1.34 + /** Inspects <code>clazz</code> and for each method annotated by
1.35 + * {@link Compare} or {@link BrwsrTest} creates
1.36 + * instances of tests.
1.37 + * <p>
1.38 + * Each {@link Compare} instance runs the test in different virtual
1.39 * machine and at the end they compare the results.
1.40 + * <p>
1.41 + * Each {@link BrwsrTest} annotated method is executed once in {@link Launcher started
1.42 + * browser}.
1.43 *
1.44 * @param clazz the class to inspect
1.45 * @return the set of created tests