diff mbox series

[FFmpeg-devel,v2] lavfi/dnn/queue.h: Add Documentation to Queue

Message ID 20210426075408.8993-1-shubhanshu.e01@gmail.com
State Accepted
Headers show
Series [FFmpeg-devel,v2] lavfi/dnn/queue.h: Add Documentation to Queue
Related show

Checks

Context Check Description
andriy/x86_make success Make finished
andriy/x86_make_fate success Make fate finished
andriy/PPC64_make success Make finished
andriy/PPC64_make_fate success Make fate finished

Commit Message

Shubhanshu Saxena April 26, 2021, 7:54 a.m. UTC
Documentation for Queue

Signed-off-by: Shubhanshu Saxena <shubhanshu.e01@gmail.com>
---
 libavfilter/dnn/queue.h | 75 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 75 insertions(+)

Comments

Guo, Yejun April 27, 2021, 2:15 a.m. UTC | #1
> -----Original Message-----
> From: ffmpeg-devel <ffmpeg-devel-bounces@ffmpeg.org> On Behalf Of
> Shubhanshu Saxena
> Sent: 2021年4月26日 15:54
> To: ffmpeg-devel@ffmpeg.org
> Cc: Shubhanshu Saxena <shubhanshu.e01@gmail.com>
> Subject: [FFmpeg-devel] [PATCH v2] lavfi/dnn/queue.h: Add Documentation
> to Queue
> 
> Documentation for Queue
> 
> Signed-off-by: Shubhanshu Saxena <shubhanshu.e01@gmail.com>
> ---
>  libavfilter/dnn/queue.h | 75
> +++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 75 insertions(+)
> 
> diff --git a/libavfilter/dnn/queue.h b/libavfilter/dnn/queue.h
> index 4d7121366a..2524d5fa59 100644
> --- a/libavfilter/dnn/queue.h
> +++ b/libavfilter/dnn/queue.h
> @@ -22,20 +22,95 @@

LGTM, both patches pushed, thanks.
diff mbox series

Patch

diff --git a/libavfilter/dnn/queue.h b/libavfilter/dnn/queue.h
index 4d7121366a..2524d5fa59 100644
--- a/libavfilter/dnn/queue.h
+++ b/libavfilter/dnn/queue.h
@@ -22,20 +22,95 @@ 
 #ifndef AVFILTER_DNN_QUEUE_H
 #define AVFILTER_DNN_QUEUE_H
 
+/**
+ * Linear double-ended data structure
+ */
 typedef struct Queue Queue;
 
+/**
+ * @brief Create a Queue instance.
+ * It initializes the length of the Queue as 0.
+ *
+ * @return Pointer to the Queue
+ * @retval NULL if allocation fails
+ */
 Queue *ff_queue_create(void);
+
+/**
+ * @brief Destroy the Queue instance.
+ * It also frees all elements of the Queue.
+ */
 void ff_queue_destroy(Queue *q);
 
+/**
+ * @brief Return the length of the Queue
+ */
 size_t ff_queue_size(Queue *q);
 
+/**
+ * @brief Return a pointer to the data
+ * at the head of the queue.
+ *
+ * @retval NULL if null pointer was passed
+ * or queue is empty
+ */
 void *ff_queue_peek_front(Queue *q);
+
+/**
+ * @brief Return a pointer to the data at
+ * the tail of the queue.
+ *
+ * @retval NULL if null pointer was passed
+ * or queue is empty
+ */
 void *ff_queue_peek_back(Queue *q);
 
+/**
+ * @brief Add data to the head of the queue.
+ * It increases the length of Queue by one.
+ *
+ * @param q pointer to the Queue.
+ * @param v data to be added
+ * @return The length of the Queue
+ * @retval 0 if the pointer to queue is NULL
+ * @retval -1 if new entry cannot be created
+ */
 int ff_queue_push_front(Queue *q, void *v);
+
+/**
+ * @brief Add data to the tail of the queue.
+ * It increases the length of Queue by one.
+ *
+ * @param q pointer to the Queue
+ * @param v data to be added
+ * @return The length of the Queue
+ * @retval 0 if the pointer to queue is NULL
+ * @retval -1 if new entry cannot be created
+ */
 int ff_queue_push_back(Queue *q, void *v);
 
+/**
+ * @brief Remove and free first element from
+ * the Queue. It shrinks the length of Queue
+ * by one.
+ *
+ * @param q pointer to the Queue.
+ * @return The value of first element as void.
+ * If a null pointer or empty queue is passed,
+ * it returns NULL
+ */
 void *ff_queue_pop_front(Queue *q);
+
+/**
+ * @brief Remove and free last element from
+ * the Queue. It shrinks the length of Queue
+ * by one.
+ *
+ * @param q pointer to the Queue.
+ * @return The value of last element as void.
+ * If a null pointer or empty queue is passed,
+ * it returns NULL
+ */
 void *ff_queue_pop_back(Queue *q);
 
 #endif