From 4614c3d0d6a5017f881d9cedddbd4b97cd80d2a0 Mon Sep 17 00:00:00 2001 From: Fuwn Date: Sun, 6 Jun 2021 21:07:53 -0700 Subject: docs(whirl_api): document public functions --- crates/whirl_api/src/lib.rs | 3 +++ 1 file changed, 3 insertions(+) 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. -- cgit v1.2.3