diff options
| author | Fuwn <[email protected]> | 2021-06-06 21:07:53 -0700 |
|---|---|---|
| committer | Fuwn <[email protected]> | 2021-06-06 21:07:53 -0700 |
| commit | 4614c3d0d6a5017f881d9cedddbd4b97cd80d2a0 (patch) | |
| tree | c7927a56bae48a85020fa0ac4ccdf37976c783fe | |
| parent | refactor(whirl_server): un-publicize distributor and hub structs (diff) | |
| download | whirl-4614c3d0d6a5017f881d9cedddbd4b97cd80d2a0.tar.xz whirl-4614c3d0d6a5017f881d9cedddbd4b97cd80d2a0.zip | |
docs(whirl_api): document public functions
| -rw-r--r-- | crates/whirl_api/src/lib.rs | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/crates/whirl_api/src/lib.rs b/crates/whirl_api/src/lib.rs index e6660a7..882beeb 100644 --- a/crates/whirl_api/src/lib.rs +++ b/crates/whirl_api/src/lib.rs @@ -64,6 +64,9 @@ impl Api { } } +/// Spawn and return a thread handle for the API -- which +/// should be -- instantiated by the `whirl_api` crate. +/// /// # Panics /// - A panic may occur if the mpsc sender is unable to send a clone of the /// server. |