mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-01 22:58:50 -04:00
doc: reorganize Doxygen groups/modules to make more sense
The Doxygen "Modules" page is not very illuminative, as different parts of the API are mixed together and not all parts are included. Try to address this: Put all parts of the public API to some Doxygen group, usually one group per header file. Use short, systematic names. Make these groups sub-groups of a few top-level groups, roughly corresponding to the different logical parts of the API (core, impl, stream, filter, spa, utilities).
This commit is contained in:
Pauli Virtanen
parent
43a84c4a2c
commit
8159797f89
95 changed files with 588 additions and 154 deletions
|
|
@ -31,7 +31,7 @@ extern "C" {
|
|||
#include <spa/utils/defs.h>
|
||||
#include <spa/buffer/meta.h>
|
||||
|
||||
/** \defgroup spa_buffer SPA Buffers
|
||||
/** \defgroup spa_buffer Buffers
|
||||
*
|
||||
* Buffers describe the data and metadata that is exchanged between
|
||||
* ports of a node.
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ extern "C" {
|
|||
#include <spa/utils/defs.h>
|
||||
#include <spa/pod/pod.h>
|
||||
|
||||
/** \defgroup spa_control SPA Controls
|
||||
/** \defgroup spa_control Control
|
||||
*
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** \defgroup spa_debug SPA Debug
|
||||
/** \defgroup spa_debug Debug
|
||||
*
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** \defgroup spa_graph SPA Graph
|
||||
/** \defgroup spa_graph Graph
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ extern "C" {
|
|||
#include <spa/pod/event.h>
|
||||
|
||||
/**
|
||||
* \defgroup spa_device SPA Device
|
||||
* \defgroup spa_device Device
|
||||
*
|
||||
* The device interface can be used to monitor all kinds of devices
|
||||
* and create objects as a result. Objects a typically other
|
||||
|
|
|
|||
|
|
@ -31,6 +31,11 @@ extern "C" {
|
|||
|
||||
#include <spa/pod/event.h>
|
||||
|
||||
/**
|
||||
* \addtogroup spa_device
|
||||
* \{
|
||||
*/
|
||||
|
||||
/* object id of SPA_TYPE_EVENT_Device */
|
||||
enum spa_device_event {
|
||||
SPA_DEVICE_EVENT_ObjectConfig,
|
||||
|
|
@ -47,6 +52,10 @@ enum spa_event_device {
|
|||
SPA_EVENT_DEVICE_Props, /* properties for an object (SPA_TYPE_OBJECT_Props) */
|
||||
};
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -33,6 +33,11 @@ extern "C" {
|
|||
|
||||
#include <spa/monitor/event.h>
|
||||
|
||||
/**
|
||||
* \addtogroup spa_device
|
||||
* \{
|
||||
*/
|
||||
|
||||
#define SPA_TYPE_INFO_DeviceEvent SPA_TYPE_INFO_EVENT_BASE "Device"
|
||||
#define SPA_TYPE_INFO_DEVICE_EVENT_BASE SPA_TYPE_INFO_DeviceEvent ":"
|
||||
|
||||
|
|
@ -51,6 +56,10 @@ static const struct spa_type_info spa_type_device_event[] = {
|
|||
{ 0, 0, NULL, NULL },
|
||||
};
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -32,6 +32,11 @@ extern "C" {
|
|||
#include <spa/pod/builder.h>
|
||||
#include <spa/monitor/device.h>
|
||||
|
||||
/**
|
||||
* \addtogroup spa_device
|
||||
* \{
|
||||
*/
|
||||
|
||||
struct spa_result_device_params_data {
|
||||
struct spa_pod_builder *builder;
|
||||
struct spa_result_device_params data;
|
||||
|
|
@ -90,6 +95,10 @@ static inline int spa_device_enum_params_sync(struct spa_device *device,
|
|||
#define spa_device_emit_event(hooks,e) spa_device_emit(hooks,event, 0, e)
|
||||
#define spa_device_emit_object_info(hooks,id,i) spa_device_emit(hooks,object_info, 0, id, i)
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -29,7 +29,8 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** \defgroup spa_node SPA Nodes
|
||||
/** \defgroup spa_node Node
|
||||
*
|
||||
* A spa_node is a component that can consume and produce buffers.
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -29,6 +29,10 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* \addtogroup spa_param
|
||||
* \{
|
||||
*/
|
||||
|
||||
#include <spa/pod/builder.h>
|
||||
#include <spa/pod/parser.h>
|
||||
|
|
@ -158,6 +162,10 @@ spa_process_latency_info_add(const struct spa_process_latency_info *process,
|
|||
return 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* \}
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
#endif
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** \defgroup spa_param SPA Parameters
|
||||
/** \defgroup spa_param Parameters
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** \defgroup spa_pod SPA POD
|
||||
/** \defgroup spa_pod POD
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -34,12 +34,12 @@ extern "C" {
|
|||
#include <spa/utils/defs.h>
|
||||
#include <spa/utils/hook.h>
|
||||
|
||||
/** \defgroup spa_support SPA Support Features
|
||||
/** \defgroup spa_cpu CPU
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup spa_support
|
||||
* \addtogroup spa_cpu
|
||||
* \{
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -31,8 +31,12 @@ extern "C" {
|
|||
|
||||
#include <spa/support/loop.h>
|
||||
|
||||
/** \defgroup spa_dbus DBus
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup spa_support
|
||||
* \addtogroup spa_dbus
|
||||
* \{
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -32,8 +32,12 @@ extern "C" {
|
|||
#include <spa/utils/hook.h>
|
||||
#include <spa/utils/defs.h>
|
||||
|
||||
/** \defgroup spa_i18n I18N
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup spa_support
|
||||
* \addtogroup spa_i18n
|
||||
* \{
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ extern "C" {
|
|||
#include <spa/utils/defs.h>
|
||||
#include <spa/utils/hook.h>
|
||||
|
||||
/** \defgroup spa_log SPA Logging
|
||||
/** \defgroup spa_log Log
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -33,8 +33,12 @@ extern "C" {
|
|||
#include <spa/utils/hook.h>
|
||||
#include <spa/support/system.h>
|
||||
|
||||
/** \defgroup spa_loop Loop
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup spa_support
|
||||
* \addtogroup spa_loop
|
||||
* \{
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -32,8 +32,12 @@ extern "C" {
|
|||
#include <spa/utils/hook.h>
|
||||
#include <spa/utils/defs.h>
|
||||
|
||||
/** \defgroup spa_plugin_loader Plugin Loader
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup spa_support
|
||||
* \addtogroup spa_plugin_loader
|
||||
* \{
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -33,7 +33,7 @@ extern "C" {
|
|||
#include <spa/utils/dict.h>
|
||||
|
||||
/**
|
||||
* \defgroup spa_handle SPA Plugin Handles
|
||||
* \defgroup spa_handle Plugin Handle
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -37,8 +37,12 @@ struct itimerspec;
|
|||
#include <spa/utils/defs.h>
|
||||
#include <spa/utils/hook.h>
|
||||
|
||||
/** \defgroup spa_system System
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup spa_support
|
||||
* \addtogroup spa_system
|
||||
* \{
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -36,8 +36,12 @@ extern "C" {
|
|||
#include <spa/utils/hook.h>
|
||||
#include <spa/utils/dict.h>
|
||||
|
||||
/** \defgroup spa_thread Thread
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup spa_support
|
||||
* \addtogroup spa_thread
|
||||
* \{
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -29,11 +29,13 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** \defgroup spa_utils SPA Utils
|
||||
/**
|
||||
* \defgroup spa_ansi ANSI codes
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup spa_utils
|
||||
* \addtogroup spa_ansi
|
||||
* \{
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -37,11 +37,13 @@ extern "C" {
|
|||
#include <stddef.h>
|
||||
#include <stdio.h>
|
||||
|
||||
/** \defgroup spa_utils SPA Utils
|
||||
/**
|
||||
* \defgroup spa_utils_defs Miscellaneous
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup spa_utils
|
||||
* \addtogroup spa_utils_defs
|
||||
* \{
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -34,7 +34,12 @@ extern "C" {
|
|||
#include <spa/utils/defs.h>
|
||||
|
||||
/**
|
||||
* \addtogroup spa_utils
|
||||
* \defgroup spa_dict Dictionary
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup spa_dict
|
||||
* \{
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -32,7 +32,7 @@ extern "C" {
|
|||
#include <spa/utils/defs.h>
|
||||
#include <spa/utils/list.h>
|
||||
|
||||
/** \defgroup spa_interfaces SPA Interfaces
|
||||
/** \defgroup spa_interfaces Interfaces
|
||||
*
|
||||
* \brief Generic implementation of implementation-independent interfaces
|
||||
*
|
||||
|
|
@ -230,7 +230,7 @@ struct spa_interface {
|
|||
* \}
|
||||
*/
|
||||
|
||||
/** \defgroup spa_hooks SPA Hooks
|
||||
/** \defgroup spa_hooks Hooks
|
||||
*
|
||||
* A SPA Hook is a data structure to keep track of callbacks. It is similar to
|
||||
* the \ref spa_interfaces and typically used where an implementation allows
|
||||
|
|
|
|||
|
|
@ -37,7 +37,7 @@ extern "C" {
|
|||
|
||||
#include <spa/utils/defs.h>
|
||||
|
||||
/** \defgroup spa_json SPA JSON Parser
|
||||
/** \defgroup spa_json JSON
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** \defgroup spa_keys SPA Key Names
|
||||
/** \defgroup spa_keys Key Names
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -30,7 +30,12 @@ extern "C" {
|
|||
#endif
|
||||
|
||||
/**
|
||||
* \addtogroup spa_utils
|
||||
* \defgroup spa_list List
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup spa_list List
|
||||
* \{
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@
|
|||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** \defgroup spa_names SPA Factory Names
|
||||
/** \defgroup spa_names Factory Names
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
|
|
@ -30,7 +30,12 @@ extern "C" {
|
|||
#endif
|
||||
|
||||
/**
|
||||
* \addtogroup spa_utils
|
||||
* \defgroup spa_result Result handling
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup spa_result
|
||||
* \{
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -30,7 +30,12 @@ extern "C" {
|
|||
#endif
|
||||
|
||||
/**
|
||||
* \addtogroup spa_utils
|
||||
* \defgroup spa_ringbuffer Ringbuffer
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup spa_ringbuffer
|
||||
* \{
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -36,7 +36,12 @@ extern "C" {
|
|||
#include <spa/utils/defs.h>
|
||||
|
||||
/**
|
||||
* \addtogroup spa_utils
|
||||
* \defgroup spa_string String handling
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* \addtogroup spa_string
|
||||
* \{
|
||||
*/
|
||||
|
||||
|
|
@ -45,7 +50,6 @@ extern "C" {
|
|||
*
|
||||
* If both \a a and \a b are NULL, the two are considered equal.
|
||||
*
|
||||
* \ingroup spa
|
||||
*/
|
||||
static inline bool spa_streq(const char *s1, const char *s2)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -31,7 +31,7 @@ extern "C" {
|
|||
|
||||
#include <spa/utils/defs.h>
|
||||
|
||||
/** \defgroup spa_types SPA Types
|
||||
/** \defgroup spa_types Types
|
||||
*/
|
||||
|
||||
/**
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue