- Restructured docs

This commit is contained in:
Tristan B. Velloza Kildaire 2023-03-19 13:37:45 +02:00
parent eb0404351b
commit a4509f64c0
3 changed files with 11 additions and 3 deletions

7
docs/api/event.md Normal file
View File

@ -0,0 +1,7 @@
Event
=====
## The `Event` type
The `Event` type is at the core of the libsnooze system and is what provides the "wait/notify" mechanism, i.e. a group of threads _wait_
on an `Event` and another thread _notifies_ that `Event` to wake those waiting threads up.

View File

@ -5,10 +5,7 @@ There isn't all too much in terms of the methods exposed via the API as the func
are, however, some methods of interest and some important things to note when using them.
## The `Event` type
The `Event` type is at the core of the libsnooze system and is what provides the "wait/notify" mechanism, i.e. a group of threads _wait_
on an `Event` and another thread _notifies_ that `Event` to wake those waiting threads up.
## Methods

4
docs/api/usage.md Normal file
View File

@ -0,0 +1,4 @@
Usage
=====
We'll now make an example that uses these ideas of the `Event` type and its associated objects.