[PATCH] kernel-doc: fix fusion and i2o docs

Correct lots of typos, kernel-doc warnings, & kernel-doc usage in fusion and
i2o drivers.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@osdl.org>

8 files changed, 41 insertions, 33 deletions

diff --git a/drivers/message/i2o/bus-osm.c b/drivers/message/i2o/bus-osm.c
index d96c687aee93..c463dc2efc09 100644
--- a/drivers/message/i2o/bus-osm.c
+++ b/drivers/message/i2o/bus-osm.c
@@ -56,6 +56,9 @@ static int i2o_bus_scan(struct i2o_device *dev)
 /**
  *      i2o_bus_store_scan - Scan the I2O Bus Adapter
  *      @d: device which should be scanned
+ *      @attr: device_attribute
+ *      @buf: output buffer
+ *      @count: buffer size
  *
  *      Returns count.
  */
diff --git a/drivers/message/i2o/device.c b/drivers/message/i2o/device.c
index 55757af4e3b2..b9df143e4ff1 100644
--- a/drivers/message/i2o/device.c
+++ b/drivers/message/i2o/device.c
@@ -54,8 +54,8 @@ static inline int i2o_device_issue_claim(struct i2o_device *dev, u32 cmd,
  *      @dev: I2O device to claim
  *      @drv: I2O driver which wants to claim the device
  *
- *      Do the leg work to assign a device to a given OSM. If the claim succeed
- *      the owner of the rimary. If the attempt fails a negative errno code
+ *      Do the leg work to assign a device to a given OSM. If the claim succeeds,
+ *      the owner is the primary. If the attempt fails a negative errno code
  *      is returned. On success zero is returned.
  */
 int i2o_device_claim(struct i2o_device *dev)
@@ -208,7 +208,7 @@ static struct i2o_device *i2o_device_alloc(void)
 
 /**
  *      i2o_device_add - allocate a new I2O device and add it to the IOP
- *      @iop: I2O controller where the device is on
+ *      @c: I2O controller that the device is on
  *      @entry: LCT entry of the I2O device
  *
  *      Allocate a new I2O device and initialize it with the LCT entry. The
@@ -280,7 +280,7 @@ err:
 
 /**
  *      i2o_device_remove - remove an I2O device from the I2O core
- *      @dev: I2O device which should be released
+ *      @i2o_dev: I2O device which should be released
  *
  *      Is used on I2O controller removal or LCT modification, when the device
  *      is removed from the system. Note that the device could still hang
diff --git a/drivers/message/i2o/driver.c b/drivers/message/i2o/driver.c
index 7fc7399bd2ec..9104b65ff70f 100644
--- a/drivers/message/i2o/driver.c
+++ b/drivers/message/i2o/driver.c
@@ -34,9 +34,7 @@ static spinlock_t i2o_drivers_lock;
 static struct i2o_driver **i2o_drivers;
 
 /**
- *      i2o_bus_match - Tell if a I2O device class id match the class ids of
- *                      the I2O driver (OSM)
- *
+ *      i2o_bus_match - Tell if I2O device class id matches the class ids of the I2O driver (OSM)
  *      @dev: device which should be verified
  *      @drv: the driver to match against
  *
@@ -248,7 +246,7 @@ int i2o_driver_dispatch(struct i2o_controller *c, u32 m)
 
 /**
  *      i2o_driver_notify_controller_add_all - Send notify of added controller
- *                                             to all I2O drivers
+ *      @c: newly added controller
  *
  *      Send notifications to all registered drivers that a new controller was
  *      added.
@@ -267,8 +265,8 @@ void i2o_driver_notify_controller_add_all(struct i2o_controller *c)
 }
 
 /**
- *      i2o_driver_notify_controller_remove_all - Send notify of removed
- *                                                controller to all I2O drivers
+ *      i2o_driver_notify_controller_remove_all - Send notify of removed controller
+ *      @c: controller that is being removed
  *
  *      Send notifications to all registered drivers that a controller was
  *      removed.
@@ -287,8 +285,8 @@ void i2o_driver_notify_controller_remove_all(struct i2o_controller *c)
 }
 
 /**
- *      i2o_driver_notify_device_add_all - Send notify of added device to all
- *                                         I2O drivers
+ *      i2o_driver_notify_device_add_all - Send notify of added device
+ *      @i2o_dev: newly added I2O device
  *
  *      Send notifications to all registered drivers that a device was added.
  */
@@ -306,8 +304,8 @@ void i2o_driver_notify_device_add_all(struct i2o_device *i2o_dev)
 }
 
 /**
- *      i2o_driver_notify_device_remove_all - Send notify of removed device to
- *                                            all I2O drivers
+ *      i2o_driver_notify_device_remove_all - Send notify of removed device
+ *      @i2o_dev: device that is being removed
  *
  *      Send notifications to all registered drivers that a device was removed.
  */
