scsi: core: Add kernel-doc for scsi_msg_to_host_byte()
authorRandy Dunlap <rdunlap@infradead.org>
Mon, 8 Apr 2024 02:54:20 +0000 (19:54 -0700)
committerMartin K. Petersen <martin.petersen@oracle.com>
Tue, 9 Apr 2024 02:10:06 +0000 (22:10 -0400)
Add entries for missing documentation to prevent kernel-doc warnings:

scsi_cmnd.h:365: warning: Function parameter or struct member 'cmd' not described in 'scsi_msg_to_host_byte'
scsi_cmnd.h:365: warning: Function parameter or struct member 'msg' not described in 'scsi_msg_to_host_byte'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Link: https://lore.kernel.org/r/20240408025425.18778-4-rdunlap@infradead.org
Reviewed-by: Bart Van Assche <bvanassche@acm.org>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
include/scsi/scsi_cmnd.h

index 526def14e7fb755913b58be7ec97e5629941929f..45c40d200154dd075c785a055d37f9ec8f131456 100644 (file)
@@ -353,6 +353,8 @@ static inline u8 get_host_byte(struct scsi_cmnd *cmd)
 
 /**
  * scsi_msg_to_host_byte() - translate message byte
+ * @cmd: the SCSI command
+ * @msg: the SCSI parallel message byte to translate
  *
  * Translate the SCSI parallel message byte to a matching
  * host byte setting. A message of COMMAND_COMPLETE indicates