videolan
/
vlc
mirror of https://code.videolan.org/videolan/vlc
1
Fork 0
Code Releases Activity

vlc_queue: fix doxygen warnings 

include/vlc_queue.h:188: warning: The following parameter of vlc_queue_Enqueue(vlc_queue_t *q, void *entry) is not documented:
      parameter 'q'

    include/vlc_queue.h:130: warning: The following parameter of vlc_queue_EnqueueUnlocked(vlc_queue_t *q, void *entry) is not documented:
      parameter 'q'
This commit is contained in:
Alexandre Janniaux 2023-07-06 09:54:55 +02:00 committed by Steve Lhomme
parent ed1cf916b7
commit a0e6fc35d1
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/vlc_queue.h
View File

@ -132,10 +132,11 @@ static inline void vlc_queue_Wait(vlc_queue_t *q)
* @warning It is assumed that the caller already holds the queue lock;
* otherwise the behaviour is undefined.
*
* @param q A queue locked with ::vlc_queue_Lock
* @param entry NULL-terminated list of entries to queue
* (if NULL, this function has no effects)
*/
VLC_API void vlc_queue_EnqueueUnlocked(vlc_queue_t *, void *entry);
VLC_API void vlc_queue_EnqueueUnlocked(vlc_queue_t *q, void *entry);
/**
* Dequeues the oldest entry (without locking).
@ -187,9 +188,10 @@ VLC_USED static inline bool vlc_queue_IsEmpty(const vlc_queue_t *q)
* This function enqueues an entry, or rather a linked-list of entries, in a
* thread-safe queue.
*
* @param q A queue initialized with ::vlc_queue_Init
* @param entry list of entries (if NULL, this function has no effects)
*/
VLC_API void vlc_queue_Enqueue(vlc_queue_t *, void *entry);
VLC_API void vlc_queue_Enqueue(vlc_queue_t *q, void *entry);
/**
* Dequeues the oldest entry.