From 5e85f71e487879818ff7d1c6b2a796124f3e03a0 Mon Sep 17 00:00:00 2001 From: Ilya Gorbunov Date: Mon, 27 Nov 2017 06:39:35 +0300 Subject: [PATCH] Improve cover documentation page of kotlin.test library --- libraries/kotlin.test/Module.md | 27 ++++++++++++++++++++++----- 1 file changed, 22 insertions(+), 5 deletions(-) diff --git a/libraries/kotlin.test/Module.md b/libraries/kotlin.test/Module.md index b4f04a5f316..ec0f1b0f1eb 100644 --- a/libraries/kotlin.test/Module.md +++ b/libraries/kotlin.test/Module.md @@ -2,9 +2,26 @@ ## 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). +`kotlin.test` library provides [annotations](kotlin.test/index.html#annotations) to mark test functions and a set of [utility functions](kotlin.test/index.html#functions) for performing assertions in tests, +independently of the test framework being used. -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. +The test framework is abstracted through the [Asserter][kotlin.test.Asserter] class. +A basic `Asserter` implementation is provided out of the box. +Note that the class is not intended to be used directly from tests, +use instead the top-level assertion functions which delegate to the `Asserter`. + +The library consists of the modules: + +- `kotlin-test-common` – assertions for use in common code; +- `kotlin-test-annotations-common` – test annotations for use in common code; +- `kotlin-test` – a JVM implementation of assertions from `kotlin-test-common`; +- `kotlin-test-junit` – provides an implementation of [Asserter] on top of JUnit + and maps the test annotations from `kotlin-test-annotations-common` to JUnit test annotations; +- `kotlin-test-js` – a JS implementation of common test assertions and annotations + with the out-of-the-box support for [Jasmine](https://jasmine.github.io/), [Mocha](https://mochajs.org/), + and [Jest](https://facebook.github.io/jest/) testing frameworks, and an experimental way to plug in + a custom unit testing framework. + +# Package kotlin.test + +Annotations to mark test functions and top-level functions for performing assertions in tests. \ No newline at end of file