Skip to content

Commit feebf3b

Browse files
Add documentation
1 parent 8f9c1b1 commit feebf3b

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

compiler/test/dotty/tools/vulpix/TestGroup.scala

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
package dotty.tools.vulpix
22

3+
/** Test groups are used to ensure that the ouput of tests do not overlap.
4+
*
5+
* It can be used to disambiguate ouputs of tests that test the same file but with different options as shown in the following example.
6+
* compileFilesInDir("../tests/pos", defaultOptions)(TestGroup("compileStdLib")) // will output in ./out/compileStdLib/...
7+
* compileFilesInDir("../tests/pos", defaultOptimised)(TestGroup("optimised/testOptimised")) // will output in ./out/optimised/testOptimised/...
8+
*/
39
class TestGroup(val name: String) extends AnyVal {
410
override def toString: String = name
511
}

0 commit comments

Comments
 (0)