net: qede: fix kernel-doc for qede_ptp_adjfreq()
One of the function arguments was renamed some time ago, but this wasn't reflected in its kernel-doc comment. Also add the description for return values. Signed-off-by: Alexander Lobakin <alobakin@marvell.com> Signed-off-by: Igor Russkikh <irusskikh@marvell.com> Signed-off-by: David S. Miller <davem@davemloft.net>
This commit is contained in:
parent
5ab903418a
commit
50089be6bf
|
@ -28,12 +28,12 @@ struct qede_ptp {
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* qede_ptp_adjfreq
|
* qede_ptp_adjfreq() - Adjust the frequency of the PTP cycle counter.
|
||||||
* @ptp: the ptp clock structure
|
|
||||||
* @ppb: parts per billion adjustment from base
|
|
||||||
*
|
*
|
||||||
* Adjust the frequency of the ptp cycle counter by the
|
* @info: The PTP clock info structure.
|
||||||
* indicated ppb from the base frequency.
|
* @ppb: Parts per billion adjustment from base.
|
||||||
|
*
|
||||||
|
* Return: Zero on success, negative errno otherwise.
|
||||||
*/
|
*/
|
||||||
static int qede_ptp_adjfreq(struct ptp_clock_info *info, s32 ppb)
|
static int qede_ptp_adjfreq(struct ptp_clock_info *info, s32 ppb)
|
||||||
{
|
{
|
||||||
|
|
Loading…
Reference in New Issue