git: afb0eadf97b2 - main - net80211: clean up the documentation for ieee80211_fragment()
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Tue, 13 May 2025 03:34:42 UTC
The branch main has been updated by adrian:
URL: https://cgit.FreeBSD.org/src/commit/?id=afb0eadf97b22844dda6d9761782cb1526f83091
commit afb0eadf97b22844dda6d9761782cb1526f83091
Author: Adrian Chadd <adrian@FreeBSD.org>
AuthorDate: 2025-05-13 03:34:05 +0000
Commit: Adrian Chadd <adrian@FreeBSD.org>
CommitDate: 2025-05-13 03:34:05 +0000
net80211: clean up the documentation for ieee80211_fragment()
In particular, frame it with @brief and move the summary description
where it belongs.
Reviewed by: bz
---
sys/net80211/ieee80211_output.c | 11 ++++++-----
1 file changed, 6 insertions(+), 5 deletions(-)
diff --git a/sys/net80211/ieee80211_output.c b/sys/net80211/ieee80211_output.c
index 506c90991800..1ebf7fa8723f 100644
--- a/sys/net80211/ieee80211_output.c
+++ b/sys/net80211/ieee80211_output.c
@@ -1969,7 +1969,12 @@ ieee80211_free_mbuf(struct mbuf *m)
} while ((m = next) != NULL);
}
-/*
+/**
+ * @brief Fragment the frame according to the specified mtu.
+ *
+ * This implements the fragmentation part of 802.11-2016 10.2.7
+ * (Fragmentation/defragmentation overview.)
+ *
* Fragment the frame according to the specified mtu.
* The size of the 802.11 header (w/o padding) is provided
* so we don't need to recalculate it. We create a new
@@ -1995,10 +2000,6 @@ ieee80211_free_mbuf(struct mbuf *m)
* @param hdrsize header size to reserver
* @param ciphdrsize crypto cipher header size to reserve
* @param mtu maximum fragment size
- *
- * This implements the fragmentation part of 802.11-2016 10.2.7
- * (Fragmentation/defragmentation overview.)
- *
* @retval 1 if successful, with the mbuf pointed at by m0
* turned into an mbuf list of fragments (with the original
* mbuf being truncated.)