aboutsummaryrefslogtreecommitdiffstats
path: root/net/dccp/feat.c
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/dccp/feat.c
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/dccp/feat.c')
-rw-r--r--net/dccp/feat.c10
1 files changed, 10 insertions, 0 deletions
diff --git a/net/dccp/feat.c b/net/dccp/feat.c
index 78a2ad70e1b0..9733ddbc96cb 100644
--- a/net/dccp/feat.c
+++ b/net/dccp/feat.c
@@ -350,6 +350,7 @@ static int __dccp_feat_activate(struct sock *sk, const int idx,
350 * @feat_num: feature to activate, one of %dccp_feature_numbers 350 * @feat_num: feature to activate, one of %dccp_feature_numbers
351 * @local: whether local (1) or remote (0) @feat_num is meant 351 * @local: whether local (1) or remote (0) @feat_num is meant
352 * @fval: the value (SP or NN) to activate, or NULL to use the default value 352 * @fval: the value (SP or NN) to activate, or NULL to use the default value
353 *
353 * For general use this function is preferable over __dccp_feat_activate(). 354 * For general use this function is preferable over __dccp_feat_activate().
354 */ 355 */
355static int dccp_feat_activate(struct sock *sk, u8 feat_num, bool local, 356static int dccp_feat_activate(struct sock *sk, u8 feat_num, bool local,
@@ -446,6 +447,7 @@ static struct dccp_feat_entry *dccp_feat_list_lookup(struct list_head *fn_list,
446 * @head: list to add to 447 * @head: list to add to
447 * @feat: feature number 448 * @feat: feature number
448 * @local: whether the local (1) or remote feature with number @feat is meant 449 * @local: whether the local (1) or remote feature with number @feat is meant
450 *
449 * This is the only constructor and serves to ensure the above invariants. 451 * This is the only constructor and serves to ensure the above invariants.
450 */ 452 */
451static struct dccp_feat_entry * 453static struct dccp_feat_entry *
@@ -504,6 +506,7 @@ static int dccp_feat_push_change(struct list_head *fn_list, u8 feat, u8 local,
504 * @feat: one of %dccp_feature_numbers 506 * @feat: one of %dccp_feature_numbers
505 * @local: whether local (1) or remote (0) @feat_num is being confirmed 507 * @local: whether local (1) or remote (0) @feat_num is being confirmed
506 * @fval: pointer to NN/SP value to be inserted or NULL 508 * @fval: pointer to NN/SP value to be inserted or NULL
509 *
507 * Returns 0 on success, a Reset code for further processing otherwise. 510 * Returns 0 on success, a Reset code for further processing otherwise.
508 */ 511 */
509static int dccp_feat_push_confirm(struct list_head *fn_list, u8 feat, u8 local, 512static int dccp_feat_push_confirm(struct list_head *fn_list, u8 feat, u8 local,
@@ -691,6 +694,7 @@ int dccp_feat_insert_opts(struct dccp_sock *dp, struct dccp_request_sock *dreq,
691 * @feat: an NN feature from %dccp_feature_numbers 694 * @feat: an NN feature from %dccp_feature_numbers
692 * @mandatory: use Mandatory option if 1 695 * @mandatory: use Mandatory option if 1
693 * @nn_val: value to register (restricted to 4 bytes) 696 * @nn_val: value to register (restricted to 4 bytes)
697 *
694 * Note that NN features are local by definition (RFC 4340, 6.3.2). 698 * Note that NN features are local by definition (RFC 4340, 6.3.2).
695 */ 699 */
696static int __feat_register_nn(struct list_head *fn, u8 feat, 700static int __feat_register_nn(struct list_head *fn, u8 feat,
@@ -760,6 +764,7 @@ int dccp_feat_register_sp(struct sock *sk, u8 feat, u8 is_local,
760 * dccp_feat_nn_get - Query current/pending value of NN feature 764 * dccp_feat_nn_get - Query current/pending value of NN feature
761 * @sk: DCCP socket of an established connection 765 * @sk: DCCP socket of an established connection
762 * @feat: NN feature number from %dccp_feature_numbers 766 * @feat: NN feature number from %dccp_feature_numbers
767 *
763 * For a known NN feature, returns value currently being negotiated, or 768 * For a known NN feature, returns value currently being negotiated, or
764 * current (confirmed) value if no negotiation is going on. 769 * current (confirmed) value if no negotiation is going on.
765 */ 770 */
@@ -790,6 +795,7 @@ EXPORT_SYMBOL_GPL(dccp_feat_nn_get);
790 * @sk: DCCP socket of an established connection 795 * @sk: DCCP socket of an established connection
791 * @feat: NN feature number from %dccp_feature_numbers 796 * @feat: NN feature number from %dccp_feature_numbers
792 * @nn_val: the new value to use 797 * @nn_val: the new value to use
798 *
793 * This function is used to communicate NN updates out-of-band. 799 * This function is used to communicate NN updates out-of-band.
794 */ 800 */
795int dccp_feat_signal_nn_change(struct sock *sk, u8 feat, u64 nn_val) 801int dccp_feat_signal_nn_change(struct sock *sk, u8 feat, u64 nn_val)
@@ -930,6 +936,7 @@ static const struct ccid_dependency *dccp_feat_ccid_deps(u8 ccid, bool is_local)
930 * @fn: feature-negotiation list to update 936 * @fn: feature-negotiation list to update
931 * @id: CCID number to track 937 * @id: CCID number to track
932 * @is_local: whether TX CCID (1) or RX CCID (0) is meant 938 * @is_local: whether TX CCID (1) or RX CCID (0) is meant
939 *
933 * This function needs to be called after registering all other features. 940 * This function needs to be called after registering all other features.
934 */ 941 */
935static int dccp_feat_propagate_ccid(struct list_head *fn, u8 id, bool is_local) 942static int dccp_feat_propagate_ccid(struct list_head *fn, u8 id, bool is_local)
@@ -953,6 +960,7 @@ static int dccp_feat_propagate_ccid(struct list_head *fn, u8 id, bool is_local)
953/** 960/**
954 * dccp_feat_finalise_settings - Finalise settings before starting negotiation 961 * dccp_feat_finalise_settings - Finalise settings before starting negotiation
955 * @dp: client or listening socket (settings will be inherited) 962 * @dp: client or listening socket (settings will be inherited)
963 *
956 * This is called after all registrations (socket initialisation, sysctls, and 964 * This is called after all registrations (socket initialisation, sysctls, and
957 * sockopt calls), and before sending the first packet containing Change options 965 * sockopt calls), and before sending the first packet containing Change options
958 * (ie. client-Request or server-Response), to ensure internal consistency. 966 * (ie. client-Request or server-Response), to ensure internal consistency.
@@ -1284,6 +1292,7 @@ confirmation_failed:
1284 * @feat: NN number, one of %dccp_feature_numbers 1292 * @feat: NN number, one of %dccp_feature_numbers
1285 * @val: NN value 1293 * @val: NN value
1286 * @len: length of @val in bytes 1294 * @len: length of @val in bytes
1295 *
1287 * This function combines the functionality of change_recv/confirm_recv, with 1296 * This function combines the functionality of change_recv/confirm_recv, with
1288 * the following differences (reset codes are the same): 1297 * the following differences (reset codes are the same):
1289 * - cleanup after receiving the Confirm; 1298 * - cleanup after receiving the Confirm;
@@ -1379,6 +1388,7 @@ fast_path_failed:
1379 * @feat: one of %dccp_feature_numbers 1388 * @feat: one of %dccp_feature_numbers
1380 * @val: value contents of @opt 1389 * @val: value contents of @opt
1381 * @len: length of @val in bytes 1390 * @len: length of @val in bytes
1391 *
1382 * Returns 0 on success, a Reset code for ending the connection otherwise. 1392 * Returns 0 on success, a Reset code for ending the connection otherwise.
1383 */ 1393 */
1384int dccp_feat_parse_options(struct sock *sk, struct dccp_request_sock *dreq, 1394int dccp_feat_parse_options(struct sock *sk, struct dccp_request_sock *dreq,