@@ -362,7 +360,7 @@ int __init i2o_driver_init(void)
 /**
  *      i2o_driver_exit - clean up I2O drivers (OSMs)
  *
- *      Unregisters the I2O bus and free driver array.
+ *      Unregisters the I2O bus and frees driver array.
  */
 void __exit i2o_driver_exit(void)
 {
diff --git a/drivers/message/i2o/exec-osm.c b/drivers/message/i2o/exec-osm.c
index 9e529d8dd5cb..902753b2c661 100644
--- a/drivers/message/i2o/exec-osm.c
+++ b/drivers/message/i2o/exec-osm.c
@@ -94,8 +94,8 @@ static struct i2o_exec_wait *i2o_exec_wait_alloc(void)
 };
 
 /**
- *      i2o_exec_wait_free - Free a i2o_exec_wait struct
- *      @i2o_exec_wait: I2O wait data which should be cleaned up
+ *      i2o_exec_wait_free - Free an i2o_exec_wait struct
+ *      @wait: I2O wait data which should be cleaned up
  */
 static void i2o_exec_wait_free(struct i2o_exec_wait *wait)
 {
@@ -105,7 +105,7 @@ static void i2o_exec_wait_free(struct i2o_exec_wait *wait)
 /**
  *      i2o_msg_post_wait_mem - Post and wait a message with DMA buffers
  *      @c: controller
- *      @m: message to post
+ *      @msg: message to post
  *      @timeout: time in seconds to wait
  *      @dma: i2o_dma struct of the DMA buffer to free on failure
  *
@@ -269,6 +269,7 @@ static int i2o_msg_post_wait_complete(struct i2o_controller *c, u32 m,
 /**
  *      i2o_exec_show_vendor_id - Displays Vendor ID of controller
  *      @d: device of which the Vendor ID should be displayed
+ *      @attr: device_attribute to display
  *      @buf: buffer into which the Vendor ID should be printed
  *
  *      Returns number of bytes printed into buffer.
@@ -290,6 +291,7 @@ static ssize_t i2o_exec_show_vendor_id(struct device *d,
 /**
  *      i2o_exec_show_product_id - Displays Product ID of controller
  *      @d: device of which the Product ID should be displayed
+ *      @attr: device_attribute to display
  *      @buf: buffer into which the Product ID should be printed
  *
  *      Returns number of bytes printed into buffer.
@@ -365,7 +367,7 @@ static int i2o_exec_remove(struct device *dev)
 
 /**
  *      i2o_exec_lct_modified - Called on LCT NOTIFY reply
- *      @c: I2O controller on which the LCT has modified
+ *      @work: work struct for a specific controller
  *
  *      This function handles asynchronus LCT NOTIFY replies. It parses the
  *      new LCT and if the buffer for the LCT was to small sends a LCT NOTIFY
diff --git a/drivers/message/i2o/i2o_block.c b/drivers/message/i2o/i2o_block.c
index 70ae00253321..da9859f2caf2 100644
--- a/drivers/message/i2o/i2o_block.c
+++ b/drivers/message/i2o/i2o_block.c
@@ -259,7 +259,7 @@ static int i2o_block_device_unlock(struct i2o_device *dev, u32 media_id)
 /**
  *      i2o_block_device_power - Power management for device dev
  *      @dev: I2O device which should receive the power management request
- *      @operation: Operation which should be send
+ *      @op: Operation to send
  *
  *      Send a power management request to the device dev.
  *
@@ -315,7 +315,7 @@ static inline struct i2o_block_request *i2o_block_request_alloc(void)
  *      i2o_block_request_free - Frees a I2O block request
  *      @ireq: I2O block request which should be freed
  *
- *      Fres the allocated memory (give it back to the request mempool).
+ *      Frees the allocated memory (give it back to the request mempool).
  */
 static inline void i2o_block_request_free(struct i2o_block_request *ireq)
 {
@@ -326,6 +326,7 @@ static inline void i2o_block_request_free(struct i2o_block_request *ireq)
  *      i2o_block_sglist_alloc - Allocate the SG list and map it
  *      @c: I2O controller to which the request belongs
  *      @ireq: I2O block request
+ *      @mptr: message body pointer
  *
  *      Builds the SG list and map it to be accessable by the controller.
  *
@@ -490,7 +491,7 @@ static void i2o_block_end_request(struct request *req, int uptodate,
  *      i2o_block_reply - Block OSM reply handler.
  *      @c: I2O controller from which the message arrives
  *      @m: message id of reply
- *      qmsg: the actuall I2O message reply
+ *      @msg: the actual I2O message reply
  *
  *      This function gets all the message replies.
  *
@@ -602,6 +603,8 @@ static void i2o_block_biosparam(unsigned long capacity, unsigned short *cyls,
 
 /**
  *      i2o_block_open - Open the block device
+ *      @inode: inode for block device being opened
+ *      @file: file to open
  *
  *      Power up the device, mount and lock the media. This function is called,
  *      if the block device is opened for access.
@@ -629,6 +632,8 @@ static int i2o_block_open(struct inode *inode, struct file *file)
 
 /**
  *      i2o_block_release - Release the I2O block device
+ *      @inode: inode for block device being released
+ *      @file: file to close
  *
  *      Unlock and unmount the media, and power down the device. Gets called if
  *      the block device is closed.
@@ -675,6 +680,8 @@ static int i2o_block_getgeo(struct block_device *bdev, struct hd_geometry *geo)
 
 /**
  *      i2o_block_ioctl - Issue device specific ioctl calls.
+ *      @inode: inode for block device ioctl
+ *      @file: file for ioctl
  *      @cmd: ioctl command
  *      @arg: arg
  *
@@ -902,7 +909,7 @@ static int i2o_block_transfer(struct request *req)
 
 /**
  *      i2o_block_request_fn - request queue handling function
- *      q: request queue from which the request could be fetched
+ *      @q: request queue from which the request could be fetched
  *
  *      Takes the next request from the queue, transfers it and if no error
  *      occurs dequeue it from the queue. On arrival of the reply the message
diff --git a/drivers/message/i2o/i2o_proc.c b/drivers/message/i2o/i2o_proc.c
index 3d2e76eea93e..a61cb17c5c12 100644
--- a/drivers/message/i2o/i2o_proc.c
+++ b/drivers/message/i2o/i2o_proc.c
@@ -163,7 +163,7 @@ static int print_serial_number(struct seq_file *seq, u8 * serialno, int max_len)
  *      i2o_get_class_name -    do i2o class name lookup
  *      @class: class number
  *
- *      Return a descriptive string for an i2o class
+ *      Return a descriptive string for an i2o class.
  */
 static const char *i2o_get_class_name(int class)
 {
diff --git a/drivers/message/i2o/i2o_scsi.c b/drivers/message/i2o/i2o_scsi.c
index d5f93b12b6f1..1045c8a518bb 100644
--- a/drivers/message/i2o/i2o_scsi.c
+++ b/drivers/message/i2o/i2o_scsi.c
@@ -411,8 +411,7 @@ static void i2o_scsi_notify_device_add(struct i2o_device *i2o_dev)
 };
 
 /**
- *      i2o_scsi_notify_device_remove - Retrieve notifications of removed
- *                                      devices
+ *      i2o_scsi_notify_device_remove - Retrieve notifications of removed devices
  *      @i2o_dev: the I2O device which was removed
  *
  *      If a I2O device is removed, we catch the notification to remove the
@@ -432,8 +431,7 @@ static void i2o_scsi_notify_device_remove(struct i2o_device *i2o_dev)
 };
 
 /**
- *      i2o_scsi_notify_controller_add - Retrieve notifications of added
- *                                       controllers
+ *      i2o_scsi_notify_controller_add - Retrieve notifications of added controllers
  *      @c: the controller which was added
  *
  *      If a I2O controller is added, we catch the notification to add a
@@ -463,8 +461,7 @@ static void i2o_scsi_notify_controller_add(struct i2o_controller *c)
 };
 
 /**
- *      i2o_scsi_notify_controller_remove - Retrieve notifications of removed
- *                                          controllers
+ *      i2o_scsi_notify_controller_remove - Retrieve notifications of removed controllers
  *      @c: the controller which was removed
  *
  *      If a I2O controller is removed, we catch the notification to remove the
@@ -751,7 +748,7 @@ static int i2o_scsi_abort(struct scsi_cmnd *SCpnt)
  *      @capacity: size in sectors
  *      @ip: geometry array
  *
- *      This is anyones guess quite frankly. We use the same rules everyone
+ *      This is anyone's guess quite frankly. We use the same rules everyone
  *      else appears to and hope. It seems to work.
  */
 
diff --git a/drivers/message/i2o/pci.c b/drivers/message/i2o/pci.c
index 8287f95c8c42..3661e6e065d2 100644
--- a/drivers/message/i2o/pci.c
+++ b/drivers/message/i2o/pci.c
@@ -259,6 +259,7 @@ static irqreturn_t i2o_pci_interrupt(int irq, void *dev_id)
 
 /**
  *      i2o_pci_irq_enable - Allocate interrupt for I2O controller
+ *      @c: i2o_controller that the request is for
  *
  *      Allocate an interrupt for the I2O controller, and activate interrupts
  *      on the I2O controller.
@@ -305,7 +306,7 @@ static void i2o_pci_irq_disable(struct i2o_controller *c)
 
 /**
  *      i2o_pci_probe - Probe the PCI device for an I2O controller
- *      @dev: PCI device to test
+ *      @pdev: PCI device to test
  *      @id: id which matched with the PCI device id table
  *
  *      Probe the PCI device for any device which is a memory of the
@@ -447,7 +448,7 @@ static int __devinit i2o_pci_probe(struct pci_dev *pdev,
 
 /**
  *      i2o_pci_remove - Removes a I2O controller from the system
- *      pdev: I2O controller which should be removed
+ *      @pdev: I2O controller which should be removed
  *
  *      Reset the I2O controller, disable interrupts and remove all allocated
  *      resources.