net: sock.h: fix skb_steal_sock() kernel-doc
authorLothar Rubusch <l.rubusch@gmail.com>
Tue, 7 Apr 2020 22:55:25 +0000 (22:55 +0000)
committerDavid S. Miller <davem@davemloft.net>
Wed, 8 Apr 2020 01:09:30 +0000 (18:09 -0700)
Fix warnings related to kernel-doc notation, and wording in
function description.

Signed-off-by: Lothar Rubusch <l.rubusch@gmail.com>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: David S. Miller <davem@davemloft.net>
include/net/sock.h

index 6d84784..3e8c6d4 100644 (file)
@@ -2553,9 +2553,9 @@ sk_is_refcounted(struct sock *sk)
 }
 
 /**
- * skb_steal_sock
- * @skb to steal the socket from
- * @refcounted is set to true if the socket is reference-counted
+ * skb_steal_sock - steal a socket from an sk_buff
+ * @skb: sk_buff to steal the socket from
+ * @refcounted: is set to true if the socket is reference-counted
  */
 static inline struct sock *
 skb_steal_sock(struct sk_buff *skb, bool *refcounted)