Commit ec6a1649 authored by Randy Dunlap's avatar Randy Dunlap Committed by Jakub Kicinski
Browse files

net/tipc: fix bearer.c for kernel-doc 



Fix kernel-doc warnings in bearer.c:

../net/tipc/bearer.c:77: warning: Function parameter or member 'name' not described in 'tipc_media_find'
../net/tipc/bearer.c:91: warning: Function parameter or member 'type' not described in 'media_find_id'
../net/tipc/bearer.c:105: warning: Function parameter or member 'buf' not described in 'tipc_media_addr_printf'
../net/tipc/bearer.c:105: warning: Function parameter or member 'len' not described in 'tipc_media_addr_printf'
../net/tipc/bearer.c:105: warning: Function parameter or member 'a' not described in 'tipc_media_addr_printf'
../net/tipc/bearer.c:174: warning: Function parameter or member 'net' not described in 'tipc_bearer_find'
../net/tipc/bearer.c:174: warning: Function parameter or member 'name' not described in 'tipc_bearer_find'
../net/tipc/bearer.c:238: warning: Function parameter or member 'net' not described in 'tipc_enable_bearer'
../net/tipc/bearer.c:238: warning: Function parameter or member 'name' not described in 'tipc_enable_bearer'
../net/tipc/bearer.c:238: warning: Function parameter or member 'disc_domain' not described in 'tipc_enable_bearer'
../net/tipc/bearer.c:238: warning: Function parameter or member 'prio' not described in 'tipc_enable_bearer'
../net/tipc/bearer.c:238: warning: Function parameter or member 'attr' not described in 'tipc_enable_bearer'
../net/tipc/bearer.c:350: warning: Function parameter or member 'net' not described in 'tipc_reset_bearer'
../net/tipc/bearer.c:350: warning: Function parameter or member 'b' not described in 'tipc_reset_bearer'
../net/tipc/bearer.c:374: warning: Function parameter or member 'net' not described in 'bearer_disable'
../net/tipc/bearer.c:374: warning: Function parameter or member 'b' not described in 'bearer_disable'
../net/tipc/bearer.c:462: warning: Function parameter or member 'net' not described in 'tipc_l2_send_msg'
../net/tipc/bearer.c:479: warning: Function parameter or member 'net' not described in 'tipc_l2_send_msg'

Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarJakub Kicinski <kuba@kernel.org>
parent 5fcb7d47

net/tipc/bearer.c

+19 −1
Original line number Diff line number Diff line
@@ -72,6 +72,7 @@ static int tipc_l2_rcv_msg(struct sk_buff *skb, struct net_device *dev, 


/**

 * tipc_media_find - locates specified media object by name

 * @name: name to locate

 */

struct tipc_media *tipc_media_find(const char *name)

{
@@ -86,6 +87,7 @@ struct tipc_media *tipc_media_find(const char *name) 


/**

 * media_find_id - locates specified media object by type identifier

 * @type: type identifier to locate

 */

static struct tipc_media *media_find_id(u8 type)

{
@@ -100,6 +102,9 @@ static struct tipc_media *media_find_id(u8 type) 


/**

 * tipc_media_addr_printf - record media address in print buffer

 * @buf: output buffer

 * @len: output buffer size remaining

 * @a: input media address

 */

int tipc_media_addr_printf(char *buf, int len, struct tipc_media_addr *a)

{
@@ -166,6 +171,8 @@ static int bearer_name_validate(const char *name, 


/**

 * tipc_bearer_find - locates bearer object with matching bearer name

 * @net: the applicable net namespace

 * @name: bearer name to locate

 */

struct tipc_bearer *tipc_bearer_find(struct net *net, const char *name)

{
@@ -228,6 +235,11 @@ void tipc_bearer_remove_dest(struct net *net, u32 bearer_id, u32 dest) 


/**

 * tipc_enable_bearer - enable bearer with the given name

 * @net: the applicable net namespace

 * @name: bearer name to enable

 * @disc_domain: bearer domain

 * @prio: bearer priority

 * @attr: nlattr array

 */

static int tipc_enable_bearer(struct net *net, const char *name,

			      u32 disc_domain, u32 prio,
@@ -342,6 +354,8 @@ static int tipc_enable_bearer(struct net *net, const char *name, 


/**

 * tipc_reset_bearer - Reset all links established over this bearer

 * @net: the applicable net namespace

 * @b: the target bearer

 */

static int tipc_reset_bearer(struct net *net, struct tipc_bearer *b)

{
@@ -363,7 +377,9 @@ void tipc_bearer_put(struct tipc_bearer *b) 
}



/**

 * bearer_disable

 * bearer_disable - disable this bearer

 * @net: the applicable net namespace

 * @b: the bearer to disable

 *

 * Note: This routine assumes caller holds RTNL lock.

 */
@@ -434,6 +450,7 @@ int tipc_enable_l2_media(struct net *net, struct tipc_bearer *b, 
}



/* tipc_disable_l2_media - detach TIPC bearer from an L2 interface

 * @b: the target bearer

 *

 * Mark L2 bearer as inactive so that incoming buffers are thrown away

 */
@@ -450,6 +467,7 @@ void tipc_disable_l2_media(struct tipc_bearer *b) 


/**

 * tipc_l2_send_msg - send a TIPC packet out over an L2 interface

 * @net: the associated network namespace

 * @skb: the packet to be sent

 * @b: the bearer through which the packet is to be sent

 * @dest: peer destination address