diff options
author | Mathias Krause <mathias.krause@secunet.com> | 2013-11-07 08:18:26 -0500 |
---|---|---|
committer | David S. Miller <davem@davemloft.net> | 2013-11-07 19:28:59 -0500 |
commit | bc32383cd6496d595e6a25cdc7cff1da6b694462 (patch) | |
tree | e4db3f844522adf5a62a7ce1fc3cee5cd177673a /net/core | |
parent | 253c6daa343104c1278facd11cb5ecfc7554fb38 (diff) |
net: skbuff - kernel-doc fixes
Use "@" to refer to parameters in the kernel-doc description. According
to Documentation/kernel-doc-nano-HOWTO.txt "&" shall be used to refer to
structures only.
Signed-off-by: Mathias Krause <mathias.krause@secunet.com>
Cc: "David S. Miller" <davem@davemloft.net>
Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'net/core')
-rw-r--r-- | net/core/skbuff.c | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/net/core/skbuff.c b/net/core/skbuff.c index 2fbea08c4f50..8c5197fe55a4 100644 --- a/net/core/skbuff.c +++ b/net/core/skbuff.c | |||
@@ -1051,8 +1051,8 @@ EXPORT_SYMBOL(__pskb_copy); | |||
1051 | * @ntail: room to add at tail | 1051 | * @ntail: room to add at tail |
1052 | * @gfp_mask: allocation priority | 1052 | * @gfp_mask: allocation priority |
1053 | * | 1053 | * |
1054 | * Expands (or creates identical copy, if &nhead and &ntail are zero) | 1054 | * Expands (or creates identical copy, if @nhead and @ntail are zero) |
1055 | * header of skb. &sk_buff itself is not changed. &sk_buff MUST have | 1055 | * header of @skb. &sk_buff itself is not changed. &sk_buff MUST have |
1056 | * reference count of 1. Returns zero in the case of success or error, | 1056 | * reference count of 1. Returns zero in the case of success or error, |
1057 | * if expansion failed. In the last case, &sk_buff is not changed. | 1057 | * if expansion failed. In the last case, &sk_buff is not changed. |
1058 | * | 1058 | * |
@@ -2563,14 +2563,14 @@ EXPORT_SYMBOL(skb_prepare_seq_read); | |||
2563 | * @data: destination pointer for data to be returned | 2563 | * @data: destination pointer for data to be returned |
2564 | * @st: state variable | 2564 | * @st: state variable |
2565 | * | 2565 | * |
2566 | * Reads a block of skb data at &consumed relative to the | 2566 | * Reads a block of skb data at @consumed relative to the |
2567 | * lower offset specified to skb_prepare_seq_read(). Assigns | 2567 | * lower offset specified to skb_prepare_seq_read(). Assigns |
2568 | * the head of the data block to &data and returns the length | 2568 | * the head of the data block to @data and returns the length |
2569 | * of the block or 0 if the end of the skb data or the upper | 2569 | * of the block or 0 if the end of the skb data or the upper |
2570 | * offset has been reached. | 2570 | * offset has been reached. |
2571 | * | 2571 | * |
2572 | * The caller is not required to consume all of the data | 2572 | * The caller is not required to consume all of the data |
2573 | * returned, i.e. &consumed is typically set to the number | 2573 | * returned, i.e. @consumed is typically set to the number |
2574 | * of bytes already consumed and the next call to | 2574 | * of bytes already consumed and the next call to |
2575 | * skb_seq_read() will return the remaining part of the block. | 2575 | * skb_seq_read() will return the remaining part of the block. |
2576 | * | 2576 | * |