• Randy Dunlap's avatar
    scsi: mpi3mr: Fix some kernel-doc warnings in scsi_bsg_mpi3mr.h · aca06177
    Randy Dunlap authored
    Correct the name of a struct in kernel-doc to match the actual function
    name.
    
    Add kernel-doc comments for 2 reserved fields to match comments for other
    reserved fields.
    
    Correct the kernel-doc comments for a nested struct to eliminate kernel-doc
    warnings for them.
    
    Warnings fixed here are:
    
    scsi_bsg_mpi3mr.h:419: warning: expecting prototype for struct mpi3mr_bsg_buf_entry_list. Prototype was for struct mpi3mr_buf_entry_list instead
    
    scsi_bsg_mpi3mr.h:435: warning: Function parameter or struct member 'rsvd2' not described in 'mpi3mr_bsg_mptcmd'
    scsi_bsg_mpi3mr.h:456: warning: Function parameter or struct member 'rsvd3' not described in 'mpi3mr_bsg_packet'
    
    scsi_bsg_mpi3mr.h:456: warning: Excess struct member 'drvrcmd' description in 'mpi3mr_bsg_packet'
    scsi_bsg_mpi3mr.h:456: warning: Excess struct member 'mptcmd' description in 'mpi3mr_bsg_packet'
    Signed-off-by: default avatarRandy Dunlap <rdunlap@infradead.org>
    Link: https://lore.kernel.org/r/20240424055322.1400-1-rdunlap@infradead.org
    Cc: James E.J. Bottomley <James.Bottomley@HansenPartnership.com>
    Cc: Martin K. Petersen <martin.petersen@oracle.com>
    Cc: Sathya Prakash Veerichetty <sathya.prakash@broadcom.com>
    Cc: Kashyap Desai <kashyap.desai@broadcom.com>
    Cc: Sumit Saxena <sumit.saxena@broadcom.com>
    Cc: Sreekanth Reddy <sreekanth.reddy@broadcom.com>
    Cc: mpi3mr-linuxdrv.pdl@broadcom.com
    Signed-off-by: default avatarMartin K. Petersen <martin.petersen@oracle.com>
    aca06177
scsi_bsg_mpi3mr.h 15.1 KB