Commit 9f6aa575 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds

scsi_scan.c: fix/convert functions to use kernel-doc

scsi_scan.c: fix incorrectly formatted kernel-doc notation
& convert documentation of 2 functions into kernel-doc.
Signed-off-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 89bbfb6b
...@@ -1220,7 +1220,7 @@ static void scsi_sequential_lun_scan(struct scsi_target *starget, ...@@ -1220,7 +1220,7 @@ static void scsi_sequential_lun_scan(struct scsi_target *starget,
} }
/** /**
* scsilun_to_int: convert a scsi_lun to an int * scsilun_to_int - convert a scsi_lun to an int
* @scsilun: struct scsi_lun to be converted. * @scsilun: struct scsi_lun to be converted.
* *
* Description: * Description:
...@@ -1252,7 +1252,7 @@ int scsilun_to_int(struct scsi_lun *scsilun) ...@@ -1252,7 +1252,7 @@ int scsilun_to_int(struct scsi_lun *scsilun)
EXPORT_SYMBOL(scsilun_to_int); EXPORT_SYMBOL(scsilun_to_int);
/** /**
* int_to_scsilun: reverts an int into a scsi_lun * int_to_scsilun - reverts an int into a scsi_lun
* @lun: integer to be reverted * @lun: integer to be reverted
* @scsilun: struct scsi_lun to be set. * @scsilun: struct scsi_lun to be set.
* *
...@@ -1876,12 +1876,9 @@ void scsi_forget_host(struct Scsi_Host *shost) ...@@ -1876,12 +1876,9 @@ void scsi_forget_host(struct Scsi_Host *shost)
spin_unlock_irqrestore(shost->host_lock, flags); spin_unlock_irqrestore(shost->host_lock, flags);
} }
/* /**
* Function: scsi_get_host_dev() * scsi_get_host_dev - Create a scsi_device that points to the host adapter itself
* * @shost: Host that needs a scsi_device
* Purpose: Create a scsi_device that points to the host adapter itself.
*
* Arguments: SHpnt - Host that needs a scsi_device
* *
* Lock status: None assumed. * Lock status: None assumed.
* *
...@@ -1894,7 +1891,7 @@ void scsi_forget_host(struct Scsi_Host *shost) ...@@ -1894,7 +1891,7 @@ void scsi_forget_host(struct Scsi_Host *shost)
* *
* Note - this device is not accessible from any high-level * Note - this device is not accessible from any high-level
* drivers (including generics), which is probably not * drivers (including generics), which is probably not
* optimal. We can add hooks later to attach * optimal. We can add hooks later to attach.
*/ */
struct scsi_device *scsi_get_host_dev(struct Scsi_Host *shost) struct scsi_device *scsi_get_host_dev(struct Scsi_Host *shost)
{ {
...@@ -1920,18 +1917,13 @@ struct scsi_device *scsi_get_host_dev(struct Scsi_Host *shost) ...@@ -1920,18 +1917,13 @@ struct scsi_device *scsi_get_host_dev(struct Scsi_Host *shost)
} }
EXPORT_SYMBOL(scsi_get_host_dev); EXPORT_SYMBOL(scsi_get_host_dev);
/* /**
* Function: scsi_free_host_dev() * scsi_free_host_dev - Free a scsi_device that points to the host adapter itself
* * @sdev: Host device to be freed
* Purpose: Free a scsi_device that points to the host adapter itself.
*
* Arguments: SHpnt - Host that needs a scsi_device
* *
* Lock status: None assumed. * Lock status: None assumed.
* *
* Returns: Nothing * Returns: Nothing
*
* Notes:
*/ */
void scsi_free_host_dev(struct scsi_device *sdev) void scsi_free_host_dev(struct scsi_device *sdev)
{ {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment