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
This commit is contained in:
Adrian Chadd 2025-05-12 20:34:05 -07:00
parent a3fcd76e80
commit afb0eadf97

View file

@ -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.)