batman-adv: Use parentheses in function kernel-doc
The documentation describing kernel-doc comments for functions ("How to format kernel-doc comments") uses parentheses at the end of the function name. Using this format allows to use a consistent style when adding documentation to a function and when referencing this function in a different kernel-doc section. Signed-off-by: Sven Eckelmann <sven@narfation.org> Signed-off-by: Simon Wunderlich <sw@simonwunderlich.de>
This commit is contained in:

committed by
Simon Wunderlich

parent
6a3038f07c
commit
7e9a8c2ce7
@@ -55,7 +55,7 @@
|
||||
static void batadv_send_outstanding_bcast_packet(struct work_struct *work);
|
||||
|
||||
/**
|
||||
* batadv_send_skb_packet - send an already prepared packet
|
||||
* batadv_send_skb_packet() - send an already prepared packet
|
||||
* @skb: the packet to send
|
||||
* @hard_iface: the interface to use to send the broadcast packet
|
||||
* @dst_addr: the payload destination
|
||||
@@ -154,7 +154,7 @@ int batadv_send_unicast_skb(struct sk_buff *skb,
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_send_skb_to_orig - Lookup next-hop and transmit skb.
|
||||
* batadv_send_skb_to_orig() - Lookup next-hop and transmit skb.
|
||||
* @skb: Packet to be transmitted.
|
||||
* @orig_node: Final destination of the packet.
|
||||
* @recv_if: Interface used when receiving the packet (can be NULL).
|
||||
@@ -217,7 +217,7 @@ free_skb:
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_send_skb_push_fill_unicast - extend the buffer and initialize the
|
||||
* batadv_send_skb_push_fill_unicast() - extend the buffer and initialize the
|
||||
* common fields for unicast packets
|
||||
* @skb: the skb carrying the unicast header to initialize
|
||||
* @hdr_size: amount of bytes to push at the beginning of the skb
|
||||
@@ -250,7 +250,7 @@ batadv_send_skb_push_fill_unicast(struct sk_buff *skb, int hdr_size,
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_send_skb_prepare_unicast - encapsulate an skb with a unicast header
|
||||
* batadv_send_skb_prepare_unicast() - encapsulate an skb with a unicast header
|
||||
* @skb: the skb containing the payload to encapsulate
|
||||
* @orig_node: the destination node
|
||||
*
|
||||
@@ -265,7 +265,7 @@ static bool batadv_send_skb_prepare_unicast(struct sk_buff *skb,
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_send_skb_prepare_unicast_4addr - encapsulate an skb with a
|
||||
* batadv_send_skb_prepare_unicast_4addr() - encapsulate an skb with a
|
||||
* unicast 4addr header
|
||||
* @bat_priv: the bat priv with all the soft interface information
|
||||
* @skb: the skb containing the payload to encapsulate
|
||||
@@ -309,7 +309,7 @@ out:
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_send_skb_unicast - encapsulate and send an skb via unicast
|
||||
* batadv_send_skb_unicast() - encapsulate and send an skb via unicast
|
||||
* @bat_priv: the bat priv with all the soft interface information
|
||||
* @skb: payload to send
|
||||
* @packet_type: the batman unicast packet type to use
|
||||
@@ -379,7 +379,7 @@ out:
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_send_skb_via_tt_generic - send an skb via TT lookup
|
||||
* batadv_send_skb_via_tt_generic() - send an skb via TT lookup
|
||||
* @bat_priv: the bat priv with all the soft interface information
|
||||
* @skb: payload to send
|
||||
* @packet_type: the batman unicast packet type to use
|
||||
@@ -426,7 +426,7 @@ int batadv_send_skb_via_tt_generic(struct batadv_priv *bat_priv,
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_send_skb_via_gw - send an skb via gateway lookup
|
||||
* batadv_send_skb_via_gw() - send an skb via gateway lookup
|
||||
* @bat_priv: the bat priv with all the soft interface information
|
||||
* @skb: payload to send
|
||||
* @vid: the vid to be used to search the translation table
|
||||
@@ -453,7 +453,7 @@ int batadv_send_skb_via_gw(struct batadv_priv *bat_priv, struct sk_buff *skb,
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_forw_packet_free - free a forwarding packet
|
||||
* batadv_forw_packet_free() - free a forwarding packet
|
||||
* @forw_packet: The packet to free
|
||||
* @dropped: whether the packet is freed because is is dropped
|
||||
*
|
||||
@@ -478,7 +478,7 @@ void batadv_forw_packet_free(struct batadv_forw_packet *forw_packet,
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_forw_packet_alloc - allocate a forwarding packet
|
||||
* batadv_forw_packet_alloc() - allocate a forwarding packet
|
||||
* @if_incoming: The (optional) if_incoming to be grabbed
|
||||
* @if_outgoing: The (optional) if_outgoing to be grabbed
|
||||
* @queue_left: The (optional) queue counter to decrease
|
||||
@@ -544,7 +544,7 @@ err:
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_forw_packet_was_stolen - check whether someone stole this packet
|
||||
* batadv_forw_packet_was_stolen() - check whether someone stole this packet
|
||||
* @forw_packet: the forwarding packet to check
|
||||
*
|
||||
* This function checks whether the given forwarding packet was claimed by
|
||||
@@ -559,7 +559,7 @@ batadv_forw_packet_was_stolen(struct batadv_forw_packet *forw_packet)
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_forw_packet_steal - claim a forw_packet for free()
|
||||
* batadv_forw_packet_steal() - claim a forw_packet for free()
|
||||
* @forw_packet: the forwarding packet to steal
|
||||
* @lock: a key to the store to steal from (e.g. forw_{bat,bcast}_list_lock)
|
||||
*
|
||||
@@ -590,7 +590,7 @@ bool batadv_forw_packet_steal(struct batadv_forw_packet *forw_packet,
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_forw_packet_list_steal - claim a list of forward packets for free()
|
||||
* batadv_forw_packet_list_steal() - claim a list of forward packets for free()
|
||||
* @forw_list: the to be stolen forward packets
|
||||
* @cleanup_list: a backup pointer, to be able to dispose the packet later
|
||||
* @hard_iface: the interface to steal forward packets from
|
||||
@@ -626,7 +626,7 @@ batadv_forw_packet_list_steal(struct hlist_head *forw_list,
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_forw_packet_list_free - free a list of forward packets
|
||||
* batadv_forw_packet_list_free() - free a list of forward packets
|
||||
* @head: a list of to be freed forw_packets
|
||||
*
|
||||
* This function cancels the scheduling of any packet in the provided list,
|
||||
@@ -650,7 +650,7 @@ static void batadv_forw_packet_list_free(struct hlist_head *head)
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_forw_packet_queue - try to queue a forwarding packet
|
||||
* batadv_forw_packet_queue() - try to queue a forwarding packet
|
||||
* @forw_packet: the forwarding packet to queue
|
||||
* @lock: a key to the store (e.g. forw_{bat,bcast}_list_lock)
|
||||
* @head: the shelve to queue it on (e.g. forw_{bat,bcast}_list)
|
||||
@@ -694,7 +694,7 @@ static void batadv_forw_packet_queue(struct batadv_forw_packet *forw_packet,
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_forw_packet_bcast_queue - try to queue a broadcast packet
|
||||
* batadv_forw_packet_bcast_queue() - try to queue a broadcast packet
|
||||
* @bat_priv: the bat priv with all the soft interface information
|
||||
* @forw_packet: the forwarding packet to queue
|
||||
* @send_time: timestamp (jiffies) when the packet is to be sent
|
||||
@@ -713,7 +713,7 @@ batadv_forw_packet_bcast_queue(struct batadv_priv *bat_priv,
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_forw_packet_ogmv1_queue - try to queue an OGMv1 packet
|
||||
* batadv_forw_packet_ogmv1_queue() - try to queue an OGMv1 packet
|
||||
* @bat_priv: the bat priv with all the soft interface information
|
||||
* @forw_packet: the forwarding packet to queue
|
||||
* @send_time: timestamp (jiffies) when the packet is to be sent
|
||||
@@ -731,7 +731,7 @@ void batadv_forw_packet_ogmv1_queue(struct batadv_priv *bat_priv,
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_add_bcast_packet_to_list - queue broadcast packet for multiple sends
|
||||
* batadv_add_bcast_packet_to_list() - queue broadcast packet for multiple sends
|
||||
* @bat_priv: the bat priv with all the soft interface information
|
||||
* @skb: broadcast packet to add
|
||||
* @delay: number of jiffies to wait before sending
|
||||
@@ -791,7 +791,7 @@ err:
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_forw_packet_bcasts_left - check if a retransmission is necessary
|
||||
* batadv_forw_packet_bcasts_left() - check if a retransmission is necessary
|
||||
* @forw_packet: the forwarding packet to check
|
||||
* @hard_iface: the interface to check on
|
||||
*
|
||||
@@ -819,7 +819,8 @@ batadv_forw_packet_bcasts_left(struct batadv_forw_packet *forw_packet,
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_forw_packet_bcasts_inc - increment retransmission counter of a packet
|
||||
* batadv_forw_packet_bcasts_inc() - increment retransmission counter of a
|
||||
* packet
|
||||
* @forw_packet: the packet to increase the counter for
|
||||
*/
|
||||
static void
|
||||
@@ -829,7 +830,7 @@ batadv_forw_packet_bcasts_inc(struct batadv_forw_packet *forw_packet)
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_forw_packet_is_rebroadcast - check packet for previous transmissions
|
||||
* batadv_forw_packet_is_rebroadcast() - check packet for previous transmissions
|
||||
* @forw_packet: the packet to check
|
||||
*
|
||||
* Return: True if this packet was transmitted before, false otherwise.
|
||||
@@ -954,7 +955,7 @@ out:
|
||||
}
|
||||
|
||||
/**
|
||||
* batadv_purge_outstanding_packets - stop/purge scheduled bcast/OGMv1 packets
|
||||
* batadv_purge_outstanding_packets() - stop/purge scheduled bcast/OGMv1 packets
|
||||
* @bat_priv: the bat priv with all the soft interface information
|
||||
* @hard_iface: the hard interface to cancel and purge bcast/ogm packets on
|
||||
*
|
||||
|
Reference in New Issue
Block a user