mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-16 07:00:00 -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,11 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* \addtogroup spa_node
|
||||
* \{
|
||||
*/
|
||||
|
||||
#include <spa/pod/command.h>
|
||||
|
||||
/* object id of SPA_TYPE_COMMAND_Node */
|
||||
|
|
@ -55,6 +60,10 @@ enum spa_node_command {
|
|||
#define SPA_NODE_COMMAND_INIT(id) SPA_COMMAND_INIT(SPA_TYPE_COMMAND_Node, id)
|
||||
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -29,6 +29,11 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* \addtogroup spa_node
|
||||
* \{
|
||||
*/
|
||||
|
||||
#include <spa/pod/event.h>
|
||||
|
||||
/* object id of SPA_TYPE_EVENT_Node */
|
||||
|
|
@ -41,6 +46,10 @@ enum spa_node_event {
|
|||
#define SPA_NODE_EVENT_ID(ev) SPA_EVENT_ID(ev, SPA_TYPE_EVENT_Node)
|
||||
#define SPA_NODE_EVENT_INIT(id) SPA_EVENT_INIT(SPA_TYPE_EVENT_Node, id)
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -29,6 +29,11 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* \addtogroup spa_node
|
||||
* \{
|
||||
*/
|
||||
|
||||
#include <spa/utils/defs.h>
|
||||
#include <spa/pod/pod.h>
|
||||
|
||||
|
|
@ -288,6 +293,10 @@ struct spa_io_rate_match {
|
|||
uint32_t padding[7];
|
||||
};
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -29,6 +29,11 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* \addtogroup spa_node
|
||||
* \{
|
||||
*/
|
||||
|
||||
/** node keys */
|
||||
#define SPA_KEY_NODE_NAME "node.name" /**< a node name */
|
||||
#define SPA_KEY_NODE_LATENCY "node.latency" /**< the requested node latency */
|
||||
|
|
@ -48,6 +53,10 @@ extern "C" {
|
|||
#define SPA_KEY_PORT_MONITOR "port.monitor" /**< this port is a monitor port */
|
||||
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -29,6 +29,15 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** \defgroup spa_node SPA Nodes
|
||||
* A spa_node is a component that can consume and produce buffers.
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup spa_node
|
||||
* \{
|
||||
*/
|
||||
|
||||
#include <spa/utils/defs.h>
|
||||
#include <spa/utils/type.h>
|
||||
#include <spa/utils/hook.h>
|
||||
|
|
@ -37,9 +46,6 @@ extern "C" {
|
|||
#include <spa/node/command.h>
|
||||
|
||||
|
||||
/**
|
||||
* A spa_node is a component that can consume and produce buffers.
|
||||
*/
|
||||
#define SPA_TYPE_INTERFACE_Node SPA_TYPE_INFO_INTERFACE_BASE "Node"
|
||||
|
||||
#define SPA_VERSION_NODE 0
|
||||
|
|
@ -655,6 +661,10 @@ struct spa_node_methods {
|
|||
#define spa_node_port_reuse_buffer(n,...) spa_node_method(n, port_reuse_buffer, 0, __VA_ARGS__)
|
||||
#define spa_node_process(n) spa_node_method(n, process, 0)
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -29,6 +29,11 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* \addtogroup spa_node
|
||||
* \{
|
||||
*/
|
||||
|
||||
#include <spa/utils/type-info.h>
|
||||
|
||||
#include <spa/node/command.h>
|
||||
|
|
@ -89,6 +94,10 @@ static const struct spa_type_info spa_type_node_command[] = {
|
|||
{ 0, 0, NULL, NULL },
|
||||
};
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -29,6 +29,11 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* \addtogroup spa_node
|
||||
* \{
|
||||
*/
|
||||
|
||||
#include <spa/pod/builder.h>
|
||||
|
||||
#include <spa/node/node.h>
|
||||
|
|
@ -137,6 +142,10 @@ static inline int spa_node_port_enum_params_sync(struct spa_node *node,
|
|||
#define spa_node_call_reuse_buffer(hook,...) spa_node_call(hook, reuse_buffer, 0, __VA_ARGS__)
|
||||
#define spa_node_call_xrun(hook,...) spa_node_call(hook, xrun, 0, __VA_ARGS__)
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue