Commit 25d81f93 authored Jan 20, 2021 by Sven Eckelmann Committed by Simon Wunderlich Feb 06, 2021

batman-adv: Fix names for kernel-doc blocks



kernel-doc can only correctly identify the documented function or struct
when the name in the first kernel-doc line references it. But some of the
kernel-doc blocks referenced a different function/struct then it actually
documented.

Signed-off-by: Sven Eckelmann <sven@narfation.org>
Signed-off-by: Simon Wunderlich <sw@simonwunderlich.de>

parent 576fb671

net/batman-adv/distributed-arp-table.c

+1 −1

Original line number	Diff line number	Diff line
		@@ -1564,7 +1564,7 @@ static int batadv_dat_get_dhcp_message_type(struct sk_buff *skb)
		}

		/**
		* batadv_dat_get_dhcp_yiaddr() - get yiaddr from a DHCP packet
		* batadv_dat_dhcp_get_yiaddr() - get yiaddr from a DHCP packet
		* @skb: the DHCP packet to parse
		* @buf: a buffer to store the yiaddr in
		*

net/batman-adv/multicast.c

+1 −1

Original line number	Diff line number	Diff line
		@@ -828,7 +828,7 @@ batadv_mcast_bridge_log(struct batadv_priv *bat_priv,
		}

		/**
		* batadv_mcast_flags_logs() - output debug information about mcast flag changes
		* batadv_mcast_flags_log() - output debug information about mcast flag changes
		* @bat_priv: the bat priv with all the soft interface information
		* @flags: TVLV flags indicating the new multicast state
		*

net/batman-adv/netlink.c

+2 −2

Original line number	Diff line number	Diff line
		@@ -193,7 +193,7 @@ static int batadv_netlink_mesh_fill_ap_isolation(struct sk_buff *msg,
		}

		/**
		* batadv_option_set_ap_isolation() - Set ap_isolation from genl msg
		* batadv_netlink_set_mesh_ap_isolation() - Set ap_isolation from genl msg
		* @attr: parsed BATADV_ATTR_AP_ISOLATION_ENABLED attribute
		* @bat_priv: the bat priv with all the soft interface information
		*
		@@ -757,7 +757,7 @@ batadv_netlink_tp_meter_start(struct sk_buff skb, struct genl_info info)
		}

		/**
		* batadv_netlink_tp_meter_start() - Cancel a running tp_meter session
		* batadv_netlink_tp_meter_cancel() - Cancel a running tp_meter session
		* @skb: received netlink message
		* @info: receiver information
		*

net/batman-adv/tp_meter.c

+1 −1

Original line number	Diff line number	Diff line
		@@ -131,7 +131,7 @@ static u32 batadv_tp_cwnd(u32 base, u32 increment, u32 min)
		}

		/**
		* batadv_tp_updated_cwnd() - update the Congestion Windows
		* batadv_tp_update_cwnd() - update the Congestion Windows
		* @tp_vars: the private data of the current TP meter session
		* @mss: maximum segment size of transmission
		*

net/batman-adv/types.h

+2 −1

Original line number	Diff line number	Diff line
		@@ -228,7 +228,8 @@ struct batadv_hard_iface {
		};

		/**
		* struct batadv_orig_ifinfo - B.A.T.M.A.N. IV private orig_ifinfo members
		* struct batadv_orig_ifinfo_bat_iv - B.A.T.M.A.N. IV private orig_ifinfo
		* members
		*/
		struct batadv_orig_ifinfo_bat_iv {
		/**