Skip to content

Commit

Permalink
Add JavaDoc for top-level Spectrum class
Browse files Browse the repository at this point in the history
  • Loading branch information
greghaskins committed Nov 25, 2016
1 parent 8c0eb89 commit 727be8f
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions src/main/java/com/greghaskins/spectrum/Spectrum.java
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,19 @@
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Supplier;

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

/**
Expand Down

0 comments on commit 727be8f

Please sign in to comment.