diff options
author | Ben Hutchings <bhutchings@solarflare.com> | 2012-07-10 06:55:09 -0400 |
---|---|---|
committer | David S. Miller <davem@davemloft.net> | 2012-07-11 02:13:45 -0400 |
commit | 2c53040f018b6c36a46eec75b9b937aaa5f78e6d (patch) | |
tree | f77d987c380f78daf40838688a5f49bb4ab065ee /net/dccp/ccids/ccid3.c | |
parent | a55b138b1da3d25c04f66f8df03d659dfd46c950 (diff) |
net: Fix (nearly-)kernel-doc comments for various functions
Fix incorrect start markers, wrapped summary lines, missing section
breaks, incorrect separators, and some name mismatches.
Signed-off-by: Ben Hutchings <bhutchings@solarflare.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'net/dccp/ccids/ccid3.c')
-rw-r--r-- | net/dccp/ccids/ccid3.c | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/net/dccp/ccids/ccid3.c b/net/dccp/ccids/ccid3.c index 8c67bedf85b0..d65e98798eca 100644 --- a/net/dccp/ccids/ccid3.c +++ b/net/dccp/ccids/ccid3.c | |||
@@ -113,6 +113,7 @@ static u32 ccid3_hc_tx_idle_rtt(struct ccid3_hc_tx_sock *hc, ktime_t now) | |||
113 | /** | 113 | /** |
114 | * ccid3_hc_tx_update_x - Update allowed sending rate X | 114 | * ccid3_hc_tx_update_x - Update allowed sending rate X |
115 | * @stamp: most recent time if available - can be left NULL. | 115 | * @stamp: most recent time if available - can be left NULL. |
116 | * | ||
116 | * This function tracks draft rfc3448bis, check there for latest details. | 117 | * This function tracks draft rfc3448bis, check there for latest details. |
117 | * | 118 | * |
118 | * Note: X and X_recv are both stored in units of 64 * bytes/second, to support | 119 | * Note: X and X_recv are both stored in units of 64 * bytes/second, to support |
@@ -161,9 +162,11 @@ static void ccid3_hc_tx_update_x(struct sock *sk, ktime_t *stamp) | |||
161 | } | 162 | } |
162 | } | 163 | } |
163 | 164 | ||
164 | /* | 165 | /** |
165 | * Track the mean packet size `s' (cf. RFC 4342, 5.3 and RFC 3448, 4.1) | 166 | * ccid3_hc_tx_update_s - Track the mean packet size `s' |
166 | * @len: DCCP packet payload size in bytes | 167 | * @len: DCCP packet payload size in bytes |
168 | * | ||
169 | * cf. RFC 4342, 5.3 and RFC 3448, 4.1 | ||
167 | */ | 170 | */ |
168 | static inline void ccid3_hc_tx_update_s(struct ccid3_hc_tx_sock *hc, int len) | 171 | static inline void ccid3_hc_tx_update_s(struct ccid3_hc_tx_sock *hc, int len) |
169 | { | 172 | { |
@@ -270,6 +273,7 @@ out: | |||
270 | /** | 273 | /** |
271 | * ccid3_hc_tx_send_packet - Delay-based dequeueing of TX packets | 274 | * ccid3_hc_tx_send_packet - Delay-based dequeueing of TX packets |
272 | * @skb: next packet candidate to send on @sk | 275 | * @skb: next packet candidate to send on @sk |
276 | * | ||
273 | * This function uses the convention of ccid_packet_dequeue_eval() and | 277 | * This function uses the convention of ccid_packet_dequeue_eval() and |
274 | * returns a millisecond-delay value between 0 and t_mbi = 64000 msec. | 278 | * returns a millisecond-delay value between 0 and t_mbi = 64000 msec. |
275 | */ | 279 | */ |