more docstrings

rerun-io · Apr 14, 2023 · c9949ea · c9949ea
1 parent 20ef645
commit c9949ea
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/crates/re_ws_comms/src/server.rs b/crates/re_ws_comms/src/server.rs
@@ -32,6 +32,7 @@ pub enum RerunServerError {
     TokioIoError(#[from] tokio::io::Error),
 }
 
+/// Websocket host for relaying [`LogMsg`]s to a web viewer.
 pub struct RerunServer {
     listener: TcpListener,
     port: u16,
@@ -89,6 +90,9 @@ impl RerunServer {
     }
 }
 
+/// Sync handle for the [`RerunServer`]
+///
+/// When dropped, the server will be shut down.
 pub struct RerunServerHandle {
     port: u16,
     shutdown_tx: tokio::sync::broadcast::Sender<()>,