diff options
| author | Alexander Lobakin <alobakin@marvell.com> | 2020-07-06 18:38:20 +0300 |
|---|---|---|
| committer | David S. Miller <davem@davemloft.net> | 2020-07-06 13:18:56 -0700 |
| commit | 50089be6bf61310a81e622599d13a68f2309c119 (patch) | |
| tree | 565d400c65ba4d9e3e106df780fe04fb7719bce0 /drivers | |
| parent | 5ab903418ad14732131df0af0d63f19b73e377ae (diff) | |
| download | linux-50089be6bf61310a81e622599d13a68f2309c119.tar.bz2 | |
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>
Diffstat (limited to 'drivers')
| -rw-r--r-- | drivers/net/ethernet/qlogic/qede/qede_ptp.c | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/drivers/net/ethernet/qlogic/qede/qede_ptp.c b/drivers/net/ethernet/qlogic/qede/qede_ptp.c index 60a29a937a94..8c28fabb0ff6 100644 --- a/drivers/net/ethernet/qlogic/qede/qede_ptp.c +++ b/drivers/net/ethernet/qlogic/qede/qede_ptp.c @@ -28,12 +28,12 @@ struct qede_ptp { }; /** - * qede_ptp_adjfreq - * @ptp: the ptp clock structure - * @ppb: parts per billion adjustment from base + * qede_ptp_adjfreq() - Adjust the frequency of the PTP cycle counter. * - * Adjust the frequency of the ptp cycle counter by the - * indicated ppb from the base frequency. + * @info: The PTP clock info structure. + * @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) { |