summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorRandy Dunlap <rdunlap@infradead.org>2026-02-24 03:31:34 +0300
committerLeon Romanovsky <leon@kernel.org>2026-02-24 13:39:13 +0300
commit16dc2d72de577de4b413ba01b1b4a80d31832022 (patch)
tree17f37a2c5575469036d5f787ddbe01e347debdfa /include
parentff46d1392750444fab5ae5a0194764ffdc4ac0d2 (diff)
downloadlinux-16dc2d72de577de4b413ba01b1b4a80d31832022.tar.xz
RDMA/iwcm: fix some kernel-doc issues in iw_cm.h
Use the "typedef" keyword as needed. Correct 2 function parameter names. Warning: include/rdma/iw_cm.h:42 function parameter 'iw_cm_handler' not described in 'int' Warning: include/rdma/iw_cm.h:42 expecting prototype for iw_cm_handler(). Prototype was for int() instead Warning: include/rdma/iw_cm.h:53 function parameter 'iw_event_handler' not described in 'int' Warning: include/rdma/iw_cm.h:53 expecting prototype for iw_event_handler(). Prototype was for int() instead Warning: include/rdma/iw_cm.h:104 function parameter 'cm_handler' not described in 'iw_create_cm_id' Warning: include/rdma/iw_cm.h:158 function parameter 'private_data' not described in 'iw_cm_reject' (not adding missing return value kernel-doc descriptions) Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Link: https://patch.msgid.link/20260224003134.3174856-1-rdunlap@infradead.org Signed-off-by: Leon Romanovsky <leon@kernel.org>
Diffstat (limited to 'include')
-rw-r--r--include/rdma/iw_cm.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/include/rdma/iw_cm.h b/include/rdma/iw_cm.h
index 2b22f153ef63..57b33edd9ce7 100644
--- a/include/rdma/iw_cm.h
+++ b/include/rdma/iw_cm.h
@@ -33,8 +33,8 @@ struct iw_cm_event {
};
/**
- * iw_cm_handler - Function to be called by the IW CM when delivering events
- * to the client.
+ * typedef iw_cm_handler - Function to be called by the IW CM when delivering
+ * events to the client.
*
* @cm_id: The IW CM identifier associated with the event.
* @event: Pointer to the event structure.
@@ -43,9 +43,9 @@ typedef int (*iw_cm_handler)(struct iw_cm_id *cm_id,
struct iw_cm_event *event);
/**
- * iw_event_handler - Function called by the provider when delivering provider
- * events to the IW CM. Returns either 0 indicating the event was processed
- * or -errno if the event could not be processed.
+ * typedef iw_event_handler - Function called by the provider when delivering
+ * provider events to the IW CM. Returns either 0 indicating the event was
+ * processed or -errno if the event could not be processed.
*
* @cm_id: The IW CM identifier associated with the event.
* @event: Pointer to the event structure.
@@ -97,7 +97,7 @@ enum iw_flags {
* iw_create_cm_id - Create an IW CM identifier.
*
* @device: The IB device on which to create the IW CM identier.
- * @event_handler: User callback invoked to report events associated with the
+ * @cm_handler: User callback invoked to report events associated with the
* returned IW CM identifier.
* @context: User specified context associated with the id.
*/
@@ -147,7 +147,7 @@ int iw_cm_accept(struct iw_cm_id *cm_id, struct iw_cm_conn_param *iw_param);
* iw_cm_reject - Reject an incoming connection request.
*
* @cm_id: Connection identifier associated with the request.
- * @private_daa: Pointer to data to deliver to the remote peer as part of the
+ * @private_data: Pointer to data to deliver to the remote peer as part of the
* reject message.
* @private_data_len: The number of bytes in the private_data parameter.
*