batman-adv: Use parentheses in function kernel-doc (7e9a8c2c) · Commits · 戴 / test

net/batman-adv/bat_algo.c

+4 −3

Original line number	Original line	Diff line number	Diff line
	@@ -38,7 +38,8 @@ char batadv_routing_algo[20] = "BATMAN_IV";
	static struct hlist_head batadv_algo_list;		static struct hlist_head batadv_algo_list;

	/**		/**
	* batadv_algo_init - Initialize batman-adv algorithm management data structures		* batadv_algo_init() - Initialize batman-adv algorithm management data
			* structures
	*/		*/
	void batadv_algo_init(void)		void batadv_algo_init(void)
	{		{
	@@ -149,7 +150,7 @@ module_param_cb(routing_algo, &batadv_param_ops_ra, &batadv_param_string_ra,
	0644);		0644);

	/**		/**
	* batadv_algo_dump_entry - fill in information about one supported routing		* batadv_algo_dump_entry() - fill in information about one supported routing
	* algorithm		* algorithm
	* @msg: netlink message to be sent back		* @msg: netlink message to be sent back
	* @portid: Port to reply to		* @portid: Port to reply to
	@@ -180,7 +181,7 @@ static int batadv_algo_dump_entry(struct sk_buff *msg, u32 portid, u32 seq,
	}		}

	/**		/**
	* batadv_algo_dump - fill in information about supported routing		* batadv_algo_dump() - fill in information about supported routing
	* algorithms		* algorithms
	* @msg: netlink message to be sent back		* @msg: netlink message to be sent back
	* @cb: Parameters to the netlink request		* @cb: Parameters to the netlink request

net/batman-adv/bat_iv_ogm.c

+41 −39

net/batman-adv/bat_v.c

+23 −25

net/batman-adv/bat_v_elp.c

+12 −12

Original line number	Original line	Diff line number	Diff line
	@@ -53,7 +53,7 @@
	#include "send.h"		#include "send.h"

	/**		/**
	* batadv_v_elp_start_timer - restart timer for ELP periodic work		* batadv_v_elp_start_timer() - restart timer for ELP periodic work
	* @hard_iface: the interface for which the timer has to be reset		* @hard_iface: the interface for which the timer has to be reset
	*/		*/
	static void batadv_v_elp_start_timer(struct batadv_hard_iface *hard_iface)		static void batadv_v_elp_start_timer(struct batadv_hard_iface *hard_iface)
	@@ -68,7 +68,7 @@ static void batadv_v_elp_start_timer(struct batadv_hard_iface *hard_iface)
	}		}

	/**		/**
	* batadv_v_elp_get_throughput - get the throughput towards a neighbour		* batadv_v_elp_get_throughput() - get the throughput towards a neighbour
	* @neigh: the neighbour for which the throughput has to be obtained		* @neigh: the neighbour for which the throughput has to be obtained
	*		*
	* Return: The throughput towards the given neighbour in multiples of 100kpbs		* Return: The throughput towards the given neighbour in multiples of 100kpbs
	@@ -154,8 +154,8 @@ default_throughput:
	}		}

	/**		/**
	* batadv_v_elp_throughput_metric_update - worker updating the throughput metric		* batadv_v_elp_throughput_metric_update() - worker updating the throughput
	* of a single hop neighbour		* metric of a single hop neighbour
	* @work: the work queue item		* @work: the work queue item
	*/		*/
	void batadv_v_elp_throughput_metric_update(struct work_struct *work)		void batadv_v_elp_throughput_metric_update(struct work_struct *work)
	@@ -178,7 +178,7 @@ void batadv_v_elp_throughput_metric_update(struct work_struct *work)
	}		}

	/**		/**
	* batadv_v_elp_wifi_neigh_probe - send link probing packets to a neighbour		* batadv_v_elp_wifi_neigh_probe() - send link probing packets to a neighbour
	* @neigh: the neighbour to probe		* @neigh: the neighbour to probe
	*		*
	* Sends a predefined number of unicast wifi packets to a given neighbour in		* Sends a predefined number of unicast wifi packets to a given neighbour in
	@@ -241,7 +241,7 @@ batadv_v_elp_wifi_neigh_probe(struct batadv_hardif_neigh_node *neigh)
	}		}

	/**		/**
	* batadv_v_elp_periodic_work - ELP periodic task per interface		* batadv_v_elp_periodic_work() - ELP periodic task per interface
	* @work: work queue item		* @work: work queue item
	*		*
	* Emits broadcast ELP message in regular intervals.		* Emits broadcast ELP message in regular intervals.
	@@ -328,7 +328,7 @@ out:
	}		}

	/**		/**
	* batadv_v_elp_iface_enable - setup the ELP interface private resources		* batadv_v_elp_iface_enable() - setup the ELP interface private resources
	* @hard_iface: interface for which the data has to be prepared		* @hard_iface: interface for which the data has to be prepared
	*		*
	* Return: 0 on success or a -ENOMEM in case of failure.		* Return: 0 on success or a -ENOMEM in case of failure.
	@@ -376,7 +376,7 @@ out:
	}		}

	/**		/**
	* batadv_v_elp_iface_disable - release ELP interface private resources		* batadv_v_elp_iface_disable() - release ELP interface private resources
	* @hard_iface: interface for which the resources have to be released		* @hard_iface: interface for which the resources have to be released
	*/		*/
	void batadv_v_elp_iface_disable(struct batadv_hard_iface *hard_iface)		void batadv_v_elp_iface_disable(struct batadv_hard_iface *hard_iface)
	@@ -388,7 +388,7 @@ void batadv_v_elp_iface_disable(struct batadv_hard_iface *hard_iface)
	}		}

	/**		/**
	* batadv_v_elp_iface_activate - update the ELP buffer belonging to the given		* batadv_v_elp_iface_activate() - update the ELP buffer belonging to the given
	* hard-interface		* hard-interface
	* @primary_iface: the new primary interface		* @primary_iface: the new primary interface
	* @hard_iface: interface holding the to-be-updated buffer		* @hard_iface: interface holding the to-be-updated buffer
	@@ -409,7 +409,7 @@ void batadv_v_elp_iface_activate(struct batadv_hard_iface *primary_iface,
	}		}

	/**		/**
	* batadv_v_elp_primary_iface_set - change internal data to reflect the new		* batadv_v_elp_primary_iface_set() - change internal data to reflect the new
	* primary interface		* primary interface
	* @primary_iface: the new primary interface		* @primary_iface: the new primary interface
	*/		*/
	@@ -429,7 +429,7 @@ void batadv_v_elp_primary_iface_set(struct batadv_hard_iface *primary_iface)
	}		}

	/**		/**
	* batadv_v_elp_neigh_update - update an ELP neighbour node		* batadv_v_elp_neigh_update() - update an ELP neighbour node
	* @bat_priv: the bat priv with all the soft interface information		* @bat_priv: the bat priv with all the soft interface information
	* @neigh_addr: the neighbour interface address		* @neigh_addr: the neighbour interface address
	* @if_incoming: the interface the packet was received through		* @if_incoming: the interface the packet was received through
	@@ -489,7 +489,7 @@ orig_free:
	}		}

	/**		/**
	* batadv_v_elp_packet_recv - main ELP packet handler		* batadv_v_elp_packet_recv() - main ELP packet handler
	* @skb: the received packet		* @skb: the received packet
	* @if_incoming: the interface this packet was received through		* @if_incoming: the interface this packet was received through
	*		*

net/batman-adv/bat_v_ogm.c

+17 −17

File changed.

Preview size limit exceeded, changes collapsed.

Original line number	Original line	Diff line number	Diff line
	@@ -87,7 +87,7 @@ enum batadv_dup_status {
	};		};

	/**		/**
	* batadv_ring_buffer_set - update the ring buffer with the given value		* batadv_ring_buffer_set() - update the ring buffer with the given value
	* @lq_recv: pointer to the ring buffer		* @lq_recv: pointer to the ring buffer
	* @lq_index: index to store the value at		* @lq_index: index to store the value at
	* @value: value to store in the ring buffer		* @value: value to store in the ring buffer
	@@ -99,7 +99,7 @@ static void batadv_ring_buffer_set(u8 lq_recv[], u8 *lq_index, u8 value)
	}		}

	/**		/**
	* batadv_ring_buffer_avg - compute the average of all non-zero values stored		* batadv_ring_buffer_avg() - compute the average of all non-zero values stored
	* in the given ring buffer		* in the given ring buffer
	* @lq_recv: pointer to the ring buffer		* @lq_recv: pointer to the ring buffer
	*		*
	@@ -131,7 +131,7 @@ static u8 batadv_ring_buffer_avg(const u8 lq_recv[])
	}		}

	/**		/**
	* batadv_iv_ogm_orig_free - free the private resources allocated for this		* batadv_iv_ogm_orig_free() - free the private resources allocated for this
	* orig_node		* orig_node
	* @orig_node: the orig_node for which the resources have to be free'd		* @orig_node: the orig_node for which the resources have to be free'd
	*/		*/
	@@ -142,8 +142,8 @@ static void batadv_iv_ogm_orig_free(struct batadv_orig_node *orig_node)
	}		}

	/**		/**
	* batadv_iv_ogm_orig_add_if - change the private structures of the orig_node to		* batadv_iv_ogm_orig_add_if() - change the private structures of the orig_node
	* include the new hard-interface		* to include the new hard-interface
	* @orig_node: the orig_node that has to be changed		* @orig_node: the orig_node that has to be changed
	* @max_if_num: the current amount of interfaces		* @max_if_num: the current amount of interfaces
	*		*
	@@ -187,7 +187,7 @@ unlock:
	}		}

	/**		/**
	* batadv_iv_ogm_drop_bcast_own_entry - drop section of bcast_own		* batadv_iv_ogm_drop_bcast_own_entry() - drop section of bcast_own
	* @orig_node: the orig_node that has to be changed		* @orig_node: the orig_node that has to be changed
	* @max_if_num: the current amount of interfaces		* @max_if_num: the current amount of interfaces

Admin message