mei: fix function names and format in KDoc

Align functions names in KDoc with real ones.
Fix comment format to be KDoc and fix wrong syntax there.

Signed-off-by: Alexander Usyskin <alexander.usyskin@intel.com>
Signed-off-by: Tomas Winkler <tomas.winkler@intel.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Alexander Usyskin 2015-02-10 10:39:35 +02:00 committed by Greg Kroah-Hartman
parent 2d1995fce3
commit 3908be6f9a
4 changed files with 17 additions and 16 deletions

View File

@ -321,7 +321,7 @@ static inline bool mei_cl_cmp_id(const struct mei_cl *cl1,
}
/**
* mei_io_list_flush - removes cbs belonging to cl.
* __mei_io_list_flush - removes and frees cbs belonging to cl.
*
* @list: an instance of our list structure
* @cl: host client, can be NULL for flushing the whole list
@ -540,10 +540,11 @@ struct mei_cl_cb *mei_cl_find_read_cb(struct mei_cl *cl)
return NULL;
}
/** mei_cl_link: allocate host id in the host map
/**
* mei_cl_link - allocate host id in the host map
*
* @cl - host client
* @id - fixed host id or -1 for generic one
* @cl: host client
* @id: fixed host id or -1 for generic one
*
* Return: 0 on success
* -EINVAL on incorrect values

View File

@ -412,7 +412,7 @@ static void mei_txe_intr_disable(struct mei_device *dev)
mei_txe_br_reg_write(hw, HIER_REG, 0);
}
/**
* mei_txe_intr_disable - enable all interrupts
* mei_txe_intr_enable - enable all interrupts
*
* @dev: the device structure
*/

View File

@ -63,7 +63,7 @@ static void mei_txe_pci_iounmap(struct pci_dev *pdev, struct mei_txe_hw *hw)
}
}
/**
* mei_probe - Device Initialization Routine
* mei_txe_probe - Device Initialization Routine
*
* @pdev: PCI device structure
* @ent: entry in mei_txe_pci_tbl
@ -193,7 +193,7 @@ end:
}
/**
* mei_remove - Device Removal Routine
* mei_txe_remove - Device Removal Routine
*
* @pdev: PCI device structure
*

View File

@ -202,10 +202,10 @@ err:
return ret;
}
/*
/**
* mei_wd_ops_start - wd start command from the watchdog core.
*
* @wd_dev - watchdog device struct
* @wd_dev: watchdog device struct
*
* Return: 0 if success, negative errno code for failure
*/
@ -239,10 +239,10 @@ end_unlock:
return err;
}
/*
/**
* mei_wd_ops_stop - wd stop command from the watchdog core.
*
* @wd_dev - watchdog device struct
* @wd_dev: watchdog device struct
*
* Return: 0 if success, negative errno code for failure
*/
@ -261,10 +261,10 @@ static int mei_wd_ops_stop(struct watchdog_device *wd_dev)
return 0;
}
/*
/**
* mei_wd_ops_ping - wd ping command from the watchdog core.
*
* @wd_dev - watchdog device struct
* @wd_dev: watchdog device struct
*
* Return: 0 if success, negative errno code for failure
*/
@ -311,11 +311,11 @@ end:
return ret;
}
/*
/**
* mei_wd_ops_set_timeout - wd set timeout command from the watchdog core.
*
* @wd_dev - watchdog device struct
* @timeout - timeout value to set
* @wd_dev: watchdog device struct
* @timeout: timeout value to set
*
* Return: 0 if success, negative errno code for failure
*/