Commit 2c53040f authored by Ben Hutchings's avatar Ben Hutchings Committed by David S. Miller
Browse files

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: default avatarBen Hutchings <bhutchings@solarflare.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent a55b138b

net/9p/trans_virtio.c

+1 −1
Original line number Diff line number Diff line
@@ -212,7 +212,7 @@ static int p9_virtio_cancel(struct p9_client *client, struct p9_req_t *req) 
 * this takes a list of pages.

 * @sg: scatter/gather list to pack into

 * @start: which segment of the sg_list to start at

 * @**pdata: a list of pages to add into sg.

 * @pdata: a list of pages to add into sg.

 * @nr_pages: number of pages to pack into the scatter/gather list

 * @data: data to pack into scatter/gather list

 * @count: amount of data to pack into the scatter/gather list

net/appletalk/ddp.c

+4 −4
Original line number Diff line number Diff line
@@ -129,8 +129,8 @@ static struct sock *atalk_search_socket(struct sockaddr_at *to, 


/**

 * atalk_find_or_insert_socket - Try to find a socket matching ADDR

 * @sk - socket to insert in the list if it is not there already

 * @sat - address to search for

 * @sk: socket to insert in the list if it is not there already

 * @sat: address to search for

 *

 * Try to find a socket matching ADDR in the socket list, if found then return

 * it. If not, insert SK into the socket list.
@@ -1066,8 +1066,8 @@ static int atalk_release(struct socket *sock) 


/**

 * atalk_pick_and_bind_port - Pick a source port when one is not given

 * @sk - socket to insert into the tables

 * @sat - address to search for

 * @sk: socket to insert into the tables

 * @sat: address to search for

 *

 * Pick a source port when one is not given. If we can find a suitable free

 * one, we insert the socket into the tables using it.

net/batman-adv/bridge_loop_avoidance.c

+34 −17
Original line number Diff line number Diff line
@@ -162,12 +162,13 @@ static struct batadv_claim *batadv_claim_hash_find(struct batadv_priv *bat_priv, 
	return claim_tmp;

}



/* @bat_priv: the bat priv with all the soft interface information

/**

 * batadv_backbone_hash_find - looks for a claim in the hash

 * @bat_priv: the bat priv with all the soft interface information

 * @addr: the address of the originator

 * @vid: the VLAN ID

 *

 * looks for a claim in the hash, and returns it if found

 * or NULL otherwise.

 * Returns claim if found or NULL otherwise.

 */

static struct batadv_backbone_gw *

batadv_backbone_hash_find(struct batadv_priv *bat_priv,
@@ -242,12 +243,12 @@ batadv_bla_del_backbone_claims(struct batadv_backbone_gw *backbone_gw) 
	backbone_gw->crc = BATADV_BLA_CRC_INIT;

}



/* @bat_priv: the bat priv with all the soft interface information

/**

 * batadv_bla_send_claim - sends a claim frame according to the provided info

 * @bat_priv: the bat priv with all the soft interface information

 * @orig: the mac address to be announced within the claim

 * @vid: the VLAN ID

 * @claimtype: the type of the claim (CLAIM, UNCLAIM, ANNOUNCE, ...)

 *

 * sends a claim frame according to the provided info.

 */

static void batadv_bla_send_claim(struct batadv_priv *bat_priv, uint8_t *mac,

				  short vid, int claimtype)
@@ -348,7 +349,9 @@ static void batadv_bla_send_claim(struct batadv_priv *bat_priv, uint8_t *mac, 
		batadv_hardif_free_ref(primary_if);

}



/* @bat_priv: the bat priv with all the soft interface information

/**

 * batadv_bla_get_backbone_gw

 * @bat_priv: the bat priv with all the soft interface information

 * @orig: the mac address of the originator

 * @vid: the VLAN ID

 *
@@ -520,12 +523,12 @@ static void batadv_bla_send_announce(struct batadv_priv *bat_priv, 


}



/* @bat_priv: the bat priv with all the soft interface information

/**

 * batadv_bla_add_claim - Adds a claim in the claim hash

 * @bat_priv: the bat priv with all the soft interface information

 * @mac: the mac address of the claim

 * @vid: the VLAN ID of the frame

 * @backbone_gw: the backbone gateway which claims it

 *

 * Adds a claim in the claim hash.

 */

static void batadv_bla_add_claim(struct batadv_priv *bat_priv,

				 const uint8_t *mac, const short vid,
@@ -743,7 +746,9 @@ static int batadv_handle_claim(struct batadv_priv *bat_priv, 
	return 1;

}



/* @bat_priv: the bat priv with all the soft interface information

/**

 * batadv_check_claim_group

 * @bat_priv: the bat priv with all the soft interface information

 * @hw_src: the Hardware source in the ARP Header

 * @hw_dst: the Hardware destination in the ARP Header

 * @ethhdr: pointer to the Ethernet header of the claim frame
@@ -975,7 +980,9 @@ static void batadv_bla_purge_backbone_gw(struct batadv_priv *bat_priv, int now) 
	}

}



/* @bat_priv: the bat priv with all the soft interface information

/**

 * batadv_bla_purge_claims

 * @bat_priv: the bat priv with all the soft interface information

 * @primary_if: the selected primary interface, may be NULL if now is set

 * @now: whether the whole hash shall be wiped now

 *
@@ -1023,7 +1030,9 @@ static void batadv_bla_purge_claims(struct batadv_priv *bat_priv, 
	}

}



/* @bat_priv: the bat priv with all the soft interface information

/**

 * batadv_bla_update_orig_address

 * @bat_priv: the bat priv with all the soft interface information

 * @primary_if: the new selected primary_if

 * @oldif: the old primary interface, may be NULL

 *
@@ -1193,7 +1202,9 @@ int batadv_bla_init(struct batadv_priv *bat_priv) 
	return 0;

}



/* @bat_priv: the bat priv with all the soft interface information

/**

 * batadv_bla_check_bcast_duplist

 * @bat_priv: the bat priv with all the soft interface information

 * @bcast_packet: originator mac address

 * @hdr_size: maximum length of the frame

 *
@@ -1297,7 +1308,9 @@ int batadv_bla_is_backbone_gw_orig(struct batadv_priv *bat_priv, uint8_t *orig) 
}





/* @skb: the frame to be checked

/**

 * batadv_bla_is_backbone_gw

 * @skb: the frame to be checked

 * @orig_node: the orig_node of the frame

 * @hdr_size: maximum length of the frame

 *
@@ -1363,7 +1376,9 @@ void batadv_bla_free(struct batadv_priv *bat_priv) 
		batadv_hardif_free_ref(primary_if);

}



/* @bat_priv: the bat priv with all the soft interface information

/**

 * batadv_bla_rx

 * @bat_priv: the bat priv with all the soft interface information

 * @skb: the frame to be checked

 * @vid: the VLAN ID of the frame

 *
@@ -1450,7 +1465,9 @@ int batadv_bla_rx(struct batadv_priv *bat_priv, struct sk_buff *skb, short vid) 
	return ret;

}



/* @bat_priv: the bat priv with all the soft interface information

/**

 * batadv_bla_tx

 * @bat_priv: the bat priv with all the soft interface information

 * @skb: the frame to be checked

 * @vid: the VLAN ID of the frame

 *

net/batman-adv/hash.h

+2 −1
Original line number Diff line number Diff line
@@ -81,7 +81,8 @@ static inline void batadv_hash_delete(struct batadv_hashtable *hash, 
	batadv_hash_destroy(hash);

}



/*	hash_add - adds data to the hashtable

/**

 *	batadv_hash_add - adds data to the hashtable

 *	@hash: storage hash table

 *	@compare: callback to determine if 2 hash elements are identical

 *	@choose: callback calculating the hash index

net/batman-adv/main.h

+2 −1
Original line number Diff line number Diff line
@@ -216,7 +216,8 @@ static inline int batadv_compare_eth(const void *data1, const void *data2) 
	return (memcmp(data1, data2, ETH_ALEN) == 0 ? 1 : 0);

}



/* has_timed_out - compares current time (jiffies) and timestamp + timeout

/**

 * has_timed_out - compares current time (jiffies) and timestamp + timeout

 * @timestamp:		base value to compare with (in jiffies)

 * @timeout:		added to base value before comparing (in milliseconds)

 *