Add module documentation for kotlin.test

2017-05-19 14:19:28 +02:00
parent 17869abfaf
commit 927cd04405
1 changed files with 10 additions and 0 deletions
@@ -0,0 +1,10 @@
+# Module kotlin.test
+
+## kotlin.test
+
+kotlin.test provides a set of utility functions for performing assertions in tests, independently of the test framework
+being used. The functions are defined as  [top-level functions in the package](kotlin.test/index.html#functions).
+
+The test framework is abstracted through the [Asserter] class. A basic [Asserter] implementation is provided out of the
+box. The `kotlin-test-junit` module provides an implementation of [Asserter] on top of JUnit. Note that the class is not intended
+to be used directly from tests.