From f1b78d53d7d0009fdef8f0e220bc0c421288c514 Mon Sep 17 00:00:00 2001
From: hozan23 <hozan23@proton.me>
Date: Thu, 23 Nov 2023 00:08:16 +0300
Subject: general clean ups for the docs
---
net/src/connection.rs | 6 +++---
net/src/transports/tcp.rs | 2 +-
net/src/transports/udp.rs | 2 +-
net/src/transports/unix.rs | 2 +-
4 files changed, 6 insertions(+), 6 deletions(-)
(limited to 'net')
diff --git a/net/src/connection.rs b/net/src/connection.rs
index 53bcdeb..950f171 100644
--- a/net/src/connection.rs
+++ b/net/src/connection.rs
@@ -7,10 +7,10 @@ use crate::transports::{tcp, udp, unix};
pub type Conn = Box<dyn Connection>;
/// Connection is a generic network connection interface for
-/// `UdpConn`, `TcpConn`, and `UnixConn`.
+/// [`udp::UdpConn`], [`tcp::TcpConn`], and [`unix::UnixConn`].
///
-/// If you are familiar with the Go language, this is similar to the `Conn`
-/// interface <https://pkg.go.dev/net#Conn>
+/// If you are familiar with the Go language, this is similar to the
+/// [Conn](https://pkg.go.dev/net#Conn) interface
#[async_trait]
pub trait Connection: Send + Sync {
/// Returns the remote peer endpoint of this connection
diff --git a/net/src/transports/tcp.rs b/net/src/transports/tcp.rs
index 9b2b928..84aa980 100644
--- a/net/src/transports/tcp.rs
+++ b/net/src/transports/tcp.rs
@@ -13,7 +13,7 @@ use crate::{
Error, Result,
};
-/// TCP network connection implementations of the `Connection` trait.
+/// TCP network connection implementations of the [`Connection`] trait.
pub struct TcpConn {
inner: TcpStream,
read: Mutex<ReadHalf<TcpStream>>,
diff --git a/net/src/transports/udp.rs b/net/src/transports/udp.rs
index 2050226..ca5b94d 100644
--- a/net/src/transports/udp.rs
+++ b/net/src/transports/udp.rs
@@ -9,7 +9,7 @@ use crate::{
Error, Result,
};
-/// UDP network connection implementations of the `Connection` trait.
+/// UDP network connection implementations of the [`Connection`] trait.
pub struct UdpConn {
inner: UdpSocket,
}
diff --git a/net/src/transports/unix.rs b/net/src/transports/unix.rs
index 1a32311..a720d91 100644
--- a/net/src/transports/unix.rs
+++ b/net/src/transports/unix.rs
@@ -8,7 +8,7 @@ use smol::{
use crate::{connection::Connection, endpoint::Endpoint, listener::Listener, Error, Result};
-/// Unix domain socket implementations of the `Connection` trait.
+/// Unix domain socket implementations of the [`Connection`] trait.
pub struct UnixConn {
inner: UnixStream,
read: Mutex<ReadHalf<UnixStream>>,
--
cgit v1.2.3