Skip to content

Commit

Permalink
add atrium-cc-de_CH-robstoll to packages.md
Browse files Browse the repository at this point in the history
and have a look over the module descriptions one more time.
  • Loading branch information
robstoll committed Jul 16, 2018
1 parent 947e38c commit 08a0f2e
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions misc/kdoc/packages.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,19 @@ Atrium is built up by different modules. The packages shown below contain classe
of all modules excluding the one of _atrium-imp-robstoll_ and _atrium-imp-robstoll-lib_.

API modules:
- **atrium-cc-en_UK-robstoll** can be used as "shortcut" -- it defines dependencies on
atrium-api-code-completion-en_UK, atrium-translations-en_UK and atrium-core-impl-robstoll
- **atrium-cc-de_CH-robstoll** represents a convenience module which bundles other dependencies -- it defines
to have a dependency on atrium-api-code-completion-de_CH, atrium-translations-de_CH and atrium-core-impl-robstoll
- **atrium-cc-en_UK-robstoll** represents a convenience module which bundles other dependencies -- it defines
to have a dependency on atrium-api-code-completion-en_UK, atrium-translations-en_UK and atrium-core-impl-robstoll
- **atrium-api-code-completion-de_CH** provides an assertion function API in German where the main
focus of this API's design is put on ease of use/compatibility with code completion functionality of an IDE.
- **atrium-api-code-completion-en_UK** provides an assertion function API in English where the main
focus of this API's design is put on ease of use/compatibility with code completion functionality of an IDE.


Assertion modules:
- **atrium-assertions** contains all functions which can be used to create assertions as well as the
- **atrium-assertions** contains all [impl-functions](https://github.com/robstoll/atrium#api-in-a-different-language)
and builder templates which can be used to create an API. Moreover it contains the
[ReporterBuilder](./ch.tutteli.atrium.reporting/-reporter-builder/index.html).
- **atrium-translations-de_CH** provides translations in German for
[ITranslatable](./ch.tutteli.atrium.reporting.translating/-i-translatable/index.html)s used in assertion functions.
Expand All @@ -26,15 +29,15 @@ Core modules:
- **atrium-core-api** defines the contracts of the core of Atrium.
- **atrium-core-api-late-binding** defines the contract for
[AtriumFactory](./ch.tutteli.atrium/-atrium-factory/index.html)
by providing dummy implementations which are eventually replaced by an atrium implementation.
by providing a dummy implementation which eventually needs to be replaced by a real implementation.
- **atrium-core-impl-robstoll** provides an [AtriumFactory](./ch.tutteli.atrium/-atrium-factory/index.html)
which uses the implementations of *atrium-impl-robstoll-lib*
- **atrium-core-impl-robstoll-lib** [robstoll](https://github.com/robstoll)'s implementation of atrium.
- **atrium-core-impl-robstoll-lib** [robstoll](https://github.com/robstoll)'s implementation of the core of Atrium.

Misc modules:
- **atrium-spec** contains [Spek](http://spekframework.org/) specifications for interfaces (defined in
_atrium-core-api_) and assertion functions which can be reused by Atrium implementations
and assertion function API implementations to assure they fulfill the specifications.
_atrium-core-api_) and assertion functions. The specifications can be reused by implementation of the core of Atrium
as well as by API implementations to assure they fulfill the specifications.

# Package ch.tutteli.atrium
Contains the [IAtriumFactory](./ch.tutteli.atrium/-i-atrium-factory/index.html).
Expand Down

0 comments on commit 08a0f2e

Please sign in to comment.