mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-21 07:00:08 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

spa: group the spa headers into doxygen modules

Browse source 
Subdirectories buffer, control, debug, monitor, pod, support and utils, others
are still missing. Headers are grouped either per subdirectory (e.g. buffer/
gets added to group spa_buffer) or per-file (e.g. spa_json is a separate
group), whatever seemed like the most sensible approach.
This commit is contained in:
Peter Hutterer 2021-05-21 14:03:07 +10:00 • committed by Wim Taymans
parent d0aff793b7
commit 07533cb708
72 changed files with 700 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

13
spa/include/spa/utils/ringbuffer.h
View file

@ -29,6 +29,11 @@
extern "C" {
#endif
/**
* \addtogroup spa_utils
* \{
*/
struct spa_ringbuffer;
#include <string.h>
@ -49,7 +54,6 @@ struct spa_ringbuffer {
* Initialize a spa_ringbuffer with \a size.
*
* \param rbuf a spa_ringbuffer
* \param size the number of elements in the ringbuffer
*/
static inline void spa_ringbuffer_init(struct spa_ringbuffer *rbuf)
{
@ -60,6 +64,7 @@ static inline void spa_ringbuffer_init(struct spa_ringbuffer *rbuf)
* Sets the pointers so that the ringbuffer contains \a size bytes.
*
* \param rbuf a spa_ringbuffer
* \param size the target size of \a rbuf
*/
static inline void spa_ringbuffer_set_avail(struct spa_ringbuffer *rbuf, uint32_t size)
{
@ -87,7 +92,7 @@ static inline int32_t spa_ringbuffer_get_read_index(struct spa_ringbuffer *rbuf,
* Read \a len bytes from \a rbuf starting \a offset. \a offset must be taken
* modulo \a size and len should be smaller than \a size.
*
* \param rbuf a #struct spa_ringbuffer
* \param rbuf a struct \ref spa_ringbuffer
* \param buffer memory to read from
* \param size the size of \a buffer
* \param offset offset in \a buffer to read from
@ -166,6 +171,10 @@ static inline void spa_ringbuffer_write_update(struct spa_ringbuffer *rbuf, int3
__atomic_store_n(&rbuf->writeindex, index, __ATOMIC_RELEASE);
}
/**
* \}
*/
#ifdef __cplusplus
} /* extern "C" */