Commit a1a824f4 authored by Jakub Kicinski's avatar Jakub Kicinski
Browse files

genetlink: fix kdoc warnings 

Address a bunch of kdoc warnings:

include/net/genetlink.h:81: warning: Function parameter or member 'module' not described in 'genl_family'
include/net/genetlink.h:243: warning: expecting prototype for struct genl_info. Prototype was for struct genl_dumpit_info instead
include/net/genetlink.h:419: warning: Function parameter or member 'net' not described in 'genlmsg_unicast'
include/net/genetlink.h:438: warning: expecting prototype for gennlmsg_data(). Prototype was for genlmsg_data() instead
include/net/genetlink.h:244: warning: Function parameter or member 'op' not described in 'genl_dumpit_info'

Link: https://lore.kernel.org/r/20221018231310.1040482-1-kuba@kernel.org


Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent 6109ecbf

include/net/genetlink.h

+5 −3
Original line number Diff line number Diff line
@@ -37,6 +37,7 @@ struct genl_info; 
 *	do additional, common, filtering and return an error

 * @post_doit: called after an operation's doit callback, it may

 *	undo operations done by pre_doit, for example release locks

 * @module: pointer to the owning module (set to THIS_MODULE)

 * @mcgrps: multicast groups used by this family

 * @n_mcgrps: number of multicast groups

 * @resv_start_op: first operation for which reserved fields of the header
@@ -173,9 +174,9 @@ struct genl_ops { 
};



/**

 * struct genl_info - info that is available during dumpit op call

 * struct genl_dumpit_info - info that is available during dumpit op call

 * @family: generic netlink family - for internal genl code usage

 * @ops: generic netlink ops - for internal genl code usage

 * @op: generic netlink ops - for internal genl code usage

 * @attrs: netlink attributes

 */

struct genl_dumpit_info {
@@ -354,6 +355,7 @@ int genlmsg_multicast_allns(const struct genl_family *family, 


/**

 * genlmsg_unicast - unicast a netlink message

 * @net: network namespace to look up @portid in

 * @skb: netlink message as socket buffer

 * @portid: netlink portid of the destination socket

 */
@@ -373,7 +375,7 @@ static inline int genlmsg_reply(struct sk_buff *skb, struct genl_info *info) 
}



/**

 * gennlmsg_data - head of message payload

 * genlmsg_data - head of message payload

 * @gnlh: genetlink message header

 */

static inline void *genlmsg_data(const struct genlmsghdr *gnlh)