diff mbox series

media: cec.h: Fix kerneldoc

Message ID 20240503-fixdoc-v1-1-44d26e6f9dba@chromium.org
State Accepted
Commit e695668af8523b059127dfa8b261c76e7c9cde10
Headers show
Series media: cec.h: Fix kerneldoc | expand

Commit Message

Ricardo Ribalda May 3, 2024, 11:33 a.m. UTC
is_claiming_log_addrs documentation was missing.

fix this kernel-doc warning:
include/media/cec.h:296: warning: Function parameter or struct member 'is_claiming_log_addrs' not described in 'cec_adapter'

Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
---
https://gitlab.freedesktop.org/linux-media/media-staging/-/pipelines/1169148/test_report?job_name=doc
---
 include/media/cec.h | 1 +
 1 file changed, 1 insertion(+)


---
base-commit: 1aa1329a67cc214c3b7bd2a14d1301a795760b07
change-id: 20240503-fixdoc-d1380eb243cd

Best regards,
diff mbox series

Patch

diff --git a/include/media/cec.h b/include/media/cec.h
index d3abe84c9c9e..d131514032f2 100644
--- a/include/media/cec.h
+++ b/include/media/cec.h
@@ -187,6 +187,7 @@  struct cec_adap_ops {
  *	in order to transmit or receive CEC messages. This is usually a HW
  *	limitation.
  * @is_enabled:		the CEC adapter is enabled
+ * @is_claiming_log_addrs:  true if cec_claim_log_addrs() is running
  * @is_configuring:	the CEC adapter is configuring (i.e. claiming LAs)
  * @must_reconfigure:	while configuring, the PA changed, so reclaim LAs
  * @is_configured:	the CEC adapter is configured (i.e. has claimed LAs)