[vlc-devel] [PATCH] vlc_codec: decoder_QueueCc: fix documentation

Filip Roséen filip at atch.se
Thu May 18 12:50:30 CEST 2017


These changes include removal of a duplicate usage of "queues", as
well as extending the documentation to include description of all
arguments.
---
 include/vlc_codec.h | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/include/vlc_codec.h b/include/vlc_codec.h
index 4066b72792..f152fa14cf 100644
--- a/include/vlc_codec.h
+++ b/include/vlc_codec.h
@@ -305,8 +305,12 @@ static inline int decoder_QueueVideo( decoder_t *dec, picture_t *p_pic )
 }
 
 /**
- * This function queues queues the Closed Captions
+ * This function queues the Closed Captions
  *
+ * \param dec the decoder object
+ * \param p_cc the closed-caption to queue
+ * \param p_cc_present array-of-bool where each entry indicates whether the
+ *                     given channel is present or not
  * \return 0 if queued, -1 on error
  */
 static inline int decoder_QueueCc( decoder_t *dec, block_t *p_cc,
-- 
2.12.2


More information about the vlc-devel mailing list