aboutsummaryrefslogtreecommitdiffstats
path: root/net/tipc
diff options
context:
space:
mode:
authorBen Hutchings <bhutchings@solarflare.com>2012-07-10 06:55:09 -0400
committerDavid S. Miller <davem@davemloft.net>2012-07-11 02:13:45 -0400
commit2c53040f018b6c36a46eec75b9b937aaa5f78e6d (patch)
treef77d987c380f78daf40838688a5f49bb4ab065ee /net/tipc
parenta55b138b1da3d25c04f66f8df03d659dfd46c950 (diff)
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: Ben Hutchings <bhutchings@solarflare.com> Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'net/tipc')
-rw-r--r--net/tipc/bcast.c10
-rw-r--r--net/tipc/bearer.c7
-rw-r--r--net/tipc/bearer.h2
-rw-r--r--net/tipc/link.c22
-rw-r--r--net/tipc/name_table.c10
-rw-r--r--net/tipc/port.c2
-rw-r--r--net/tipc/port.h1
7 files changed, 27 insertions, 27 deletions
diff --git a/net/tipc/bcast.c b/net/tipc/bcast.c
index 2625f5ebe3e8..d9df34fbd7ca 100644
--- a/net/tipc/bcast.c
+++ b/net/tipc/bcast.c
@@ -162,7 +162,7 @@ static void bclink_update_last_sent(struct tipc_node *node, u32 seqno)
162} 162}
163 163
164 164
165/* 165/**
166 * tipc_bclink_retransmit_to - get most recent node to request retransmission 166 * tipc_bclink_retransmit_to - get most recent node to request retransmission
167 * 167 *
168 * Called with bc_lock locked 168 * Called with bc_lock locked
@@ -270,7 +270,7 @@ exit:
270 spin_unlock_bh(&bc_lock); 270 spin_unlock_bh(&bc_lock);
271} 271}
272 272
273/* 273/**
274 * tipc_bclink_update_link_state - update broadcast link state 274 * tipc_bclink_update_link_state - update broadcast link state
275 * 275 *
276 * tipc_net_lock and node lock set 276 * tipc_net_lock and node lock set
@@ -330,7 +330,7 @@ void tipc_bclink_update_link_state(struct tipc_node *n_ptr, u32 last_sent)
330 } 330 }
331} 331}
332 332
333/* 333/**
334 * bclink_peek_nack - monitor retransmission requests sent by other nodes 334 * bclink_peek_nack - monitor retransmission requests sent by other nodes
335 * 335 *
336 * Delay any upcoming NACK by this node if another node has already 336 * Delay any upcoming NACK by this node if another node has already
@@ -381,7 +381,7 @@ exit:
381 return res; 381 return res;
382} 382}
383 383
384/* 384/**
385 * bclink_accept_pkt - accept an incoming, in-sequence broadcast packet 385 * bclink_accept_pkt - accept an incoming, in-sequence broadcast packet
386 * 386 *
387 * Called with both sending node's lock and bc_lock taken. 387 * Called with both sending node's lock and bc_lock taken.
@@ -406,7 +406,7 @@ static void bclink_accept_pkt(struct tipc_node *node, u32 seqno)
406 } 406 }
407} 407}
408 408
409/* 409/**
410 * tipc_bclink_recv_pkt - receive a broadcast packet, and deliver upwards 410 * tipc_bclink_recv_pkt - receive a broadcast packet, and deliver upwards
411 * 411 *
412 * tipc_net_lock is read_locked, no other locks set 412 * tipc_net_lock is read_locked, no other locks set
diff --git a/net/tipc/bearer.c b/net/tipc/bearer.c
index a297e3a2e3e7..86b703f55092 100644
--- a/net/tipc/bearer.c
+++ b/net/tipc/bearer.c
@@ -172,8 +172,8 @@ struct sk_buff *tipc_media_get_names(void)
172 172
173/** 173/**
174 * bearer_name_validate - validate & (optionally) deconstruct bearer name 174 * bearer_name_validate - validate & (optionally) deconstruct bearer name
175 * @name - ptr to bearer name string 175 * @name: ptr to bearer name string
176 * @name_parts - ptr to area for bearer name components (or NULL if not needed) 176 * @name_parts: ptr to area for bearer name components (or NULL if not needed)
177 * 177 *
178 * Returns 1 if bearer name is valid, otherwise 0. 178 * Returns 1 if bearer name is valid, otherwise 0.
179 */ 179 */
@@ -520,8 +520,7 @@ exit:
520} 520}
521 521
522/** 522/**
523 * tipc_block_bearer(): Block the bearer with the given name, 523 * tipc_block_bearer - Block the bearer with the given name, and reset all its links
524 * and reset all its links
525 */ 524 */
526int tipc_block_bearer(const char *name) 525int tipc_block_bearer(const char *name)
527{ 526{
diff --git a/net/tipc/bearer.h b/net/tipc/bearer.h
index e3b2be37fb31..4680de118aff 100644
--- a/net/tipc/bearer.h
+++ b/net/tipc/bearer.h
@@ -57,7 +57,7 @@
57 */ 57 */
58#define TIPC_MEDIA_TYPE_ETH 1 58#define TIPC_MEDIA_TYPE_ETH 1
59 59
60/* 60/**
61 * struct tipc_media_addr - destination address used by TIPC bearers 61 * struct tipc_media_addr - destination address used by TIPC bearers
62 * @value: address info (format defined by media) 62 * @value: address info (format defined by media)
63 * @media_id: TIPC media type identifier 63 * @media_id: TIPC media type identifier
diff --git a/net/tipc/link.c b/net/tipc/link.c
index 7a614f43549d..f6bf4830ddfe 100644
--- a/net/tipc/link.c
+++ b/net/tipc/link.c
@@ -153,8 +153,8 @@ int tipc_link_is_active(struct tipc_link *l_ptr)
153 153
154/** 154/**
155 * link_name_validate - validate & (optionally) deconstruct tipc_link name 155 * link_name_validate - validate & (optionally) deconstruct tipc_link name
156 * @name - ptr to link name string 156 * @name: ptr to link name string
157 * @name_parts - ptr to area for link name components (or NULL if not needed) 157 * @name_parts: ptr to area for link name components (or NULL if not needed)
158 * 158 *
159 * Returns 1 if link name is valid, otherwise 0. 159 * Returns 1 if link name is valid, otherwise 0.
160 */ 160 */
@@ -944,7 +944,7 @@ int tipc_link_send(struct sk_buff *buf, u32 dest, u32 selector)
944 return res; 944 return res;
945} 945}
946 946
947/* 947/**
948 * tipc_link_send_names - send name table entries to new neighbor 948 * tipc_link_send_names - send name table entries to new neighbor
949 * 949 *
950 * Send routine for bulk delivery of name table messages when contact 950 * Send routine for bulk delivery of name table messages when contact
@@ -1787,7 +1787,7 @@ cont:
1787 read_unlock_bh(&tipc_net_lock); 1787 read_unlock_bh(&tipc_net_lock);
1788} 1788}
1789 1789
1790/* 1790/**
1791 * tipc_link_defer_pkt - Add out-of-sequence message to deferred reception queue 1791 * tipc_link_defer_pkt - Add out-of-sequence message to deferred reception queue
1792 * 1792 *
1793 * Returns increase in queue length (i.e. 0 or 1) 1793 * Returns increase in queue length (i.e. 0 or 1)
@@ -2635,8 +2635,8 @@ void tipc_link_set_queue_limits(struct tipc_link *l_ptr, u32 window)
2635 2635
2636/** 2636/**
2637 * link_find_link - locate link by name 2637 * link_find_link - locate link by name
2638 * @name - ptr to link name string 2638 * @name: ptr to link name string
2639 * @node - ptr to area to be filled with ptr to associated node 2639 * @node: ptr to area to be filled with ptr to associated node
2640 * 2640 *
2641 * Caller must hold 'tipc_net_lock' to ensure node and bearer are not deleted; 2641 * Caller must hold 'tipc_net_lock' to ensure node and bearer are not deleted;
2642 * this also prevents link deletion. 2642 * this also prevents link deletion.
@@ -2671,8 +2671,8 @@ static struct tipc_link *link_find_link(const char *name,
2671/** 2671/**
2672 * link_value_is_valid -- validate proposed link tolerance/priority/window 2672 * link_value_is_valid -- validate proposed link tolerance/priority/window
2673 * 2673 *
2674 * @cmd - value type (TIPC_CMD_SET_LINK_*) 2674 * @cmd: value type (TIPC_CMD_SET_LINK_*)
2675 * @new_value - the new value 2675 * @new_value: the new value
2676 * 2676 *
2677 * Returns 1 if value is within range, 0 if not. 2677 * Returns 1 if value is within range, 0 if not.
2678 */ 2678 */
@@ -2693,9 +2693,9 @@ static int link_value_is_valid(u16 cmd, u32 new_value)
2693 2693
2694/** 2694/**
2695 * link_cmd_set_value - change priority/tolerance/window for link/bearer/media 2695 * link_cmd_set_value - change priority/tolerance/window for link/bearer/media
2696 * @name - ptr to link, bearer, or media name 2696 * @name: ptr to link, bearer, or media name
2697 * @new_value - new value of link, bearer, or media setting 2697 * @new_value: new value of link, bearer, or media setting
2698 * @cmd - which link, bearer, or media attribute to set (TIPC_CMD_SET_LINK_*) 2698 * @cmd: which link, bearer, or media attribute to set (TIPC_CMD_SET_LINK_*)
2699 * 2699 *
2700 * Caller must hold 'tipc_net_lock' to ensure link/bearer/media is not deleted. 2700 * Caller must hold 'tipc_net_lock' to ensure link/bearer/media is not deleted.
2701 * 2701 *
diff --git a/net/tipc/name_table.c b/net/tipc/name_table.c
index 010f24a59da2..13fb9d559ea5 100644
--- a/net/tipc/name_table.c
+++ b/net/tipc/name_table.c
@@ -191,7 +191,7 @@ static void nameseq_delete_empty(struct name_seq *seq)
191 } 191 }
192} 192}
193 193
194/* 194/**
195 * nameseq_find_subseq - find sub-sequence (if any) matching a name instance 195 * nameseq_find_subseq - find sub-sequence (if any) matching a name instance
196 * 196 *
197 * Very time-critical, so binary searches through sub-sequence array. 197 * Very time-critical, so binary searches through sub-sequence array.
@@ -435,7 +435,7 @@ found:
435} 435}
436 436
437/** 437/**
438 * tipc_nameseq_subscribe: attach a subscription, and issue 438 * tipc_nameseq_subscribe - attach a subscription, and issue
439 * the prescribed number of events if there is any sub- 439 * the prescribed number of events if there is any sub-
440 * sequence overlapping with the requested sequence 440 * sequence overlapping with the requested sequence
441 */ 441 */
@@ -520,7 +520,7 @@ struct publication *tipc_nametbl_remove_publ(u32 type, u32 lower,
520 return publ; 520 return publ;
521} 521}
522 522
523/* 523/**
524 * tipc_nametbl_translate - perform name translation 524 * tipc_nametbl_translate - perform name translation
525 * 525 *
526 * On entry, 'destnode' is the search domain used during translation. 526 * On entry, 'destnode' is the search domain used during translation.
@@ -751,7 +751,7 @@ void tipc_nametbl_unsubscribe(struct tipc_subscription *s)
751 751
752 752
753/** 753/**
754 * subseq_list: print specified sub-sequence contents into the given buffer 754 * subseq_list - print specified sub-sequence contents into the given buffer
755 */ 755 */
756static void subseq_list(struct sub_seq *sseq, struct print_buf *buf, u32 depth, 756static void subseq_list(struct sub_seq *sseq, struct print_buf *buf, u32 depth,
757 u32 index) 757 u32 index)
@@ -787,7 +787,7 @@ static void subseq_list(struct sub_seq *sseq, struct print_buf *buf, u32 depth,
787} 787}
788 788
789/** 789/**
790 * nameseq_list: print specified name sequence contents into the given buffer 790 * nameseq_list - print specified name sequence contents into the given buffer
791 */ 791 */
792static void nameseq_list(struct name_seq *seq, struct print_buf *buf, u32 depth, 792static void nameseq_list(struct name_seq *seq, struct print_buf *buf, u32 depth,
793 u32 type, u32 lowbound, u32 upbound, u32 index) 793 u32 type, u32 lowbound, u32 upbound, u32 index)
diff --git a/net/tipc/port.c b/net/tipc/port.c
index a1e828989d7a..70bf78bd5b75 100644
--- a/net/tipc/port.c
+++ b/net/tipc/port.c
@@ -69,7 +69,7 @@ static u32 port_peerport(struct tipc_port *p_ptr)
69 return msg_destport(&p_ptr->phdr); 69 return msg_destport(&p_ptr->phdr);
70} 70}
71 71
72/* 72/**
73 * tipc_port_peer_msg - verify message was sent by connected port's peer 73 * tipc_port_peer_msg - verify message was sent by connected port's peer
74 * 74 *
75 * Handles cases where the node's network address has changed from 75 * Handles cases where the node's network address has changed from
diff --git a/net/tipc/port.h b/net/tipc/port.h
index 98cbec9c4532..4660e3065790 100644
--- a/net/tipc/port.h
+++ b/net/tipc/port.h
@@ -79,6 +79,7 @@ typedef void (*tipc_continue_event) (void *usr_handle, u32 portref);
79 * struct user_port - TIPC user port (used with native API) 79 * struct user_port - TIPC user port (used with native API)
80 * @usr_handle: user-specified field 80 * @usr_handle: user-specified field
81 * @ref: object reference to associated TIPC port 81 * @ref: object reference to associated TIPC port
82 *
82 * <various callback routines> 83 * <various callback routines>
83 */ 84 */
84struct user_port { 85struct user_port {