renamed server to listener and add thorough documentation

[connect-rs.git] / src / tcp / mod.rs

diff --git a/src/tcp/mod.rs b/src/tcp/mod.rs
index fbc24b29449e141e9f9522f6c285330cc93e4ac9..654f1ca3112dbc372ba7bb2f1f5adb07f92d3c1d 100644 (file)
--- a/src/tcp/mod.rs
+++ b/src/tcp/mod.rs
@@ -1,5 +1,15 @@
+//! TCP transport client and listener implementations.
+//!
+//! <br/>
+//!
+//! This module primarily exposes the TCP client implementation over a [`Connection`] type and the
+//! TCP listener implementation as [`TcpListener`].
+
+#[allow(unused_imports)]
+pub(crate) use crate::Connection;
+
 pub(crate) mod client;
-pub(crate) mod server;
+pub(crate) mod listener;
 
 pub use client::*;
-pub use server::*;
+pub use listener::*;