media: dvb_frontend.h: clean up kernel-doc comment
cover media: dvb_frontend.h: clean up kernel-doc comment
This series fixes two minor issues in the kernel-doc comment for dvb_frontend_sleep_until():
- PATCH 1/2 corrects the type description of ktime_t.
- PATCH 2/2 fixes a grammar issue.
These are documentation-only changes with no functional impact.
Jesung Yang (2):
media: dvb_frontend.h: fix ktime_t type description in kernel-doc
media: dvb_frontend.h: fix typo in kernel-doc
include/media/dvb_frontend.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
base-commit: 35392e855abf7d02ad3b061cbc75c7c7c37f0577
Signature · 1 line
2.39.5
PATCH 1/2 media: dvb_frontend.h: fix ktime_t type description in kernel-doc
Fix the kernel-doc comment for dvb_frontend_sleep_until() that incorrectly described ktime_t as a struct.
ktime_t is a typedef for s64, not a struct or union. It was formerly implemented as a union, which was removed in the commit 2456e8553544 ("ktime: Get rid of the union").
--- include/media/dvb_frontend.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/media/dvb_frontend.h +1 -1
@@ -810,7 +810,7 @@ void dvb_frontend_reinitialise(struct dvb_frontend *fe);* dvb_frontend_sleep_until() - Sleep for the amount of time given by * add_usec parameter * -* @waketime: pointer to &struct ktime_t +* @waketime: pointer to &ktime_t * @add_usec: time to sleep, in microseconds * * This function is used to measure the time required for the
Signature · 1 line
2.39.5
PATCH 2/2 media: dvb_frontend.h: fix typo in kernel-doc
In reply to Jesung YangFix grammar in kernel-doc for dvb_frontend_sleep_until() by replacing "Its" to "It's".
--- include/media/dvb_frontend.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
include/media/dvb_frontend.h +1 -1
@@ -818,7 +818,7 @@ void dvb_frontend_reinitialise(struct dvb_frontend *fe);* as possible, as it affects the detection of the dish tone command at the * satellite subsystem. * -* Its used internally by the DVB frontend core, in order to emulate +* It's used internally by the DVB frontend core, in order to emulate * FE_DISHNETWORK_SEND_LEGACY_CMD() using the &dvb_frontend_ops.set_voltage\(\) * callback. *
Signature · 1 line
2.39.5