github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-05-12 16:18:45 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

RDMA/iwcm: fix some kernel-doc issues in iw_cm.h

Browse Source 
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>
This commit is contained in:
Randy Dunlap 2026-02-23 16:31:34 -08:00 committed by Leon Romanovsky
parent ff46d13927
commit 16dc2d72de
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/rdma/iw_cm.h
View File

@ -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.
*