diff options
author | Ben Hutchings <bhutchings@solarflare.com> | 2012-07-10 06:55:09 -0400 |
---|---|---|
committer | David S. Miller <davem@davemloft.net> | 2012-07-11 02:13:45 -0400 |
commit | 2c53040f018b6c36a46eec75b9b937aaa5f78e6d (patch) | |
tree | f77d987c380f78daf40838688a5f49bb4ab065ee /net/tipc/link.c | |
parent | a55b138b1da3d25c04f66f8df03d659dfd46c950 (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/link.c')
-rw-r--r-- | net/tipc/link.c | 22 |
1 files changed, 11 insertions, 11 deletions
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 | * |