mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-14 06:59:57 -05:00
spa: group the spa headers into doxygen modules
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:
parent
d0aff793b7
commit
07533cb708
72 changed files with 700 additions and 21 deletions
|
|
@ -29,6 +29,14 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** \defgroup spa_pod SPA POD
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup spa_pod
|
||||
* \{
|
||||
*/
|
||||
|
||||
#include <stdarg.h>
|
||||
|
||||
#include <spa/utils/hook.h>
|
||||
|
|
@ -676,6 +684,10 @@ spa_pod_copy(const struct spa_pod *pod)
|
|||
return (struct spa_pod *) memcpy(c, pod, size);
|
||||
}
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -32,6 +32,11 @@ extern "C" {
|
|||
#include <spa/utils/defs.h>
|
||||
#include <spa/pod/pod.h>
|
||||
|
||||
/**
|
||||
* \addtogroup spa_pod
|
||||
* \{
|
||||
*/
|
||||
|
||||
struct spa_command_body {
|
||||
struct spa_pod_object_body body;
|
||||
};
|
||||
|
|
@ -53,6 +58,9 @@ struct spa_command {
|
|||
SPA_COMMAND_INIT_FULL(struct spa_command, \
|
||||
sizeof(struct spa_command_body), type, id)
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
|
|
|
|||
|
|
@ -40,6 +40,11 @@ extern "C" {
|
|||
#include <spa/pod/iter.h>
|
||||
#include <spa/pod/builder.h>
|
||||
|
||||
/**
|
||||
* \addtogroup spa_pod
|
||||
* \{
|
||||
*/
|
||||
|
||||
static inline int spa_pod_compare_value(uint32_t type, const void *r1, const void *r2, uint32_t size)
|
||||
{
|
||||
switch (type) {
|
||||
|
|
@ -174,6 +179,10 @@ static inline int spa_pod_compare(const struct spa_pod *pod1,
|
|||
return res;
|
||||
}
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -31,6 +31,11 @@ extern "C" {
|
|||
|
||||
#include <spa/pod/pod.h>
|
||||
|
||||
/**
|
||||
* \addtogroup spa_pod
|
||||
* \{
|
||||
*/
|
||||
|
||||
struct spa_event_body {
|
||||
struct spa_pod_object_body body;
|
||||
};
|
||||
|
|
@ -52,6 +57,10 @@ struct spa_event {
|
|||
SPA_EVENT_INIT_FULL(struct spa_event, \
|
||||
sizeof(struct spa_event_body), type, id)
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -33,6 +33,11 @@
|
|||
#include <spa/pod/builder.h>
|
||||
#include <spa/pod/compare.h>
|
||||
|
||||
/**
|
||||
* \addtogroup spa_pod
|
||||
* \{
|
||||
*/
|
||||
|
||||
static inline int spa_pod_choice_fix_default(struct spa_pod_choice *choice)
|
||||
{
|
||||
void *val, *alt;
|
||||
|
|
@ -398,3 +403,7 @@ spa_pod_filter(struct spa_pod_builder *b,
|
|||
}
|
||||
return res;
|
||||
}
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -34,6 +34,11 @@ extern "C" {
|
|||
|
||||
#include <spa/pod/pod.h>
|
||||
|
||||
/**
|
||||
* \addtogroup spa_pod
|
||||
* \{
|
||||
*/
|
||||
|
||||
struct spa_pod_frame {
|
||||
struct spa_pod pod;
|
||||
struct spa_pod_frame *parent;
|
||||
|
|
@ -440,6 +445,10 @@ static inline int spa_pod_fixate(struct spa_pod *pod)
|
|||
return spa_pod_object_fixate((struct spa_pod_object *)pod);
|
||||
}
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -35,6 +35,11 @@ extern "C" {
|
|||
#include <spa/pod/iter.h>
|
||||
#include <spa/pod/vararg.h>
|
||||
|
||||
/**
|
||||
* \addtogroup spa_pod
|
||||
* \{
|
||||
*/
|
||||
|
||||
struct spa_pod_parser_state {
|
||||
uint32_t offset;
|
||||
uint32_t flags;
|
||||
|
|
@ -566,6 +571,10 @@ static inline int spa_pod_parser_get(struct spa_pod_parser *parser, ...)
|
|||
spa_pod_parser_get_struct(&_p,##__VA_ARGS__); \
|
||||
})
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -32,6 +32,11 @@ extern "C" {
|
|||
#include <spa/utils/defs.h>
|
||||
#include <spa/utils/type.h>
|
||||
|
||||
/**
|
||||
* \addtogroup spa_pod
|
||||
* \{
|
||||
*/
|
||||
|
||||
#define SPA_POD_BODY_SIZE(pod) (((struct spa_pod*)(pod))->size)
|
||||
#define SPA_POD_TYPE(pod) (((struct spa_pod*)(pod))->type)
|
||||
#define SPA_POD_SIZE(pod) (sizeof(struct spa_pod) + SPA_POD_BODY_SIZE(pod))
|
||||
|
|
@ -229,6 +234,9 @@ struct spa_pod_sequence {
|
|||
struct spa_pod_sequence_body body;
|
||||
};
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
|
|
|
|||
|
|
@ -33,6 +33,11 @@ extern "C" {
|
|||
|
||||
#include <spa/pod/pod.h>
|
||||
|
||||
/**
|
||||
* \addtogroup spa_pod
|
||||
* \{
|
||||
*/
|
||||
|
||||
#define SPA_POD_Prop(key,...) \
|
||||
key, ##__VA_ARGS__
|
||||
|
||||
|
|
@ -97,6 +102,10 @@ extern "C" {
|
|||
#define SPA_POD_PodStruct(val) "T", val
|
||||
#define SPA_POD_PodChoice(val) "V", val
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue