From 15b00a2b75c681a9b4788eb27862445fbe9f97da Mon Sep 17 00:00:00 2001
From: zonyitoo <zonyitoo@gmail.com>
Date: Sat, 3 Aug 2024 23:53:26 +0800
Subject: [PATCH] chore: Batch*Message document

---
 crates/shadowsocks/src/net/udp.rs | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/crates/shadowsocks/src/net/udp.rs b/crates/shadowsocks/src/net/udp.rs
index 55fbc011..7803a162 100644
--- a/crates/shadowsocks/src/net/udp.rs
+++ b/crates/shadowsocks/src/net/udp.rs
@@ -53,8 +53,11 @@ use super::{
     target_os = "freebsd"
 ))]
 pub struct BatchSendMessage<'a> {
+    /// Optional target address
     pub addr: Option<SocketAddr>,
+    /// Data to be transmitted
     pub data: &'a [IoSlice<'a>],
+    /// Output result. The number of bytes sent by `batch_send`
     pub data_len: usize,
 }
 
@@ -67,8 +70,11 @@ pub struct BatchSendMessage<'a> {
     target_os = "freebsd"
 ))]
 pub struct BatchRecvMessage<'a> {
+    /// Peer address
     pub addr: SocketAddr,
+    /// Data buffer for receiving
     pub data: &'a mut [IoSliceMut<'a>],
+    /// Output result. The number of bytes received by `batch_recv`
     pub data_len: usize,
 }