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 | |
| 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')
| -rw-r--r-- | net/dccp/ccids/ccid3.c | 8 | ||||
| -rw-r--r-- | net/dccp/ccids/lib/loss_interval.c | 1 | ||||
| -rw-r--r-- | net/dccp/ccids/lib/packet_history.c | 3 | ||||
| -rw-r--r-- | net/dccp/ccids/lib/tfrc_equation.c | 2 |
4 files changed, 11 insertions, 3 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 | */ |
diff --git a/net/dccp/ccids/lib/loss_interval.c b/net/dccp/ccids/lib/loss_interval.c index 497723c4d4bb..57f9fd78c4df 100644 --- a/net/dccp/ccids/lib/loss_interval.c +++ b/net/dccp/ccids/lib/loss_interval.c | |||
| @@ -133,6 +133,7 @@ static inline u8 tfrc_lh_is_new_loss(struct tfrc_loss_interval *cur, | |||
| 133 | * @rh: Receive history containing a fresh loss event | 133 | * @rh: Receive history containing a fresh loss event |
| 134 | * @calc_first_li: Caller-dependent routine to compute length of first interval | 134 | * @calc_first_li: Caller-dependent routine to compute length of first interval |
| 135 | * @sk: Used by @calc_first_li in caller-specific way (subtyping) | 135 | * @sk: Used by @calc_first_li in caller-specific way (subtyping) |
| 136 | * | ||
| 136 | * Updates I_mean and returns 1 if a new interval has in fact been added to @lh. | 137 | * Updates I_mean and returns 1 if a new interval has in fact been added to @lh. |
| 137 | */ | 138 | */ |
| 138 | int tfrc_lh_interval_add(struct tfrc_loss_hist *lh, struct tfrc_rx_hist *rh, | 139 | int tfrc_lh_interval_add(struct tfrc_loss_hist *lh, struct tfrc_rx_hist *rh, |
diff --git a/net/dccp/ccids/lib/packet_history.c b/net/dccp/ccids/lib/packet_history.c index de8fe294bf0b..08df7a3acb3d 100644 --- a/net/dccp/ccids/lib/packet_history.c +++ b/net/dccp/ccids/lib/packet_history.c | |||
| @@ -315,6 +315,7 @@ static void __three_after_loss(struct tfrc_rx_hist *h) | |||
| 315 | * @ndp: The NDP count belonging to @skb | 315 | * @ndp: The NDP count belonging to @skb |
| 316 | * @calc_first_li: Caller-dependent computation of first loss interval in @lh | 316 | * @calc_first_li: Caller-dependent computation of first loss interval in @lh |
| 317 | * @sk: Used by @calc_first_li (see tfrc_lh_interval_add) | 317 | * @sk: Used by @calc_first_li (see tfrc_lh_interval_add) |
| 318 | * | ||
| 318 | * Chooses action according to pending loss, updates LI database when a new | 319 | * Chooses action according to pending loss, updates LI database when a new |
| 319 | * loss was detected, and does required post-processing. Returns 1 when caller | 320 | * loss was detected, and does required post-processing. Returns 1 when caller |
| 320 | * should send feedback, 0 otherwise. | 321 | * should send feedback, 0 otherwise. |
| @@ -387,7 +388,7 @@ static inline struct tfrc_rx_hist_entry * | |||
| 387 | } | 388 | } |
| 388 | 389 | ||
| 389 | /** | 390 | /** |
| 390 | * tfrc_rx_hist_rtt_prev_s: previously suitable (wrt rtt_last_s) RTT-sampling entry | 391 | * tfrc_rx_hist_rtt_prev_s - previously suitable (wrt rtt_last_s) RTT-sampling entry |
| 391 | */ | 392 | */ |
| 392 | static inline struct tfrc_rx_hist_entry * | 393 | static inline struct tfrc_rx_hist_entry * |
| 393 | tfrc_rx_hist_rtt_prev_s(const struct tfrc_rx_hist *h) | 394 | tfrc_rx_hist_rtt_prev_s(const struct tfrc_rx_hist *h) |
diff --git a/net/dccp/ccids/lib/tfrc_equation.c b/net/dccp/ccids/lib/tfrc_equation.c index a052a4377e26..88ef98285bec 100644 --- a/net/dccp/ccids/lib/tfrc_equation.c +++ b/net/dccp/ccids/lib/tfrc_equation.c | |||
| @@ -611,6 +611,7 @@ static inline u32 tfrc_binsearch(u32 fval, u8 small) | |||
| 611 | * @s: packet size in bytes | 611 | * @s: packet size in bytes |
| 612 | * @R: RTT scaled by 1000000 (i.e., microseconds) | 612 | * @R: RTT scaled by 1000000 (i.e., microseconds) |
| 613 | * @p: loss ratio estimate scaled by 1000000 | 613 | * @p: loss ratio estimate scaled by 1000000 |
| 614 | * | ||
| 614 | * Returns X_calc in bytes per second (not scaled). | 615 | * Returns X_calc in bytes per second (not scaled). |
| 615 | */ | 616 | */ |
| 616 | u32 tfrc_calc_x(u16 s, u32 R, u32 p) | 617 | u32 tfrc_calc_x(u16 s, u32 R, u32 p) |
| @@ -659,6 +660,7 @@ u32 tfrc_calc_x(u16 s, u32 R, u32 p) | |||
| 659 | /** | 660 | /** |
| 660 | * tfrc_calc_x_reverse_lookup - try to find p given f(p) | 661 | * tfrc_calc_x_reverse_lookup - try to find p given f(p) |
| 661 | * @fvalue: function value to match, scaled by 1000000 | 662 | * @fvalue: function value to match, scaled by 1000000 |
| 663 | * | ||
| 662 | * Returns closest match for p, also scaled by 1000000 | 664 | * Returns closest match for p, also scaled by 1000000 |
| 663 | */ | 665 | */ |
| 664 | u32 tfrc_calc_x_reverse_lookup(u32 fvalue) | 666 | u32 tfrc_calc_x_reverse_lookup(u32 fvalue) |
