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

vlc_frame: fix doxygen warnings 

include/vlc_frame.h:359: warning: The following parameter of vlc_frame_FilePath(const char *path, bool write) is not documented:
      parameter 'path'

    include/vlc_frame.h:250: warning: The following parameter of vlc_frame_GetAncillary(vlc_frame_t *frame, vlc_ancillary_id id) is not documented:
      parameter 'frame'

    include/vlc_frame.h:199: warning: The following parameter of vlc_frame_Realloc(vlc_frame_t *frame, ssize_t pre, size_t body) is not documented:
      parameter 'frame'

    include/vlc_frame.h:696: warning: The following parameter of vlc_fifo_QueueUnlocked(vlc_fifo_t *fifo, vlc_frame_t *block) is not documented:
      parameter 'fifo'
This commit is contained in:
Alexandre Janniaux 2023-07-06 11:54:42 +02:00 committed by Steve Lhomme
parent 1260ff24ed
commit abcb51f48b
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/vlc_frame.h
View File

@ -200,6 +200,8 @@ VLC_API vlc_frame_t *vlc_frame_TryRealloc(vlc_frame_t *, ssize_t pre, size_t bod
* reusing spare buffer space. Otherwise, a new frame is created and data is
* copied.
*
* @param frame the frame to realloc, which will be freed after the call to
* this function
* @param pre count of bytes to prepend if positive,
* count of leading bytes to discard if negative
* @param body new bytes size of the frame
@ -213,7 +215,8 @@ VLC_API vlc_frame_t *vlc_frame_TryRealloc(vlc_frame_t *, ssize_t pre, size_t bod
* @note On error, the frame is discarded.
* To avoid that, use vlc_frame_TryRealloc() instead.
*/
VLC_API vlc_frame_t *vlc_frame_Realloc(vlc_frame_t *, ssize_t pre, size_t body) VLC_USED;
VLC_API vlc_frame_t *
vlc_frame_Realloc(vlc_frame_t *frame, ssize_t pre, size_t body) VLC_USED;
/**
* Releases a frame.
@ -248,6 +251,7 @@ vlc_frame_AttachAncillary(vlc_frame_t *frame, struct vlc_ancillary *ancillary);
/**
* Return the ancillary identified by an ID
*
* @param frame the frame to read the ancillary from
* @param id id of ancillary to request
* @return the ancillary or NULL if the ancillary for that particular id is
* not present
@ -358,10 +362,13 @@ VLC_API vlc_frame_t *vlc_frame_File(int fd, bool write) VLC_USED VLC_MALLOC;
* Loads a file into a frame of memory from a path to the file.
* See also vlc_frame_File().
*
* @param path the file path to load the memory block from
* @param write If true, request a read/write private mapping.
* If false, request a read-only potentially shared mapping.
*/
VLC_API vlc_frame_t *vlc_frame_FilePath(const char *, bool write) VLC_USED VLC_MALLOC;
VLC_API vlc_frame_t *
vlc_frame_FilePath(const char *path, bool write)
VLC_USED VLC_MALLOC;
static inline void vlc_frame_Cleanup (void *frame)
{
@ -692,6 +699,7 @@ static inline void vlc_fifo_WaitCond(vlc_fifo_t *fifo, vlc_cond_t *condvar)
/**
* Queues a linked-list of blocks into a locked FIFO.
*
* @param fifo a fifo object locked with ::vlc_fifo_Lock()
* @param block the head of the list of blocks
* (if NULL, this function has no effects)
*