Skip to content

Commit 727be8f

Browse files
committed
Add JavaDoc for top-level Spectrum class
1 parent 8c0eb89 commit 727be8f

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/main/java/com/greghaskins/spectrum/Spectrum.java

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,19 @@
99
import java.util.concurrent.ConcurrentHashMap;
1010
import java.util.function.Supplier;
1111

12+
/**
13+
* Implements a BDD-style test runner, similar to RSpec and Jasmine. It uses JUnit's standard
14+
* reporting mechanisms ({@link org.junit.runner.Description}), but provides a completely different
15+
* way of writing tests. Annotate you class with {@code @RunWith(Spectrum.class)}, and use the
16+
* static methods to declare your specs.
17+
*
18+
* @see #describe
19+
* @see #it
20+
* @see #beforeEach
21+
* @see #afterEach
22+
* @see #let
23+
*
24+
*/
1225
public final class Spectrum extends Runner {
1326

1427
/**

0 commit comments

Comments
 (0)